glib/docs/reference/gio
Ryan Lortie 5ff65d8695 Make 4 incompatible changes to the GAction API
This commit represents an API break to GAction in the following ways:

  - the 'set_state' entry in the GActionInterface vtable has been
    renamed to 'change_state'.  The number and order of vtable items has
    not otherwise changed.

  - g_action_set_state() has been renamed to g_action_change_state() to
    match the updated vtable entry.

  - the "state" property of the GAction interface has been changed to
    read-only to reflect the fact that g_action_set_state() no longer
    exists.

  - GSimpleActionClass has been hidden.  GSimpleAction can no longer be
    subclassed.

>> Rationale

g_action_set_state() has never been a true setter in the sense that
calling it will update the value of the "state" property.  It has always
been closer to "request 'state' to be changed to this value" with
semantics defined by the implementor of the interface.  This is why the
equivalent method in GActionGroup had its name changed from 'set' to
'change'.  This change makes the two interfaces more consistent and
removes any implication about the effect that calling set_state() should
have on the 'state' property.

>> Impact

This incompatible API break was undertaken only because I strongly
suspect that it will go entirely unnoticed.  If the break actually
affects anybody, then we will accommodate them (possibly going as far as
to revert this commit entirely).

The virtual table change only impacts implementors of GAction.  I
strongly suspect that this is nobody (except for GSimpleAction).

The hiding of GSimpleActionClass only impacts impacts subclasses of
GSimpleAction.  I strongly suspect that none of these exist.

The changing of the property to be read-only only affects people who
were trying to change the state by using GObject properties.  I strongly
suspect that this is nobody at all.

The removal of the g_action_set_state() call is the most dangerous, but
I still suspect that it will impact nobody outside of GLib.  If anybody
is impacted by this change then, at their request, I will reintroduce
the API as a deprecated alias for g_action_change_state().
2011-06-29 11:38:21 +01:00
..
gdbus-object-manager-example Move gdbus-codegen example code and docs into separate directories 2011-06-03 14:18:56 -04:00
.gitignore .gitignore updates for gsettings stuff 2010-04-27 17:04:57 -04:00
gdbus-codegen.xml gdbus-codegen: Fix up example to not use non-existant method 2011-05-24 07:34:30 -04:00
gdbus.xml gdbus: Add --recurse and --only-properties options 2011-06-09 13:22:18 -04:00
gio-docs.xml GDBus: Use Skeleton instead of Stub 2011-04-13 16:33:51 -04:00
gio-querymodules.xml Add a man page for gio-querymodules 2010-04-18 15:54:54 -04:00
gio-sections.txt Make 4 incompatible changes to the GAction API 2011-06-29 11:38:21 +01:00
gio.types Fix docs for D-Bus introspection data structures 2011-06-03 14:39:04 -04:00
glib-compile-schemas.xml Document which files glib-compile-schemas looks at 2011-03-15 11:30:38 -04:00
gsettings.xml gsettings-tool fixes: Add missing _apply(), add unset-recursively to man page 2011-04-12 12:56:33 -04:00
gvfs-overview.odg update the overview image of the gio docs 2009-06-08 17:29:22 +02:00
gvfs-overview.png update the overview image of the gio docs 2009-06-08 17:29:22 +02:00
Makefile.am build: fix gtk-doc when srcdir != builddir 2011-06-23 12:52:13 -04:00
migrating-gconf.xml Fix links in gio docs 2011-06-04 18:48:19 -04:00
migrating-gdbus.xml Fix typos in "Migrating to GDBus" docs 2011-06-04 11:52:59 -04:00
migrating-gnome-vfs.xml Add a migration chapter for dbus bits 2010-05-06 17:58:29 -04:00
migrating-posix.xml Remove duplicate copies of migration docs 2010-05-27 13:07:54 -04:00
overview.xml Document the GIO_USE_TLS environment variable 2010-12-13 09:19:35 -05:00
version.xml.in gio/ docs/reference/gio Merged gio-standalone into glib. 2007-11-26 16:13:05 +00:00