1 #ifndef SEEN_EGE_SELECT_ONE_ACTION
2 #define SEEN_EGE_SELECT_ONE_ACTION
3 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
4 *
5 */
6 /* ***** BEGIN LICENSE BLOCK *****
7 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
8 *
9 * The contents of this file are subject to the Mozilla Public License Version
10 * 1.1 (the "License"); you may not use this file except in compliance with
11 * the License. You may obtain a copy of the License at
12 * http://www.mozilla.org/MPL/
13 *
14 * Software distributed under the License is distributed on an "AS IS" basis,
15 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
16 * for the specific language governing rights and limitations under the
17 * License.
18 *
19 * The Original Code is EGE Select One Action.
20 *
21 * The Initial Developer of the Original Code is
22 * Jon A. Cruz.
23 * Portions created by the Initial Developer are Copyright (C) 2007
24 * the Initial Developer. All Rights Reserved.
25 *
26 * Contributor(s):
27 *
28 * Alternatively, the contents of this file may be used under the terms of
29 * either the GNU General Public License Version 2 or later (the "GPL"), or
30 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
31 * in which case the provisions of the GPL or the LGPL are applicable instead
32 * of those above. If you wish to allow use of your version of this file only
33 * under the terms of either the GPL or the LGPL, and not to allow others to
34 * use your version of this file under the terms of the MPL, indicate your
35 * decision by deleting the provisions above and replace them with the notice
36 * and other provisions required by the GPL or the LGPL. If you do not delete
37 * the provisions above, a recipient may use your version of this file under
38 * the terms of any one of the MPL, the GPL or the LGPL.
39 *
40 * ***** END LICENSE BLOCK ***** */
42 /** \file
43 * GtkAction subclass that represents a set of values the user may select
44 * one from at a given time.
45 * This can manifest as a popup menu, a ComboBox, a set of toggle buttons,
46 * etc.
47 */
49 /* Note: this file should be kept compilable as both .cpp and .c */
51 #include <glib.h>
52 #include <gtk/gtkaction.h>
53 #include <gtk/gtktreemodel.h>
54 #include <glib-object.h>
56 G_BEGIN_DECLS
59 #define EGE_SELECT_ONE_ACTION_TYPE ( ege_select_one_action_get_type() )
60 #define EGE_SELECT_ONE_ACTION( obj ) ( G_TYPE_CHECK_INSTANCE_CAST( (obj), EGE_SELECT_ONE_ACTION_TYPE, EgeSelectOneAction) )
61 #define EGE_SELECT_ONE_ACTION_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( (klass), EGE_SELECT_ONE_ACTION_TYPE, EgeSelectOneActionClass) )
62 #define IS_EGE_SELECT_ONE_ACTION( obj ) ( G_TYPE_CHECK_INSTANCE_TYPE( (obj), EGE_SELECT_ONE_ACTION_TYPE) )
63 #define IS_EGE_SELECT_ONE_ACTION_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE( (klass), EGE_SELECT_ONE_ACTION_TYPE) )
64 #define EGE_SELECT_ONE_ACTION_GET_CLASS( obj ) ( G_TYPE_INSTANCE_GET_CLASS( (obj), EGE_SELECT_ONE_ACTION_TYPE, EgeSelectOneActionClass) )
66 typedef struct _EgeSelectOneAction EgeSelectOneAction;
67 typedef struct _EgeSelectOneActionClass EgeSelectOneActionClass;
68 typedef struct _EgeSelectOneActionPrivate EgeSelectOneActionPrivate;
70 /**
71 * Instance structure of EgeSelectOneAction.
72 */
73 struct _EgeSelectOneAction
74 {
75 /** Parent instance structure. */
76 GtkAction action;
78 /** Pointer to private instance data. */
79 EgeSelectOneActionPrivate *private_data;
80 };
82 /**
83 * Class structure of EgeSelectOneAction.
84 */
85 struct _EgeSelectOneActionClass
86 {
87 /** Parent class structure. */
88 GtkActionClass parent_class;
90 void (*changed) (EgeSelectOneAction* action);
91 };
93 /** Standard Gtk type function */
94 GType ege_select_one_action_get_type( void );
96 /**
97 * Creates a new EgeSelectOneAction instance.
98 * This is a GtkAction subclass that represents a set of values the user
99 * may select one from at a given time.
100 * This can manifest as a popup menu, a ComboBox, a set of toggle buttons,
101 * etc.
102 *
103 * @param name Functional name for the action.
104 * @param label Display label for the action.
105 * @param tooltip Tooltip for the action.
106 * @param stock_id Icon id to use.
107 * @param model the source of choices to present.
108 */
109 EgeSelectOneAction* ege_select_one_action_new( const gchar *name,
110 const gchar *label,
111 const gchar *tooltip,
112 const gchar *stock_id,
113 GtkTreeModel* model );
115 /**
116 * Returns the index of the currently selected item.
117 *
118 * @param action The action to fetch the selected index for.
119 */
120 gint ege_select_one_action_get_active( EgeSelectOneAction* action );
122 /**
123 * Sets the currently selected item.
124 *
125 * @param action The action to fetch the selected index for.
126 * @param val index of the item to make selected.
127 */
128 void ege_select_one_action_set_active( EgeSelectOneAction* action, gint val );
131 /**
132 * Returns the column used for the display label.
133 *
134 * @param action The action to fetch the label column for.
135 */
136 gint ege_select_one_action_get_label_column( EgeSelectOneAction* action );
138 /**
139 * Sets the column used for the display label.
140 *
141 * @param action The action to set the label column for.
142 * @param col column to use.
143 */
144 void ege_select_one_action_set_label_column( EgeSelectOneAction* action, gint col );
147 /**
148 * Returns the column used for the display icon.
149 *
150 * @param action The action to fetch the icon column for.
151 */
152 gint ege_select_one_action_get_icon_column( EgeSelectOneAction* action );
154 /**
155 * Sets the column used for the display icon.
156 *
157 * @param action The action to set the icon column for.
158 * @param col column to use.
159 */
160 void ege_select_one_action_set_icon_column( EgeSelectOneAction* action, gint col );
163 /**
164 * Returns the column used for the tooltip.
165 *
166 * @param action The action to fetch the tooltip column for.
167 */
168 gint ege_select_one_action_get_tooltip_column( EgeSelectOneAction* action );
170 /**
171 * Sets the column used for the tooltip.
172 *
173 * @param action The action to set the tooltip column for.
174 * @param col column to use.
175 */
176 void ege_select_one_action_set_tooltip_column( EgeSelectOneAction* action, gint col );
179 /**
180 * Sets a hint to be used in determining the display form.
181 * This is the XForms style 'appearance' hint: "full", "compact", "minimal".
182 *
183 * @param action The action to set the tooltip column for.
184 * @param val The value of the appearance hint.
185 */
186 void ege_select_one_action_set_appearance( EgeSelectOneAction* action, gchar const* val );
189 /* bit of a work-around */
190 void ege_select_one_action_set_radio_action_type( EgeSelectOneAction* action, GType radioActionType );
192 G_END_DECLS
194 #endif /* SEEN_EGE_SELECT_ONE_ACTION */