GtkComboBox              package:RGtk2              R Documentation

_G_t_k_C_o_m_b_o_B_o_x

_D_e_s_c_r_i_p_t_i_o_n:

     A widget used to choose from a list of items

_M_e_t_h_o_d_s _a_n_d _F_u_n_c_t_i_o_n_s:

     'gtkComboBoxNew(show = TRUE)'
      'gtkComboBoxNewWithModel(model, show = TRUE)'
      'gtkComboBoxGetWrapWidth(object)'
      'gtkComboBoxSetWrapWidth(object, width)'
      'gtkComboBoxGetRowSpanColumn(object)'
      'gtkComboBoxSetRowSpanColumn(object, row.span)'
      'gtkComboBoxGetColumnSpanColumn(object)'
      'gtkComboBoxSetColumnSpanColumn(object, column.span)'
      'gtkComboBoxGetActive(object)'
      'gtkComboBoxSetActive(object, index)'
      'gtkComboBoxGetActiveIter(object)'
      'gtkComboBoxSetActiveIter(object, iter)'
      'gtkComboBoxGetModel(object)'
      'gtkComboBoxSetModel(object, model = NULL)'
      'gtkComboBoxNewText()'
      'gtkComboBoxAppendText(object, text)'
      'gtkComboBoxInsertText(object, position, text)'
      'gtkComboBoxPrependText(object, text)'
      'gtkComboBoxRemoveText(object, position)'
      'gtkComboBoxGetActiveText(object)'
      'gtkComboBoxPopup(object)'
      'gtkComboBoxPopdown(object)'
      'gtkComboBoxGetPopupAccessible(object)'
      'gtkComboBoxGetRowSeparatorFunc(object)'
      'gtkComboBoxSetRowSeparatorFunc(object, func, data = NULL)'
      'gtkComboBoxSetAddTearoffs(object, add.tearoffs)'
      'gtkComboBoxGetAddTearoffs(object)'
      'gtkComboBoxSetTitle(object, title)'
      'gtkComboBoxGetTitle(object)'
      'gtkComboBoxSetFocusOnClick(object, focus.on.click)'
      'gtkComboBoxGetFocusOnClick(object)'
      'gtkComboBox(model, show = TRUE)'

_H_i_e_r_a_r_c_h_y:

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkContainer
                                +----GtkBin
                                      +----GtkComboBox
                                            +----GtkComboBoxEntry 

_I_n_t_e_r_f_a_c_e_s:

     GtkComboBox implements AtkImplementorIface,  'GtkBuildable', 
     'GtkCellEditable' and  'GtkCellLayout'.

_D_e_t_a_i_l_e_d _D_e_s_c_r_i_p_t_i_o_n:

     A 'GtkComboBox' is a widget that allows the user to choose from a
     list of valid choices.  The 'GtkComboBox' displays the selected 
     choice.  When activated, the 'GtkComboBox' displays a popup  which
     allows the user to make a new choice. The style in which  the
     selected value is displayed, and the style of the popup is
     determined by the current theme. It may be similar to a
     'GtkOptionMenu', or similar to a Windows-style combo box.

     Unlike its predecessors 'GtkCombo' and 'GtkOptionMenu', the
     'GtkComboBox' uses the model-view pattern; the list of valid
     choices is specified in the form of a tree model, and the display
     of the choices can be adapted to the data in the model by using
     cell renderers, as you would in a tree view. This is possible
     since 'GtkComboBox' implements the 'GtkCellLayout' interface. The
     tree model holding the valid choices is not restricted to a flat
     list, it can be a real tree, and the popup will reflect the tree
     structure.

     In addition to the model-view API, 'GtkComboBox' offers a simple
     API which  is suitable for text-only combo boxes, and hides the
     complexity of managing the data in a model. It consists of the
     functions 'gtkComboBoxNewText',  'gtkComboBoxAppendText',
     'gtkComboBoxInsertText',  'gtkComboBoxPrependText',
     'gtkComboBoxRemoveText' and  'gtkComboBoxGetActiveText'.

_S_t_r_u_c_t_u_r_e_s:


     '_G_t_k_C_o_m_b_o_B_o_x' _undocumented _


_C_o_n_v_e_n_i_e_n_t _C_o_n_s_t_r_u_c_t_i_o_n:

     'gtkComboBox' is the result of collapsing the constructors of
     'GtkComboBox' ('gtkComboBoxNew', 'gtkComboBoxNewWithModel') and
     accepts a subset of its arguments matching the required arguments
     of one of its delegate constructors.

