After careful consideration, I believe it is most prudent to only
introduce a defcustom variable. This will allow for modification while
simultaneously preserving the current behavior.
Currently we can change the value of "org-columns-checkbox" with the
following keybindings:
(1) C-c C-c (org-columns-toggle-or-columns-quit)
Same behavior to toggle checkbox as 'C-c C-c (org-toggle-checkbox)' on
"org-checkbox".
It's a great idea that keybinding works in the same way as in the
case of a regular checkbox. This provides a consistent interface
for the "org-checkbox" and "org-columns-checkbox".
So every user who starts using "org-columns" will try to use the same
keybinding they used for "org-checkbox". That's how I used it too.
But I would not implement other keybindings from "org-checkbox":
C-u C-c C-c (org-toggle-checkbox) - add or remove checkboxes.
C-u C-u C-c C-c (org-toggle-checkbox) - set the checkbox to "[-]".
Because there are too complicated and uncomfortable.
And this functionality can be easily replaced by adding defcustom
variable and using keybinding describe in point (3) of this mail.
(2) n or S-RIGHT (org-columns-next-allowed-value)
p or S-LEFT (org-columns-previous-allowed-value)
Later on, I started using S-RIGHT & S-LEFT. It's simply more
convenient than 'C-c C-c' because in "org-columns" we navigate
with arrow keys. So, the right hand is always on the arrow keys, making
it easier now to press just one SHIFT key with the left hand to
change the value.
When we have the default two states "[X]" and "[ ]", behavior is
same as 'C-c C-c' - toggle within these two states.
But if we add the third state "[-]", it might not be
well-received by users who use these keybindings, because now they
would have to additionally cycle between those three states, not
just two. And unfortunately, they wouldn't be able to change
it. That's why I believe it's worth introducing a defcustom
variable.
(3) 1..9,0
"Directly select the Nth allowed value, 0 selects the 10th
value."
Now that's how I change the values in the "org-columns-checkbox".
Because it's by far the fastest, simplest, and most convenient
way. Only one key and I immediately have the state I want.
Right now I'm using 4 states for "org-columns-checkbox":
(setq org-columns-checkbox-states '("[X]" "[-]" "[ ]" "" ))
So empty state "" at digit '4' I have option to remove checkbox.
Digit '2' is "[-]".
Super easy and convenient in comparison to:
C-u C-c C-c (org-toggle-checkbox) - add or remove checkboxes.
C-u C-u C-c C-c (org-toggle-checkbox) - set the checkbox to
"[-]".
What do you think?
Patch in attachment.
>From 6f8e56cb3d20977e0f4c77c1be913dfb61480cfc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C5=82awomir=20Grochowski?= <[email protected]>
Date: Sat, 16 Mar 2024 13:29:53 +0100
Subject: [PATCH] lisp/org-colview.el: Add defcustom
`org-columns-checkbox-states'
* lisp/org-colview.el Add defcustom `org-columns-checkbox-states'.
(org-columns-next-allowed-value): Introduce variable `org-columns-checkbox-states'.
This would allow to use more than two states ("[ ]", "[X]") in "org-columns-checkbox".
In e.g to add an intermediate state ("[-]") which is also present in "org-checkbox".
* etc/ORG-NEWS New option ~org-columns-checkbox-states~
---
etc/ORG-NEWS | 5 +++++
lisp/org-colview.el | 7 ++++++-
2 files changed, 11 insertions(+), 1 deletion(-)
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index ca73f06e7..1cb4b0c8e 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -1753,6 +1753,11 @@ following properties: ~:hook~, ~:prepare-finalize~,
prior to their global counterparts for the selected template.
** New options
+*** New option ~org-columns-checkbox-states~
+
+This would allow to use more than two states ("[ ]", "[X]") in "org-columns-checkbox".
+In e.g to add an intermediate state ("[-]") which is also present in "org-checkbox".
+
*** A new option for custom setting ~org-refile-use-outline-path~ to show document title in refile targets
Setting ~org-refile-use-outline-path~ to ~'title~ will show title
diff --git a/lisp/org-colview.el b/lisp/org-colview.el
index d71c84a76..eac85d3d6 100644
--- a/lisp/org-colview.el
+++ b/lisp/org-colview.el
@@ -59,6 +59,11 @@
;;; Configuration
+(defcustom org-columns-checkbox-states '("[ ]" "[X]")
+ "Checkbox states to cycle between."
+ :group 'checkbox
+ :type '(repeat string))
+
(defcustom org-columns-modify-value-for-display-function nil
"Function that modifies values for display in column view.
For example, it can be used to cut out a certain part from a time stamp.
@@ -737,7 +742,7 @@ an integer, select that value."
(let ((all
(or (org-property-get-allowed-values pom key)
(pcase (nth column org-columns-current-fmt-compiled)
- (`(,_ ,_ ,_ ,(or "X" "X/" "X%") ,_) '("[ ]" "[X]")))
+ (`(,_ ,_ ,_ ,(or "X" "X/" "X%") ,_) org-columns-checkbox-states))
(org-colview-construct-allowed-dates value))))
(if previous (reverse all) all))))
(when (equal key "ITEM") (error "Cannot edit item headline from here"))
--
2.30.2
Regards,
--
Slawomir Grochowski
