AppChooserButton

The GtkAppChooserButton is a widget that lets the user select an application. It implements the GtkAppChooser interface.

Initially, a GtkAppChooserButton selects the first application in its list, which will either be the most-recently used application or, if "show-default-item" is TRUE, the default application.

The list of applications shown in a GtkAppChooserButton includes the recommended applications for the given content type. When "show-default-item" is set, the default application is also included. To let the user chooser other applications, you can set the "show-dialog-item" property, which allows to open a full GtkAppChooserDialog.

It is possible to add custom items to the list, using gtk_app_chooser_button_append_custom_item(). These items cause the "custom-item-activated" signal to be emitted when they are selected.

To track changes in the selected application, use the "changed" signal.

class AppChooserButton : ComboBox , AppChooserIF {

protected

GtkAppChooserButton* gtkAppChooserButton;

GtkAppChooserButton* getAppChooserButtonStruct();

void* getStruct();

this(GtkAppChooserButton* gtkAppChooserButton);

void setStruct(GObject* obj);

mixin AppChooserT!(GtkAppChooserButton) ;

int[string] connectedSignals;

void delegate(string, AppChooserButton)[] onCustomItemActivatedListeners;

void addOnCustomItemActivated(void delegate(string, AppChooserButton) dlg, ConnectFlags connectFlags);

static void callBackCustomItemActivated(GtkAppChooserButton* selfStruct, gchar* itemName, AppChooserButton _appChooserButton);

this(string contentType);

void appendCustomItem(string name, string label, IconIF icon);

void appendSeparator();

void setActiveCustomItem(string name);

int getShowDefaultItem();

void setShowDefaultItem(int setting);

int getShowDialogItem();

void setShowDialogItem(int setting);

string getHeading();

void setHeading(string heading);

}

Constructors

this this(GtkAppChooserButton* gtkAppChooserButton): Sets our main struct and passes it to the parent class
this this(string contentType): Creates a new GtkAppChooserButton for applications that can handle content of the given type.

Members

Functions

addOnCustomItemActivated void addOnCustomItemActivated(void delegate(string, AppChooserButton) dlg, ConnectFlags connectFlags): Emitted when a custom item, previously added with gtk_app_chooser_button_append_custom_item(), is activated from the dropdown menu.
appendCustomItem void appendCustomItem(string name, string label, IconIF icon): Appends a custom item to the list of applications that is shown in the popup; the item name must be unique per-widget. Clients can use the provided name as a detail for the "custom-item-activated" signal, to add a callback for the activation of a particular custom item in the list. See also gtk_app_chooser_button_append_separator().
appendSeparator void appendSeparator(): Appends a separator to the list of applications that is shown in the popup.
getAppChooserButtonStruct GtkAppChooserButton* getAppChooserButtonStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getHeading string getHeading(): Returns the text to display at the top of the dialog.
getShowDefaultItem int getShowDefaultItem(): Returns the current value of the "show-default-item" property.
getShowDialogItem int getShowDialogItem(): Returns the current value of the "show-dialog-item" property.
getStruct void* getStruct(): the main Gtk struct as a void*
setActiveCustomItem void setActiveCustomItem(string name): Selects a custom item previously added with gtk_app_chooser_button_append_custom_item(). Use gtk_app_chooser_refresh() to bring the selection to its initial state.
setHeading void setHeading(string heading): Sets the text to display at the top of the dialog. If the heading is not set, the dialog displays a default text.
setShowDefaultItem void setShowDefaultItem(int setting): Sets whether the dropdown menu of this button should show the default application for the given content type at top.
setShowDialogItem void setShowDialogItem(int setting): Sets whether the dropdown menu of this button should show an entry to trigger a GtkAppChooserDialog.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Mixins

__anonymous mixin AppChooserT!(GtkAppChooserButton): Undocumented in source.

Static functions

callBackCustomItemActivated void callBackCustomItemActivated(GtkAppChooserButton* selfStruct, gchar* itemName, AppChooserButton _appChooserButton): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals int[string] connectedSignals;
gtkAppChooserButton GtkAppChooserButton* gtkAppChooserButton;: the main Gtk struct
onCustomItemActivatedListeners void delegate(string, AppChooserButton)[] onCustomItemActivatedListeners;: Undocumented in source.

Inherited Members

From ComboBox

