Pileus Git - ~andy/gtk/blob - gtk/gtkaction.h

   1 /*
   2  * GTK - The GIMP Toolkit
   3  * Copyright (C) 1998, 1999 Red Hat, Inc.
   4  * All rights reserved.
   5  *
   6  * This Library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This Library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with the Gnome Library; see the file COPYING.LIB.  If not,
  18  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 /*
  23  * Author: James Henstridge <james@daa.com.au>
  24  *
  25  * Modified by the GTK+ Team and others 2003.  See the AUTHORS
  26  * file for a list of people on the GTK+ Team.  See the ChangeLog
  27  * files for a list of changes.  These files are distributed with
  28  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  29  */
  30 #ifndef __GTK_ACTION_H__
  31 #define __GTK_ACTION_H__
  32
  33 #include <gtk/gtkwidget.h>
  34 #include <glib-object.h>
  35
  36 G_BEGIN_DECLS
  37
  38 #define GTK_TYPE_ACTION            (gtk_action_get_type ())
  39 #define GTK_ACTION(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ACTION, GtkAction))
  40 #define GTK_ACTION_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ACTION, GtkActionClass))
  41 #define GTK_IS_ACTION(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ACTION))
  42 #define GTK_IS_ACTION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ACTION))
  43 #define GTK_ACTION_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), GTK_TYPE_ACTION, GtkActionClass))
  44
  45 typedef struct _GtkAction      GtkAction;
  46 typedef struct _GtkActionClass GtkActionClass;
  47 typedef struct _GtkActionPrivate GtkActionPrivate;
  48
  49 struct _GtkAction
  50 {
  51   GObject object;
  52
  53   /*< private >*/
  54
  55   GtkActionPrivate *private_data;
  56 };
  57
  58 struct _GtkActionClass
  59 {
  60   GObjectClass parent_class;
  61
  62   /* activation signal */
  63   void       (* activate)           (GtkAction    *action);
  64
  65   GType      menu_item_type;
  66   GType      toolbar_item_type;
  67
  68   /* widget creation routines (not signals) */
  69   GtkWidget *(* create_menu_item)   (GtkAction *action);
  70   GtkWidget *(* create_tool_item)   (GtkAction *action);
  71   void       (* connect_proxy)      (GtkAction *action,
  72                                      GtkWidget *proxy);
  73   void       (* disconnect_proxy)   (GtkAction *action,
  74                                      GtkWidget *proxy);
  75
  76   GtkWidget *(* get_submenu)        (GtkAction *action);
  77
  78   /* Padding for future expansion */
  79   void (*_gtk_reserved2) (void);
  80   void (*_gtk_reserved3) (void);
  81   void (*_gtk_reserved4) (void);
  82 };
  83
  84 GType        gtk_action_get_type               (void) G_GNUC_CONST;
  85 GtkAction   *gtk_action_new                    (const gchar *name,
  86                                                 const gchar *label,
  87                                                 const gchar *tooltip,
  88                                                 const gchar *stock_id);
  89 G_CONST_RETURN gchar* gtk_action_get_name      (GtkAction     *action);
  90 gboolean     gtk_action_is_sensitive           (GtkAction     *action);
  91 gboolean     gtk_action_get_sensitive          (GtkAction     *action);
  92 void         gtk_action_set_sensitive          (GtkAction     *action,
  93                                                 gboolean       sensitive);
  94 gboolean     gtk_action_is_visible             (GtkAction     *action);
  95 gboolean     gtk_action_get_visible            (GtkAction     *action);
  96 void         gtk_action_set_visible            (GtkAction     *action,
  97                                                 gboolean       visible);
  98 void         gtk_action_activate               (GtkAction     *action);
  99 GtkWidget*   gtk_action_create_icon            (GtkAction     *action,
 100                                                 GtkIconSize    icon_size);
 101 GtkWidget*   gtk_action_create_menu_item       (GtkAction     *action);
 102 GtkWidget*   gtk_action_create_tool_item       (GtkAction     *action);
 103 void         gtk_action_connect_proxy          (GtkAction     *action,
 104                                                 GtkWidget     *proxy);
 105 void         gtk_action_disconnect_proxy       (GtkAction     *action,
 106                                                 GtkWidget     *proxy);
 107 GSList*      gtk_action_get_proxies            (GtkAction     *action);
 108 GtkAction   *gtk_widget_get_action             (GtkWidget     *widget);
 109 void         gtk_action_connect_accelerator    (GtkAction     *action);
 110 void         gtk_action_disconnect_accelerator (GtkAction     *action);
 111 G_CONST_RETURN gchar *gtk_action_get_accel_path (GtkAction     *action);
 112 GClosure    *gtk_action_get_accel_closure      (GtkAction     *action);
 113 GtkWidget *  gtk_action_get_submenu            (GtkAction     *action);
 114
 115 /* protected ... for use by child actions */
 116 void         gtk_action_block_activate_from    (GtkAction     *action,
 117                                                 GtkWidget     *proxy);
 118 void         gtk_action_unblock_activate_from  (GtkAction     *action,
 119                                                 GtkWidget     *proxy);
 120 void         _gtk_action_emit_activate         (GtkAction     *action);
 121
 122 /* protected ... for use by action groups */
 123 void         gtk_action_set_accel_path         (GtkAction     *action,
 124                                                 const gchar   *accel_path);
 125 void         gtk_action_set_accel_group        (GtkAction     *action,
 126                                                 GtkAccelGroup *accel_group);
 127 void         _gtk_action_sync_sensitive        (GtkAction     *action);
 128 void         _gtk_action_sync_visible          (GtkAction     *action);
 129 void         _gtk_action_sync_menu_visible     (GtkAction     *action,
 130                                                 GtkWidget     *proxy,
 131                                                 gboolean       empty);
 132
 133 G_END_DECLS
 134
 135 #endif  /* __GTK_ACTION_H__ */