src/ege-select-one-action.h

   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) 2010
  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 ***** */
  41
  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  */
  48
  49 /* Note: this file should be kept compilable as both .cpp and .c */
  50
  51 #include <glib.h>
  52 #include <gtk/gtkaction.h>
  53 #include <gtk/gtktreemodel.h>
  54 #include <glib-object.h>
  55
  56 G_BEGIN_DECLS
  57
  58
  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) )
  65
  66 typedef struct _EgeSelectOneAction      EgeSelectOneAction;
  67 typedef struct _EgeSelectOneActionClass EgeSelectOneActionClass;
  68 typedef struct _EgeSelectOneActionPrivate EgeSelectOneActionPrivate;
  69
  70 /**
  71  * Instance structure of EgeSelectOneAction.
  72  */
  73 struct _EgeSelectOneAction
  74 {
  75     /** Parent instance structure. */
  76     GtkAction action;
  77
  78     /** Pointer to private instance data. */
  79     EgeSelectOneActionPrivate *private_data;
  80 };
  81
  82 /**
  83  * Class structure of EgeSelectOneAction.
  84  */
  85 struct _EgeSelectOneActionClass
  86 {
  87     /** Parent class structure. */
  88     GtkActionClass parent_class;
  89
  90     void (*changed) (EgeSelectOneAction* action);
  91 };
  92
  93 /** Standard Gtk type function */
  94 GType ege_select_one_action_get_type( void );
  95
  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 );
 114
 115 GtkTreeModel *ege_select_one_action_get_model(EgeSelectOneAction* action );
 116
 117 /**
 118  * Returns the index of the currently selected item.
 119  *
 120  * @param action The action to fetch the selected index for.
 121  */
 122 gint ege_select_one_action_get_active( EgeSelectOneAction* action );
 123
 124 /**
 125  * Returns the text of the currently selected item.
 126  *
 127  * @param action The action to fetch the text for.
 128  * @return the selected text. The caller is responsible to call g_free() on it when done.
 129  */
 130 gchar *ege_select_one_action_get_active_text( EgeSelectOneAction* action );
 131
 132 /**
 133  * Sets the text of the currently selected item.
 134  *
 135  * @param action The action to fetch the text for.
 136  * @param text the text to set.
 137  */
 138 void ege_select_one_action_set_active_text( EgeSelectOneAction* action, gchar const *text );
 139
 140 /**
 141  * Sets the  currently selected item.
 142  *
 143  * @param action The action to fetch the selected index for.
 144  * @param val index of the item to make selected.
 145  */
 146 void ege_select_one_action_set_active( EgeSelectOneAction* action, gint val );
 147
 148 //void ege_select_one_action_set_sensitive( EgeSelectOneAction *action, gint val, gboolean sensitive );
 149
 150 /**
 151  * Update sensitive parameters.
 152  * @param action The action to update.
 153  */
 154 void ege_select_one_action_update_sensitive( EgeSelectOneAction *action );
 155
 156 /**
 157  * Returns the column used for the display label.
 158  *
 159  * @param action The action to fetch the label column for.
 160  */
 161 gint ege_select_one_action_get_label_column( EgeSelectOneAction* action );
 162
 163 /**
 164  * Sets the column used for the display label.
 165  *
 166  * @param action The action to set the label column for.
 167  * @param col column to use.
 168  */
 169 void ege_select_one_action_set_label_column( EgeSelectOneAction* action, gint col );
 170
 171
 172 /**
 173  * Returns the column used for the display icon.
 174  *
 175  * @param action The action to fetch the icon column for.
 176  */
 177 gint ege_select_one_action_get_icon_column( EgeSelectOneAction* action );
 178
 179 /**
 180  * Sets the column used for the display icon.
 181  *
 182  * @param action The action to set the icon column for.
 183  * @param col column to use.
 184  */
 185 void ege_select_one_action_set_icon_column( EgeSelectOneAction* action, gint col );
 186
 187 gint ege_select_one_action_get_icon_size( EgeSelectOneAction* action );
 188
 189 void ege_select_one_action_set_icon_size( EgeSelectOneAction* action, gint size );
 190
 191
 192 /**
 193  * Returns the column used for the tooltip.
 194  *
 195  * @param action The action to fetch the tooltip column for.
 196  */
 197 gint ege_select_one_action_get_tooltip_column( EgeSelectOneAction* action );
 198
 199 /**
 200  * Sets the column used for the tooltip.
 201  *
 202  * @param action The action to set the tooltip column for.
 203  * @param col column to use.
 204  */
 205 void ege_select_one_action_set_tooltip_column( EgeSelectOneAction* action, gint col );
 206
 207
 208 /**
 209  * Returns the column used for tracking sensitivity.
 210  *
 211  * @param action The action to fetch the sensitive column for.
 212  */
 213 gint ege_select_one_action_get_sensitive_column( EgeSelectOneAction* action );
 214
 215 /**
 216  * Sets the column used for sensitivity (if any).
 217  *
 218  * @param action The action to set the sensitive column for.
 219  * @param col column to use.
 220  */
 221 void ege_select_one_action_set_sensitive_column( EgeSelectOneAction* action, gint col );
 222
 223
 224 /**
 225  * Sets a hint to be used in determining the display form.
 226  * This is the XForms style 'appearance' hint: "full", "compact", "minimal".
 227  *
 228  * @param action The action to set the tooltip column for.
 229  * @param val The value of the appearance hint.
 230  */
 231 void ege_select_one_action_set_appearance( EgeSelectOneAction* action, gchar const* val );
 232
 233 /**
 234  * Sets to allow or disallow free entry additions to the list.
 235  * The default is "closed" selections that do not allow additions/edits.
 236  * This is the XForms functional 'selection' attribute: "open", "closed".
 237  *
 238  * @param action The action to set the tooltip column for.
 239  * @param val The value of the selection attribute.
 240  */
 241 void ege_select_one_action_set_selection( EgeSelectOneAction *action, gchar const* val );
 242
 243 /* bit of a work-around */
 244 void ege_select_one_action_set_radio_action_type( EgeSelectOneAction* action, GType radioActionType );
 245
 246 G_END_DECLS
 247
 248 #endif /* SEEN_EGE_SELECT_ONE_ACTION */