src/gtk/ComboBoxEntry.d

   1 /*
   2  * This file is part of duit.
   3  *
   4  * duit is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License as published by
   6  * the Free Software Foundation; either version 2.1 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * duit is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with duit; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 // generated automatically - do not change
  20 // find conversion definition on APILookup.txt
  21 // implement new conversion functionalities on the wrap.utils pakage
  22
  23 /*
  24  * Conversion parameters:
  25  * inFile  = GtkComboBoxEntry.html
  26  * outPack = gtk
  27  * outFile = ComboBoxEntry
  28  * strct   = GtkComboBoxEntry
  29  * realStrct=
  30  * ctorStrct=
  31  * clss    = ComboBoxEntry
  32  * interf  =
  33  * class Code: Yes
  34  * interface Code: No
  35  * template for:
  36  * extend  =
  37  * implements:
  38  *      - CellLayoutIF
  39  * prefixes:
  40  *      - gtk_combo_box_entry_
  41  * omit structs:
  42  * omit prefixes:
  43  * omit code:
  44  *      - gtk_combo_box_entry_new
  45  *      - gtk_combo_box_entry_new_text
  46  * imports:
  47  *      - gtk.TreeModel
  48  *      - glib.Str
  49  *      - gtk.CellRenderer
  50  *      - gtk.CellLayoutIF
  51  *      - gtk.CellLayoutT
  52  * structWrap:
  53  *      - GtkTreeModel* -> TreeModel
  54  * local aliases:
  55  */
  56
  57 module gtk.ComboBoxEntry;
  58
  59 private import gtk.gtktypes;
  60
  61 private import lib.gtk;
  62
  63 private import gtk.TreeModel;
  64 private import glib.Str;
  65 private import gtk.CellRenderer;
  66 private import gtk.CellLayoutIF;
  67 private import gtk.CellLayoutT;
  68
  69 /**
  70  * Description
  71  * A GtkComboBoxEntry is a widget that allows the user to choose from a
  72  * list of valid choices or enter a different value. It is very similar
  73  * to a GtkComboBox, but it displays the selected value in an entry to
  74  * allow modifying it.
  75  * In contrast to a GtkComboBox, the underlying model of a GtkComboBoxEntry
  76  * must always have a text column (see gtk_combo_box_entry_set_text_column()),
  77  * and the entry will show the content of the text column in the selected row. To
  78  * get the text from the entry, use gtk_combo_box_get_active_text().
  79  * The changed signal will be emitted while typing into a GtkComboBoxEntry,
  80  * as well as when selecting an item from the GtkComboBoxEntry's list. Use
  81  * gtk_combo_box_get_active() or gtk_combo_box_get_active_iter() to discover
  82  * whether an item was actually selected from the list.
  83  * Connect to the activate signal of the GtkEntry (use gtk_bin_get_child()) to
  84  * detect when the user actually finishes entering text.
  85  * The convenience API to construct simple text-only GtkComboBoxes can
  86  * also be used with GtkComboBoxEntrys which have been constructed
  87  * with gtk_combo_box_entry_new_text().
  88  */
  89 private import gtk.ComboBox;
  90 public class ComboBoxEntry : ComboBox, CellLayoutIF
  91 {
  92
  93         /** the main Gtk struct */
  94         protected GtkComboBoxEntry* gtkComboBoxEntry;
  95
  96
  97         public GtkComboBoxEntry* getComboBoxEntryStruct()
  98         {
  99                 return gtkComboBoxEntry;
 100         }
 101
 102
 103         /** the main Gtk struct as a void* */
 104         protected void* getStruct()
 105         {
 106                 return cast(void*)gtkComboBoxEntry;
 107         }
 108
 109         /**
 110          * Sets our main struct and passes it to the parent class
 111          */
 112         public this (GtkComboBoxEntry* gtkComboBoxEntry)
 113         {
 114                 super(cast(GtkComboBox*)gtkComboBoxEntry);
 115                 this.gtkComboBoxEntry = gtkComboBoxEntry;
 116         }
 117
 118         mixin CellLayoutT!(GtkComboBoxEntry);
 119         /**
 120          * Creates a new GtkComboBoxEntry which has a GtkEntry as child. After
 121          * construction, you should set a model using gtk_combo_box_set_model() and a
 122          * text_column * using gtk_combo_box_entry_set_text_column().
 123          * Returns:
 124          *  A new GtkComboBoxEntry.
 125          * Since 2.4
 126          */
 127         public this (bit text=true)
 128         {
 129                 if ( text )
 130                 {
 131                         // GtkWidget* gtk_combo_box_entry_new_text (void);
 132                         this(cast(GtkComboBoxEntry*)gtk_combo_box_entry_new_text() );
 133                 }
 134                 else
 135                 {
 136                         // GtkWidget* gtk_combo_box_entry_new (void);
 137                         this(cast(GtkComboBoxEntry*)gtk_combo_box_entry_new() );
 138                 }
 139
 140         }
 141
 142         /**
 143          */
 144
 145
 146
 147         /**
 148          * Creates a new GtkComboBoxEntry which has a GtkEntry as child and a list
 149          * of strings as popup. You can get the GtkEntry from a GtkComboBoxEntry
 150          * using GTK_ENTRY (GTK_BIN (combo_box_entry)->child). To add and remove
 151          * strings from the list, just modify model using its data manipulation
 152          * API.
 153          * model:
 154          *  A GtkTreeModel.
 155          * text_column:
 156          *  A column in model to get the strings from.
 157          * Returns:
 158          *  A new GtkComboBoxEntry.
 159          * Since 2.4
 160          */
 161         public this (TreeModel model, int textColumn)
 162         {
 163                 // GtkWidget* gtk_combo_box_entry_new_with_model  (GtkTreeModel *model,  gint text_column);
 164                 this(cast(GtkComboBoxEntry*)gtk_combo_box_entry_new_with_model((model is null) ? null : model.getTreeModelStruct(), textColumn) );
 165         }
 166
 167
 168         /**
 169          * Sets the model column which entry_box should use to get strings from
 170          * to be text_column.
 171          * entry_box:
 172          *  A GtkComboBoxEntry.
 173          * text_column:
 174          *  A column in model to get the strings from.
 175          * Since 2.4
 176          */
 177         public void setTextColumn(int textColumn)
 178         {
 179                 // void gtk_combo_box_entry_set_text_column  (GtkComboBoxEntry *entry_box,  gint text_column);
 180                 gtk_combo_box_entry_set_text_column(gtkComboBoxEntry, textColumn);
 181         }
 182
 183         /**
 184          * Returns the column which entry_box is using to get the strings from.
 185          * entry_box:
 186          *  A GtkComboBoxEntry.
 187          * Returns:
 188          *  A column in the data source model of entry_box.
 189          * Since 2.4
 190          * Property Details
 191          * The "text-column" property
 192          *  "text-column" gint : Read / Write
 193          * A column in the data source model to get the strings from.
 194          * Allowed values: >= -1
 195          * Default value: -1
 196          * See Also
 197          * GtkComboBox
 198          */
 199         public int getTextColumn()
 200         {
 201                 // gint gtk_combo_box_entry_get_text_column  (GtkComboBoxEntry *entry_box);
 202                 return gtk_combo_box_entry_get_text_column(gtkComboBoxEntry);
 203         }
 204 }