gtkComboBox GtkComboBox* gtkComboBox;: the main Gtk struct
getComboBoxStruct GtkComboBox* getComboBoxStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
__anonymous mixin CellLayoutT!(GtkComboBox): Undocumented in source.
__anonymous mixin CellEditableT!(GtkComboBox): Undocumented in source.
connectedSignals int[string] connectedSignals;
onChangedListeners void delegate(ComboBox)[] onChangedListeners;: Undocumented in source.
addOnChanged void addOnChanged(void delegate(ComboBox) dlg, ConnectFlags connectFlags): 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 gtk_combo_box_set_active_iter(). It will also be emitted while typing into the entry of a combo box with an entry. Since 2.4
callBackChanged void callBackChanged(GtkComboBox* widgetStruct, ComboBox _comboBox): Undocumented in source. Be warned that the author may not have intended to support it.
onFormatEntryTextListeners string delegate(string, ComboBox)[] onFormatEntryTextListeners;: Undocumented in source.
addOnFormatEntryText void addOnFormatEntryText(string delegate(string, ComboBox) dlg, ConnectFlags connectFlags): For combo boxes that are created with an entry (See GtkComboBox:has-entry). A signal which allows you to change how the text displayed in a combo box's entry is displayed. Connect a signal handler which returns an allocated string representing path. That string will then be used to set the text in the combo box's entry. The default signal handler uses the text from the GtkComboBox::entry-text-column model column. Here's an example signal handler which fetches data from the model and displays it in the entry. Since 3.4
callBackFormatEntryText void callBackFormatEntryText(GtkComboBox* comboStruct, gchar* path, ComboBox _comboBox): Undocumented in source. Be warned that the author may not have intended to support it.
onMoveActiveListeners void delegate(GtkScrollType, ComboBox)[] onMoveActiveListeners;: Undocumented in source.
addOnMoveActive void addOnMoveActive(void delegate(GtkScrollType, ComboBox) dlg, ConnectFlags connectFlags): The ::move-active signal is a keybinding signal which gets emitted to move the active selection. Since 2.12
callBackMoveActive void callBackMoveActive(GtkComboBox* widgetStruct, GtkScrollType scrollType, ComboBox _comboBox): Undocumented in source. Be warned that the author may not have intended to support it.
onPopdownListeners bool delegate(ComboBox)[] onPopdownListeners;: Undocumented in source.
addOnPopdown void addOnPopdown(bool delegate(ComboBox) dlg, ConnectFlags connectFlags): 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
callBackPopdown gboolean callBackPopdown(GtkComboBox* buttonStruct, ComboBox _comboBox): Undocumented in source. Be warned that the author may not have intended to support it.
onPopupListeners void delegate(ComboBox)[] onPopupListeners;: Undocumented in source.
addOnPopup void addOnPopup(void delegate(ComboBox) dlg, ConnectFlags connectFlags): 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 See Also GtkComboBoxText, GtkTreeModel, GtkCellRenderer
callBackPopup void callBackPopup(GtkComboBox* widgetStruct, ComboBox _comboBox): Undocumented in source. Be warned that the author may not have intended to support it.
getWrapWidth int getWrapWidth(): Returns the wrap width which is used to determine the number of columns for the popup menu. If the wrap width is larger than 1, the combo box is in table mode. Since 2.6
setWrapWidth void setWrapWidth(int width): Sets the wrap width of combo_box to be width. The wrap width is basically the preferred number of columns when you want the popup to be layed out in a table. Since 2.4
getRowSpanColumn int getRowSpanColumn(): Returns the column with row span information for combo_box. Since 2.6
setRowSpanColumn void setRowSpanColumn(int rowSpan): Sets the column with row span information for combo_box to be row_span. The row span column contains integers which indicate how many rows an item should span. Since 2.4
getColumnSpanColumn int getColumnSpanColumn(): Returns the column with column span information for combo_box. Since 2.6
setColumnSpanColumn void setColumnSpanColumn(int columnSpan): Sets the column with column span information for combo_box to be column_span. The column span column contains integers which indicate how many columns an item should span. Since 2.4
getActive int getActive(): Returns the index of the currently active item, or -1 if there's no active item. If the model is a non-flat treemodel, and the active item is not an immediate child of the root of the tree, this function returns gtk_tree_path_get_indices (path)[0], where path is the GtkTreePath of the active item. Since 2.4
setActive void setActive(int index): Sets the active item of combo_box to be the item at index. Since 2.4
getActiveIter int getActiveIter(TreeIter iter): Sets iter to point to the current active item, if it exists. Since 2.4
setActiveIter void setActiveIter(TreeIter iter): Sets the current active item to be the one referenced by iter, or unsets the active item if iter is NULL. Since 2.4
getIdColumn int getIdColumn(): Returns the column which combo_box is using to get string IDs for values from.
setIdColumn void setIdColumn(int idColumn): Sets the model column which combo_box should use to get string IDs for values from. The column id_column in the model of combo_box must be of type G_TYPE_STRING.
getActiveId string getActiveId(): Returns the ID of the active row of combo_box. This value is taken from the active row and the column specified by the "id-column" property of combo_box (see gtk_combo_box_set_id_column()). The returned value is an interned string which means that you can compare the pointer by value to other interned strings and that you must not free it. If the "id-column" property of combo_box is not set, or if no row is active, or if the active row has a NULL ID value, then NULL is returned.
setActiveId int setActiveId(string activeId): Changes the active row of combo_box to the one that has an ID equal to active_id, or unsets the active row if active_id is NULL. Rows having a NULL ID string cannot be made active by this function. If the "id-column" property of combo_box is unset or if no row has the given ID then the function does nothing and returns FALSE.
getModel TreeModelIF getModel(): Returns the GtkTreeModel which is acting as data source for combo_box. Since 2.4
setModel void setModel(TreeModelIF model): Sets the model used by combo_box to be model. Will unset a previously set model (if applicable). If model is NULL, then it will unset the model. Note that this function does not clear the cell renderers, you have to call gtk_cell_layout_clear() yourself if you need to set up different cell renderers for the new model. Since 2.4
popupForDevice void popupForDevice(Device device): Pops up the menu or dropdown list of combo_box, the popup window will be grabbed so only device and its associated pointer/keyboard are the only GdkDevices able to send events to it.
popup void popup(): Pops up the menu or dropdown list of combo_box. This function is mostly intended for use by accessibility technologies; applications should have little use for it. Since 2.4
popdown void popdown(): Hides the menu or dropdown list of combo_box. This function is mostly intended for use by accessibility technologies; applications should have little use for it. Since 2.4
getPopupAccessible ObjectAtk getPopupAccessible(): Gets the accessible object corresponding to the combo box's popup. This function is mostly intended for use by accessibility technologies; applications should have little use for it. Since 2.6
getRowSeparatorFunc GtkTreeViewRowSeparatorFunc getRowSeparatorFunc(): Returns the current row separator function. Since 2.6
setRowSeparatorFunc void setRowSeparatorFunc(GtkTreeViewRowSeparatorFunc func, void* data, GDestroyNotify destroy): Sets the row separator function, which is used to determine whether a row should be drawn as a separator. If the row separator function is NULL, no separators are drawn. This is the default value. Since 2.6
setAddTearoffs void setAddTearoffs(int addTearoffs): Warning gtk_combo_box_set_add_tearoffs is deprecated and should not be used in newly-written code. 3.10 Sets whether the popup menu should have a tearoff menu item. Since 2.6
getAddTearoffs int getAddTearoffs(): Warning gtk_combo_box_get_add_tearoffs is deprecated and should not be used in newly-written code. 3.10 Gets the current value of the :add-tearoffs property.
setTitle void setTitle(string title): Warning gtk_combo_box_set_title is deprecated and should not be used in newly-written code. 3.10 Sets the menu's title in tearoff mode. Since 2.10
getTitle string getTitle(): Warning gtk_combo_box_get_title is deprecated and should not be used in newly-written code. 3.10 Gets the current title of the menu in tearoff mode. See gtk_combo_box_set_add_tearoffs(). Since 2.10
setFocusOnClick void setFocusOnClick(int focusOnClick): Sets whether the combo box will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don't want the keyboard focus removed from the main area of the application. Since 2.6
getFocusOnClick int getFocusOnClick(): Returns whether the combo box grabs focus when it is clicked with the mouse. See gtk_combo_box_set_focus_on_click(). Since 2.6
setButtonSensitivity void setButtonSensitivity(GtkSensitivityType sensitivity): Sets whether the dropdown button of the combo box should be always sensitive (GTK_SENSITIVITY_ON), never sensitive (GTK_SENSITIVITY_OFF) or only if there is at least one item to display (GTK_SENSITIVITY_AUTO). Since 2.14
getButtonSensitivity GtkSensitivityType getButtonSensitivity(): Returns whether the combo box sets the dropdown button sensitive or not when there are no items in the model. Since 2.14
getHasEntry int getHasEntry(): Returns whether the combo box has an entry. Since 2.24
setEntryTextColumn void setEntryTextColumn(int textColumn): Sets the model column which combo_box should use to get strings from to be text_column. The column text_column in the model of combo_box must be of type G_TYPE_STRING. This is only relevant if combo_box has been created with "has-entry" as TRUE. Since 2.24
getEntryTextColumn int getEntryTextColumn(): Returns the column which combo_box is using to get the strings from to display in the internal entry. Since 2.24
setPopupFixedWidth void setPopupFixedWidth(int fixed): Specifies whether the popup's width should be a fixed width matching the allocated width of the combo box.
getPopupFixedWidth int getPopupFixedWidth(): Gets whether the popup uses a fixed width matching the allocated width of the combo box.

From AppChooserIF

getAppChooserTStruct GtkAppChooser* getAppChooserTStruct(): Undocumented in source.
getStruct void* getStruct(): the main Gtk struct as a void*
getAppInfo AppInfo getAppInfo(): Returns the currently selected application.
getContentType string getContentType(): Returns the current value of the "content-type" property.
refresh void refresh(): Reloads the list of applications.