gtk2/gtk/gtkactiongroup.h

180 lines
7.9 KiB
C
Raw Normal View History

/*
* GTK - The GIMP Toolkit
* Copyright (C) 1998, 1999 Red Hat, Inc.
* All rights reserved.
*
* This Library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This Library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with the Gnome Library; see the file COPYING.LIB. If not,
* write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/*
* Author: James Henstridge <james@daa.com.au>
*
* Modified by the GTK+ Team and others 2003. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#ifndef __GTK_ACTION_GROUP_H__
#define __GTK_ACTION_GROUP_H__
#include <gtk/gtkaction.h>
#include <gtk/gtkitemfactory.h> /* for GtkTranslateFunc */
G_BEGIN_DECLS
#define GTK_TYPE_ACTION_GROUP (gtk_action_group_get_type ())
#define GTK_ACTION_GROUP(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ACTION_GROUP, GtkActionGroup))
#define GTK_ACTION_GROUP_CLASS(vtable) (G_TYPE_CHECK_CLASS_CAST ((vtable), GTK_TYPE_ACTION_GROUP, GtkActionGroupClass))
#define GTK_IS_ACTION_GROUP(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ACTION_GROUP))
#define GTK_IS_ACTION_GROUP_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), GTK_TYPE_ACTION_GROUP))
#define GTK_ACTION_GROUP_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), GTK_TYPE_ACTION_GROUP, GtkActionGroupClass))
typedef struct _GtkActionGroup GtkActionGroup;
typedef struct _GtkActionGroupPrivate GtkActionGroupPrivate;
typedef struct _GtkActionGroupClass GtkActionGroupClass;
Change the XML format: <Root> element is replaced by <ui>, <menu> element 2003-08-28 Matthias Clasen <maclas@gmx.de> * gtk/gtkuimanager.c: Change the XML format: <Root> element is replaced by <ui>, <menu> element is replaced by <menubar>, <submenu> element is replaced by <menu>, <dockitem> element is replaced by <toolbar>, <popups> element is gone, verb attribute is replaced by action, name defaults to action or the element name. * gtk/gtkactiongroup.[hc]: Replace GtkActionGroupEntry by GtkActionEntry and GtkRadioActionEntry. GtkActionEntry is simplified by removing the user_data, entry_type and extra_data fields, GtkRadioActionEntry is further simplified by removing the callback. The user_data can now be specified as an argument to gtk_action_group_add_actions(). There is a new method gtk_action_group_add_radio_actions(), which is similar to gtk_action_group_add_actions(), but takes GtkRadioActionEntrys and a callback parameter in addition to the user_data. The callback is connected to the ::changed signal of the first group member. There are _full() variants taking a GDestroyNotify of gtk_action_group_add_[radio_]actions(). * gtk/gtkradioaction.[hc]: Add a ::changed signal which gets emitted on every member of the radio group when the active member is changed. Add an integer property "value", and a getter for the value of "value" on the currently active group member. * tests/testactions.c: * tests/testmerge.c: * tests/merge-[123].ui: * demos/gtk-demo/appwindow.c: Adjust to these changes. * gtk/gtktoolbar.c (gtk_toolbar_append_element): Trivial doc fix.
2003-08-27 22:22:28 +00:00
typedef struct _GtkActionEntry GtkActionEntry;
typedef struct _GtkToggleActionEntry GtkToggleActionEntry;
Change the XML format: <Root> element is replaced by <ui>, <menu> element 2003-08-28 Matthias Clasen <maclas@gmx.de> * gtk/gtkuimanager.c: Change the XML format: <Root> element is replaced by <ui>, <menu> element is replaced by <menubar>, <submenu> element is replaced by <menu>, <dockitem> element is replaced by <toolbar>, <popups> element is gone, verb attribute is replaced by action, name defaults to action or the element name. * gtk/gtkactiongroup.[hc]: Replace GtkActionGroupEntry by GtkActionEntry and GtkRadioActionEntry. GtkActionEntry is simplified by removing the user_data, entry_type and extra_data fields, GtkRadioActionEntry is further simplified by removing the callback. The user_data can now be specified as an argument to gtk_action_group_add_actions(). There is a new method gtk_action_group_add_radio_actions(), which is similar to gtk_action_group_add_actions(), but takes GtkRadioActionEntrys and a callback parameter in addition to the user_data. The callback is connected to the ::changed signal of the first group member. There are _full() variants taking a GDestroyNotify of gtk_action_group_add_[radio_]actions(). * gtk/gtkradioaction.[hc]: Add a ::changed signal which gets emitted on every member of the radio group when the active member is changed. Add an integer property "value", and a getter for the value of "value" on the currently active group member. * tests/testactions.c: * tests/testmerge.c: * tests/merge-[123].ui: * demos/gtk-demo/appwindow.c: Adjust to these changes. * gtk/gtktoolbar.c (gtk_toolbar_append_element): Trivial doc fix.
2003-08-27 22:22:28 +00:00
typedef struct _GtkRadioActionEntry GtkRadioActionEntry;
struct _GtkActionGroup
{
GObject parent;
/*< private >*/
GtkActionGroupPrivate *private_data;
};
struct _GtkActionGroupClass
{
GObjectClass parent_class;
GtkAction *(* get_action) (GtkActionGroup *action_group,
Adjust to the new connect_proxy signals. Mon Jan 12 23:40:34 2004 Matthias Clasen <maclas@gmx.de> * tests/testmerge.c: Adjust to the new connect_proxy signals. * gtk/gtkuimanager.c * gtk/gtkactiongroup.c * gtk/gtkaction.c: Move the connect_proxy and disconnect_proxy signals from GtkAction to GtkActionGroup and proxy it on GtkUIManager. This removes the confusion between the disconnect_/connect_proxy signals and the (unrelated) virtual functions of the same name and aligns the setup with the pre_/post_activate signals. 2004-01-12 Jody Goldberg <jody@gnome.org> * gtk/gtkaction.c (connect_proxy) : only connect activate for menus with no submenus otherwise it looks like we activate every time a submenu opens. 2004-01-10 Jody Goldberg <jody@gnome.org> * gtk/gtkuimanager.c (d) : Add a debug macro to quiet the spew. s/merge_signals/ui_manager_signals/ for readability. (gtk_ui_manager_class_init) : add pre_activate and post_activate signals. (cb_proxy_pre_activate) : new. (cb_proxy_post_activate) : new. (gtk_ui_manager_insert_action_group) : connect the proxies for GtkActionGroup::pre/post_activate (gtk_ui_manager_remove_action_group) : disconnect them. * gtk/gtkactiongroup.c (gtk_action_group_class_init) : add 'sensitive', and 'visible' properties. Also add pre_activate and post_activate signals to help deal with activations at a higher level (eg GtkUIManager) (gtk_action_group_init) : init sensitive and visible (gtk_action_group_set_property) : add sensitive and visible (gtk_action_group_get_property) : add sensitive and visible (gtk_action_group_get_sensitive) : new. (gtk_action_group_get_visible) : new. (cb_set_action_sensitivity) : new with minor optimization that only signals sensitivity changes if the action could possibly change. (cb_set_action_visiblility) : ditto. (gtk_action_group_set_sensitive) : new. walk the actions directly rather than using notify::sensitive because that is simpler, easier to read, and more efficient. (gtk_action_group_set_visible) : ditto. (gtk_action_group_add_action) : Each action can only be in 1 group, set GtkAction::action_group. (gtk_action_group_remove_action) : clear it. (gtk_action_group_add_toggle_actions_full) : warning suppression. (gtk_action_group_add_radio_actions_full) : warning suppression. (_gtk_action_group_emit_pre_activate) : new protected routine for use by GtkAction. (_gtk_action_group_emit_post_activate) : ditto. * gtk/gtkaction.c (gtk_action_class_init) : add 'action_group' property. (gtk_action_init) : initialize it. (gtk_action_get_property) : get. (gtk_action_set_property) : set it via (gtk_action_set_action_group) : new function. (gtk_action_sync_sensitivity) : new routine to sync proxy sensitivity with the logical sensitivity (action & group) rather than the simple action::sensitivity. (gtk_action_sync_visible) : use gtk_action_is_visible to handle logical visibility (action & group) rather than the simple action::visible. Use widget show/hide directly. (connect_proxy) : handle the custom sensitivity handler. Make the TOOL_BUTTON signals more general and support TOOL_ITEM directly, with special cases for TOOL_BUTTON. Still not especially good it might be useful to handle label/use_underline by parmspec lookup. Those are likely to be implemented by custom types, and are assumed to exist in GtkToolItem. (disconnect_proxy) : disconnect the new sensitivity handler. (_gtk_action_emit_activate) : add pre/post signals. (gtk_action_activate) : use logical sensitivity. (gtk_action_is_sensitive) : logical sensitivity. (gtk_action_get_sensitive) : actual sensitivity. (closure_accel_activate) : use logical sensitivity.
2004-01-12 22:45:45 +00:00
const gchar *action_name);
/* Padding for future expansion */
void (*_gtk_reserved1) (void);
void (*_gtk_reserved2) (void);
void (*_gtk_reserved3) (void);
void (*_gtk_reserved4) (void);
};
Change the XML format: <Root> element is replaced by <ui>, <menu> element 2003-08-28 Matthias Clasen <maclas@gmx.de> * gtk/gtkuimanager.c: Change the XML format: <Root> element is replaced by <ui>, <menu> element is replaced by <menubar>, <submenu> element is replaced by <menu>, <dockitem> element is replaced by <toolbar>, <popups> element is gone, verb attribute is replaced by action, name defaults to action or the element name. * gtk/gtkactiongroup.[hc]: Replace GtkActionGroupEntry by GtkActionEntry and GtkRadioActionEntry. GtkActionEntry is simplified by removing the user_data, entry_type and extra_data fields, GtkRadioActionEntry is further simplified by removing the callback. The user_data can now be specified as an argument to gtk_action_group_add_actions(). There is a new method gtk_action_group_add_radio_actions(), which is similar to gtk_action_group_add_actions(), but takes GtkRadioActionEntrys and a callback parameter in addition to the user_data. The callback is connected to the ::changed signal of the first group member. There are _full() variants taking a GDestroyNotify of gtk_action_group_add_[radio_]actions(). * gtk/gtkradioaction.[hc]: Add a ::changed signal which gets emitted on every member of the radio group when the active member is changed. Add an integer property "value", and a getter for the value of "value" on the currently active group member. * tests/testactions.c: * tests/testmerge.c: * tests/merge-[123].ui: * demos/gtk-demo/appwindow.c: Adjust to these changes. * gtk/gtktoolbar.c (gtk_toolbar_append_element): Trivial doc fix.
2003-08-27 22:22:28 +00:00
struct _GtkActionEntry
{
const gchar *name;
const gchar *stock_id;
const gchar *label;
const gchar *accelerator;
const gchar *tooltip;
GCallback callback;
};
struct _GtkToggleActionEntry
{
const gchar *name;
const gchar *stock_id;
const gchar *label;
const gchar *accelerator;
const gchar *tooltip;
GCallback callback;
gboolean is_active;
Change the XML format: <Root> element is replaced by <ui>, <menu> element 2003-08-28 Matthias Clasen <maclas@gmx.de> * gtk/gtkuimanager.c: Change the XML format: <Root> element is replaced by <ui>, <menu> element is replaced by <menubar>, <submenu> element is replaced by <menu>, <dockitem> element is replaced by <toolbar>, <popups> element is gone, verb attribute is replaced by action, name defaults to action or the element name. * gtk/gtkactiongroup.[hc]: Replace GtkActionGroupEntry by GtkActionEntry and GtkRadioActionEntry. GtkActionEntry is simplified by removing the user_data, entry_type and extra_data fields, GtkRadioActionEntry is further simplified by removing the callback. The user_data can now be specified as an argument to gtk_action_group_add_actions(). There is a new method gtk_action_group_add_radio_actions(), which is similar to gtk_action_group_add_actions(), but takes GtkRadioActionEntrys and a callback parameter in addition to the user_data. The callback is connected to the ::changed signal of the first group member. There are _full() variants taking a GDestroyNotify of gtk_action_group_add_[radio_]actions(). * gtk/gtkradioaction.[hc]: Add a ::changed signal which gets emitted on every member of the radio group when the active member is changed. Add an integer property "value", and a getter for the value of "value" on the currently active group member. * tests/testactions.c: * tests/testmerge.c: * tests/merge-[123].ui: * demos/gtk-demo/appwindow.c: Adjust to these changes. * gtk/gtktoolbar.c (gtk_toolbar_append_element): Trivial doc fix.
2003-08-27 22:22:28 +00:00
};
struct _GtkRadioActionEntry
{
const gchar *name;
const gchar *stock_id;
const gchar *label;
const gchar *accelerator;
const gchar *tooltip;
gint value;
};
Mark as const. 2004-11-23 Matthias Clasen <mclasen@redhat.com> * gtk/gtkuimanager.h (gtk_ui_manager_get_type): * gtk/gtktreeview.h (gtk_tree_view_get_type): * gtk/gtktreeviewcolumn.h (gtk_tree_view_column_get_type): * gtk/gtktreestore.h (gtk_tree_store_get_type): * gtk/gtktreeselection.h (gtk_tree_selection_get_type): * gtk/gtktreemodelfilter.h (gtk_tree_model_filter_get_type): * gtk/gtktreemodel.h (gtk_tree_iter_get_type): (gtk_tree_path_get_type): (gtk_tree_row_reference_get_type): * gtk/gtktoolitem.h (gtk_tool_item_get_type): * gtk/gtktoolbutton.h (gtk_tool_button_get_type): * gtk/gtktoggleaction.h (gtk_toggle_action_get_type): * gtk/gtkthemes.h (gtk_theme_engine_get_type): * gtk/gtktextiter.h (gtk_text_iter_get_type): * gtk/gtksettings.h (gtk_settings_get_type): * gtk/gtkselection.h (gtk_selection_data_get_type): * gtk/gtkradioaction.h (gtk_radio_action_get_type): * gtk/gtkmenutoolbutton.h (gtk_menu_tool_button_get_type): * gtk/gtkliststore.h (gtk_list_store_get_type): * gtk/gtkiconview.h (gtk_icon_view_get_type): * gtk/gtkicontheme.h (gtk_icon_info_get_type): * gtk/gtkiconfactory.h (gtk_icon_factory_get_type): (gtk_icon_set_get_type): (gtk_icon_source_get_type): * gtk/gtkfilesystemwin32.h (gtk_file_system_win32_get_type): * gtk/gtkfilesystemunix.h (gtk_file_system_unix_get_type): * gtk/gtkfilesystem.h (gtk_file_folder_get_type): (gtk_file_info_get_type, gtk_file_path_get_type): (gtk_file_system_get_type): * gtk/gtkfilefilter.h (gtk_file_filter_get_type): * gtk/gtkfilechooserwidget.h (gtk_file_chooser_widget_get_type): * gtk/gtkfilechooser.h (gtk_file_chooser_get_type): * gtk/gtkfilechooserdialog.h (gtk_file_chooser_dialog_get_type): * gtk/gtkexpander.h (gtk_expander_get_type): * gtk/gtkentrycompletion.h (gtk_entry_completion_get_type): * gtk/gtkcombobox.h (gtk_combo_box_get_type): * gtk/gtkcomboboxentry.h (gtk_combo_box_entry_get_type): * gtk/gtkclipboard.h (gtk_clipboard_get_type): * gtk/gtkcellview.h (gtk_cell_view_get_type): * gtk/gtkcellrenderertoggle.h (gtk_cell_renderer_toggle_get_type): * gtk/gtkcellrenderertext.h (gtk_cell_renderer_text_get_type): * gtk/gtkcellrendererprogress.h (gtk_cell_renderer_progress_get_type): * gtk/gtkcellrendererpixbuf.h (gtk_cell_renderer_pixbuf_get_type): * gtk/gtkcellrenderercombo.h (gtk_cell_renderer_combo_get_type): * gtk/gtkcelllayout.h (gtk_cell_layout_get_type): * gtk/gtkactiongroup.h (gtk_action_group_get_type): * gtk/gtkaction.h (gtk_action_get_type): * gtk/gtkaccessible.h (gtk_accessible_get_type): * gtk/gtkaccelmap.h (gtk_accel_map_get_type): * gtk/gtkaccelgroup.h (gtk_accel_group_get_type): * gtk/gtkmessagedialog.h (gtk_message_dialog_get_type): Mark as const. * gtk/gtkicontheme.h: Don't mark gtk_icon_theme_error_quark() as const, to be consistent with all the other error_quark functions. (technically they are const, but since these are called only in error paths, giving the compiler better optimization opportunities doesn't matter much) * gtk/gtk.symbols: * gdk/gdk.symbols: Add attribute annotations. * gtk/makegtkalias.pl: * gdk/makegdkalias.pl: Keep attribute annotations, but strip PRIVATE. * gtk/Makefile.am (gtk.def): * gdk/Makefile.am (gdk.def): Strip attribute annotations, but keep PRIVATE.
2004-11-23 20:02:15 +00:00
GType gtk_action_group_get_type (void) G_GNUC_CONST;
GtkActionGroup *gtk_action_group_new (const gchar *name);
G_CONST_RETURN gchar *gtk_action_group_get_name (GtkActionGroup *action_group);
gboolean gtk_action_group_get_sensitive (GtkActionGroup *action_group);
void gtk_action_group_set_sensitive (GtkActionGroup *action_group,
gboolean sensitive);
gboolean gtk_action_group_get_visible (GtkActionGroup *action_group);
void gtk_action_group_set_visible (GtkActionGroup *action_group,
gboolean visible);
GtkAction *gtk_action_group_get_action (GtkActionGroup *action_group,
const gchar *action_name);
GList *gtk_action_group_list_actions (GtkActionGroup *action_group);
void gtk_action_group_add_action (GtkActionGroup *action_group,
GtkAction *action);
void gtk_action_group_add_action_with_accel (GtkActionGroup *action_group,
GtkAction *action,
const gchar *accelerator);
void gtk_action_group_remove_action (GtkActionGroup *action_group,
GtkAction *action);
void gtk_action_group_add_actions (GtkActionGroup *action_group,
const GtkActionEntry *entries,
guint n_entries,
gpointer user_data);
void gtk_action_group_add_toggle_actions (GtkActionGroup *action_group,
const GtkToggleActionEntry *entries,
guint n_entries,
gpointer user_data);
void gtk_action_group_add_radio_actions (GtkActionGroup *action_group,
const GtkRadioActionEntry *entries,
guint n_entries,
gint value,
GCallback on_change,
gpointer user_data);
void gtk_action_group_add_actions_full (GtkActionGroup *action_group,
const GtkActionEntry *entries,
guint n_entries,
gpointer user_data,
GDestroyNotify destroy);
void gtk_action_group_add_toggle_actions_full (GtkActionGroup *action_group,
const GtkToggleActionEntry *entries,
guint n_entries,
gpointer user_data,
GDestroyNotify destroy);
void gtk_action_group_add_radio_actions_full (GtkActionGroup *action_group,
const GtkRadioActionEntry *entries,
guint n_entries,
gint value,
GCallback on_change,
gpointer user_data,
GDestroyNotify destroy);
void gtk_action_group_set_translate_func (GtkActionGroup *action_group,
GtkTranslateFunc func,
gpointer data,
GtkDestroyNotify notify);
void gtk_action_group_set_translation_domain (GtkActionGroup *action_group,
const gchar *domain);
G_CONST_RETURN gchar *gtk_action_group_translate_string (GtkActionGroup *action_group,
const gchar *string);
Adjust to the new connect_proxy signals. Mon Jan 12 23:40:34 2004 Matthias Clasen <maclas@gmx.de> * tests/testmerge.c: Adjust to the new connect_proxy signals. * gtk/gtkuimanager.c * gtk/gtkactiongroup.c * gtk/gtkaction.c: Move the connect_proxy and disconnect_proxy signals from GtkAction to GtkActionGroup and proxy it on GtkUIManager. This removes the confusion between the disconnect_/connect_proxy signals and the (unrelated) virtual functions of the same name and aligns the setup with the pre_/post_activate signals. 2004-01-12 Jody Goldberg <jody@gnome.org> * gtk/gtkaction.c (connect_proxy) : only connect activate for menus with no submenus otherwise it looks like we activate every time a submenu opens. 2004-01-10 Jody Goldberg <jody@gnome.org> * gtk/gtkuimanager.c (d) : Add a debug macro to quiet the spew. s/merge_signals/ui_manager_signals/ for readability. (gtk_ui_manager_class_init) : add pre_activate and post_activate signals. (cb_proxy_pre_activate) : new. (cb_proxy_post_activate) : new. (gtk_ui_manager_insert_action_group) : connect the proxies for GtkActionGroup::pre/post_activate (gtk_ui_manager_remove_action_group) : disconnect them. * gtk/gtkactiongroup.c (gtk_action_group_class_init) : add 'sensitive', and 'visible' properties. Also add pre_activate and post_activate signals to help deal with activations at a higher level (eg GtkUIManager) (gtk_action_group_init) : init sensitive and visible (gtk_action_group_set_property) : add sensitive and visible (gtk_action_group_get_property) : add sensitive and visible (gtk_action_group_get_sensitive) : new. (gtk_action_group_get_visible) : new. (cb_set_action_sensitivity) : new with minor optimization that only signals sensitivity changes if the action could possibly change. (cb_set_action_visiblility) : ditto. (gtk_action_group_set_sensitive) : new. walk the actions directly rather than using notify::sensitive because that is simpler, easier to read, and more efficient. (gtk_action_group_set_visible) : ditto. (gtk_action_group_add_action) : Each action can only be in 1 group, set GtkAction::action_group. (gtk_action_group_remove_action) : clear it. (gtk_action_group_add_toggle_actions_full) : warning suppression. (gtk_action_group_add_radio_actions_full) : warning suppression. (_gtk_action_group_emit_pre_activate) : new protected routine for use by GtkAction. (_gtk_action_group_emit_post_activate) : ditto. * gtk/gtkaction.c (gtk_action_class_init) : add 'action_group' property. (gtk_action_init) : initialize it. (gtk_action_get_property) : get. (gtk_action_set_property) : set it via (gtk_action_set_action_group) : new function. (gtk_action_sync_sensitivity) : new routine to sync proxy sensitivity with the logical sensitivity (action & group) rather than the simple action::sensitivity. (gtk_action_sync_visible) : use gtk_action_is_visible to handle logical visibility (action & group) rather than the simple action::visible. Use widget show/hide directly. (connect_proxy) : handle the custom sensitivity handler. Make the TOOL_BUTTON signals more general and support TOOL_ITEM directly, with special cases for TOOL_BUTTON. Still not especially good it might be useful to handle label/use_underline by parmspec lookup. Those are likely to be implemented by custom types, and are assumed to exist in GtkToolItem. (disconnect_proxy) : disconnect the new sensitivity handler. (_gtk_action_emit_activate) : add pre/post signals. (gtk_action_activate) : use logical sensitivity. (gtk_action_is_sensitive) : logical sensitivity. (gtk_action_get_sensitive) : actual sensitivity. (closure_accel_activate) : use logical sensitivity.
2004-01-12 22:45:45 +00:00
/* Protected for use by GtkAction */
void _gtk_action_group_emit_connect_proxy (GtkActionGroup *action_group,
GtkAction *action,
GtkWidget *proxy);
void _gtk_action_group_emit_disconnect_proxy (GtkActionGroup *action_group,
GtkAction *action,
GtkWidget *proxy);
void _gtk_action_group_emit_pre_activate (GtkActionGroup *action_group,
GtkAction *action);
void _gtk_action_group_emit_post_activate (GtkActionGroup *action_group,
GtkAction *action);
G_END_DECLS
#endif /* __GTK_ACTION_GROUP_H__ */