1 #ifndef SEEN_EGE_ADJUSTMENT_ACTION
2 #define SEEN_EGE_ADJUSTMENT_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 Adjustment 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) 2006
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 GtkAdjustment value.
44 */
46 /* Note: this file should be kept compilable as both .cpp and .c */
48 #include <glib.h>
49 #include <gtk/gtkaction.h>
50 #include <glib-object.h>
52 G_BEGIN_DECLS
55 #define EGE_ADJUSTMENT_ACTION_TYPE ( ege_adjustment_action_get_type() )
56 #define EGE_ADJUSTMENT_ACTION( obj ) ( G_TYPE_CHECK_INSTANCE_CAST( (obj), EGE_ADJUSTMENT_ACTION_TYPE, EgeAdjustmentAction) )
57 #define EGE_ADJUSTMENT_ACTION_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( (klass), EGE_ADJUSTMENT_ACTION_TYPE, EgeAdjustmentActionClass) )
58 #define IS_EGE_ADJUSTMENT_ACTION( obj ) ( G_TYPE_CHECK_INSTANCE_TYPE( (obj), EGE_ADJUSTMENT_ACTION_TYPE) )
59 #define IS_EGE_ADJUSTMENT_ACTION_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE( (klass), EGE_ADJUSTMENT_ACTION_TYPE) )
60 #define EGE_ADJUSTMENT_ACTION_GET_CLASS( obj ) ( G_TYPE_INSTANCE_GET_CLASS( (obj), EGE_ADJUSTMENT_ACTION_TYPE, EgeAdjustmentActionClass) )
62 typedef struct _EgeAdjustmentAction EgeAdjustmentAction;
63 typedef struct _EgeAdjustmentActionClass EgeAdjustmentActionClass;
64 typedef struct _EgeAdjustmentActionPrivate EgeAdjustmentActionPrivate;
66 /**
67 * Instance structure of EgeAdjustmentAction.
68 */
69 struct _EgeAdjustmentAction
70 {
71 /** Parent instance structure. */
72 GtkAction action;
74 /** Pointer to private instance data. */
75 EgeAdjustmentActionPrivate *private_data;
76 };
78 /**
79 * Class structure of EgeAdjustmentAction.
80 */
81 struct _EgeAdjustmentActionClass
82 {
83 /** Parent class structure. */
84 GtkActionClass parent_class;
85 };
87 /** Standard Gtk type function */
88 GType ege_adjustment_action_get_type( void );
90 /**
91 * Creates a new EgeAdjustmentAction instance.
92 * This is a GtkAction subclass that manages a value stored in a
93 * GtkAdjustment.
94 *
95 * @param adjustment The GtkAdjustment to manage.
96 * @param name Functional name for the action.
97 * @param label Display label for the action.
98 * @param tooltip Tooltip for the action.
99 * @param stock_id Icon id to use.
100 * @param climb_rate Used for created widgets.
101 * @param digits Used for created widgets.
102 */
103 EgeAdjustmentAction* ege_adjustment_action_new( GtkAdjustment* adjustment,
104 const gchar *name,
105 const gchar *label,
106 const gchar *tooltip,
107 const gchar *stock_id,
108 gdouble climb_rate,
109 guint digits
110 );
111 /**
112 * Returns a pointer to the GtkAdjustment represented by the given
113 * EgeAdjustmentAction.
114 *
115 * @param action The action to fetch the GtkAdjustment for.
116 */
117 GtkAdjustment* ege_adjustment_action_get_adjustment( EgeAdjustmentAction* action );
119 /**
120 * Sets the GtkWidget to return focus to.
121 * This is used to be able to transfer focus back out of a toolbar.
122 *
123 * @param action The action to set the widget for.
124 * @param widget The widget to return focus to after editing.
125 * @see ege_adjustment_action_get_focuswidget
126 */
127 void ege_adjustment_action_set_focuswidget( EgeAdjustmentAction* action, GtkWidget* widget );
129 /**
130 * Returns a pointer to the GtkWidget to return focus to after changing
131 * the value.
132 *
133 * @param action The action to fetch the focus widget for.
134 * @returns A pointer to the widget to return focus to, NULL if none set.
135 * @see ege_adjustment_action_set_focuswidget
136 */
137 GtkWidget* ege_adjustment_action_get_focuswidget( EgeAdjustmentAction* action );
139 /**
140 * Set a list of values with labels to explicitly include in menus.
141 *
142 * @param action The action to set explicit entries for.
143 * @param descriptions Array of descriptions to include.
144 * Descriptions will be matched one-for-one with numbers in the 'values' array.
145 * @param values Array of values to include.
146 * Values will be matched one-for-one with numbers in the 'descriptions' array.
147 * @param count Number of items in the 'descriptions' and 'values' arrays.
148 */
149 void ege_adjustment_action_set_descriptions( EgeAdjustmentAction* action, gchar const** descriptions, gdouble const* values, guint count );
151 /**
152 * Sets a hint to be used in determining the display form.
153 * This is the XForms style 'appearance' hint: "full", "compact", "minimal".
154 *
155 * @param action The action to set the tooltip column for.
156 * @param val The value of the appearance hint.
157 */
158 void ege_adjustment_action_set_appearance( EgeAdjustmentAction* action, gchar const* val );
160 /** Callback type for post-creation 'fixup' pass on generated widgets */
161 typedef void (*EgeWidgetFixup)(GtkWidget *widget);
164 G_END_DECLS
166 #endif /* SEEN_EGE_ADJUSTMENT_ACTION */