_S_i_g_n_a_l_s:


     '_c_h_a_n_g_e_d(_w_i_d_g_e_t, _u_s_e_r._d_a_t_a)' The changed signal is emitted when
          the active item is changed. The can be due to the user
          selecting a different item from the list, or due to a  call
          to 'gtkComboBoxSetActiveIter'. It will also be emitted while
          typing into a GtkComboBoxEntry,  as well as when selecting an
          item from the GtkComboBoxEntry's list.  

          Since  2.4

          '_w_i_d_g_e_t' ['GtkComboBox']  the object which received the
               signal

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_m_o_v_e-_a_c_t_i_v_e(_w_i_d_g_e_t, _s_c_r_o_l_l._t_y_p_e, _u_s_e_r._d_a_t_a)' The ::move-active
          signal is a  keybinding signal which gets emitted to move the
          active selection.  

          Since  2.12

          '_w_i_d_g_e_t' ['GtkComboBox']  the object that received the signal

          '_s_c_r_o_l_l._t_y_p_e' ['GtkScrollType']  a 'GtkScrollType'

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_p_o_p_d_o_w_n(_b_u_t_t_o_n, _u_s_e_r._d_a_t_a)' The ::popdown signal is a  keybinding
          signal  which gets emitted to popdown the combo box list.

          The default bindings for this signal are Alt+Up and Escape.  

          Since  2.12

          '_b_u_t_t_o_n' ['GtkComboBox']  the object which received the
               signal

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_p_o_p_u_p(_w_i_d_g_e_t, _u_s_e_r._d_a_t_a)' The ::popup signal is a  keybinding
          signal which gets emitted to popup the combo box list.

          The default binding for this signal is Alt+Down.  

          Since  2.12

          '_w_i_d_g_e_t' ['GtkComboBox']  the object that received the signal

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


_P_r_o_p_e_r_t_i_e_s:


     '_a_c_t_i_v_e' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] The item which is currently
          active. If the model is a non-flat treemodel, and the active
          item is not an immediate child of the root of the tree, this
          property has the value  'gtk_tree_path_get_indices
          (path)[0]', where 'path' is the 'GtkTreePath' of the active
          item.  

          Allowed values: >= -1  Default value: -1  Since  2.4


     '_a_d_d-_t_e_a_r_o_f_f_s' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] The add-tearoffs property
          controls whether generated menus  have tearoff menu items. 

          Note that this only affects menu style combo boxes.  

          Default value: FALSE  Since  2.6


     '_c_o_l_u_m_n-_s_p_a_n-_c_o_l_u_m_n' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] If this is set to a
          non-negative value, it must be the index of a column  of type
          'G_TYPE_INT' in the model. 

          The values of that column are used to determine how many
          columns a value  in the list will span.  

          Allowed values: >= -1  Default value: -1  Since  2.4


     '_f_o_c_u_s-_o_n-_c_l_i_c_k' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the combo box
          grabs focus when it is clicked with the mouse.  Default
          value: TRUE


     '_h_a_s-_f_r_a_m_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] The has-frame property
          controls whether a frame is drawn around the entry.  

          Default value: TRUE  Since  2.6


     '_m_o_d_e_l' ['_G_t_k_T_r_e_e_M_o_d_e_l' : _R_e_a_d / _W_r_i_t_e] The model from which the
          combo box takes the values shown in the list.  

          Since  2.4


     '_p_o_p_u_p-_s_h_o_w_n' [_l_o_g_i_c_a_l : _R_e_a_d] Whether the combo boxes dropdown is
          popped up.  Note that this property is mainly useful, because
          it allows you to connect to notify::popup-shown.  

          Default value: FALSE  Since  2.10


     '_r_o_w-_s_p_a_n-_c_o_l_u_m_n' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] If this is set to a
          non-negative value, it must be the index of a column  of type
          'G_TYPE_INT' in the model. 

          The values of that column are used to determine how many rows
          a value in  the list will span. Therefore, the values in the
          model column pointed to  by this property must be greater
          than zero and not larger than wrap-width.  

          Allowed values: >= -1  Default value: -1  Since  2.4


     '_t_e_a_r_o_f_f-_t_i_t_l_e' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] A title that may be
          displayed by the window manager  when the popup is torn-off.  

          Default value: ""  Since  2.10


     '_w_r_a_p-_w_i_d_t_h' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] If wrap-width is set to a
          positive value, the list will be displayed in multiple
          columns, the number of columns is determined by wrap-width.  

          Allowed values: >= 0  Default value: 0  Since  2.4


_S_t_y_l_e _P_r_o_p_e_r_t_i_e_s:


     '_a_p_p_e_a_r_s-_a_s-_l_i_s_t' [_l_o_g_i_c_a_l : _R_e_a_d] Whether dropdowns should look
          like lists rather than menus.  Default value: FALSE


     '_a_r_r_o_w-_s_i_z_e' [_i_n_t_e_g_e_r : _R_e_a_d] Sets the minimum size of the arrow
          in the combo box.  Note that the arrow size is coupled to the
          font size, so in case a larger font is used, the arrow will
          be larger than set by arrow size.  

          Allowed values: >= 0  Default value: 15  Since  2.12


     '_s_h_a_d_o_w-_t_y_p_e' ['_G_t_k_S_h_a_d_o_w_T_y_p_e' : _R_e_a_d] Which kind of shadow to
          draw around the combo box.  

          Default value: GTK_SHADOW_NONE  Since  2.12


_A_u_t_h_o_r(_s):

     Derived by RGtkGen from GTK+ documentation

_R_e_f_e_r_e_n_c_e_s:

     <URL: http://developer.gnome.org/doc/API/2.0/gtk/GtkComboBox.html>

_S_e_e _A_l_s_o:

     'GtkComboBoxEntry' 'GtkTreeModel' 'GtkCellRenderer'

