summaryrefslogtreecommitdiffstats
path: root/src/actions/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/actions/README')
-rw-r--r--src/actions/README25
1 files changed, 25 insertions, 0 deletions
diff --git a/src/actions/README b/src/actions/README
new file mode 100644
index 0000000..ec2ce4a
--- /dev/null
+++ b/src/actions/README
@@ -0,0 +1,25 @@
+This directory contains Gio::Actions.
+
+"A GAction (Gio::Action) is a representation of a single
+user-interesting action in an application."
+(https://wiki.gnome.org/HowDoI/GAction)
+
+In more layman terms, it provides a uniform interface for calling
+functions with an optional single parameter that is not tied to the
+GUI.
+
+Actions provide two operations:
+
+* activation (which results in calling the function),
+* state change (if the action supports a state).
+
+While actions are defined independent of the GUI (unlike GtkAction),
+they can be used by "actionable widgets" (menus, buttons, etc.) by
+simply referring to them by name. They can also be remotely activated
+by D-Bus and GNotifications.
+
+To do:
+
+* Convert 'verbs' to Gio::Actions.
+* Update command line to use actions.
+* Update GUI to use actions.