RecentChooserDialog

GtkRecentChooserDialog is a dialog box suitable for displaying the recently used documents. This widgets works by putting a GtkRecentChooserWidget inside a GtkDialog. It exposes the GtkRecentChooserIface interface, so you can use all the GtkRecentChooser functions on the recent chooser dialog as well as those for GtkDialog.

Note that GtkRecentChooserDialog does not have any methods of its own. Instead, you should use the functions that work on a GtkRecentChooser.

Recently used files are supported since GTK+ 2.10.

class RecentChooserDialog : Dialog , RecentChooserIF {

protected

GtkRecentChooserDialog* gtkRecentChooserDialog;

GtkRecentChooserDialog* getRecentChooserDialogStruct();

void* getStruct();

this(GtkRecentChooserDialog* gtkRecentChooserDialog);

void setStruct(GObject* obj);

mixin RecentChooserT!(GtkRecentChooserDialog) ;

this(string title, Window parent, RecentManager manager, string[] buttonsText, ResponseType[] responses);

this(string title, Window parent, RecentManager manager, StockID[] stockIDs, ResponseType[] responses);

}

Constructors

this this(GtkRecentChooserDialog* gtkRecentChooserDialog): Sets our main struct and passes it to the parent class
this this(string title, Window parent, RecentManager manager, string[] buttonsText, ResponseType[] responses): Creates a new GtkRecentChooserDialog with a specified recent manager. This is useful if you have implemented your own recent manager, or if you have a customized instance of a GtkRecentManager object. Since 2.10
this this(string title, Window parent, RecentManager manager, StockID[] stockIDs, ResponseType[] responses): Creates a new GtkRecentChooserDialog with a specified recent manager. This is useful if you have implemented your own recent manager, or if you have a customized instance of a GtkRecentManager object. Since 2.10

Members

Functions

getRecentChooserDialogStruct GtkRecentChooserDialog* getRecentChooserDialogStruct(): 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.

Mixins

__anonymous mixin RecentChooserT!(GtkRecentChooserDialog): Undocumented in source.

Variables

gtkRecentChooserDialog GtkRecentChooserDialog* gtkRecentChooserDialog;: the main Gtk struct

Inherited Members

From Dialog

gtkDialog GtkDialog* gtkDialog;: the main Gtk struct
getDialogStruct GtkDialog* getDialogStruct(): 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.
addButton Button addButton(StockID stockID, int responseId)
addButtons void addButtons(string[] buttonsText, ResponseType[] responses)
addButtons void addButtons(StockID[] stockIDs, ResponseType[] responses)
getActionArea HButtonBox getActionArea(): Returns the action area of dialog. Since 2.14
getContentArea VBox getContentArea(): Returns the content area of dialog. Since 2.14
connectedSignals int[string] connectedSignals;
onCloseListeners void delegate(Dialog)[] onCloseListeners;: Undocumented in source.
addOnClose void addOnClose(void delegate(Dialog) dlg, ConnectFlags connectFlags): The ::close signal is a keybinding signal which gets emitted when the user uses a keybinding to close the dialog. The default binding for this signal is the Escape key.
callBackClose void callBackClose(GtkDialog* arg0Struct, Dialog _dialog): Undocumented in source. Be warned that the author may not have intended to support it.
onResponseListeners void delegate(gint, Dialog)[] onResponseListeners;: Undocumented in source.
addOnResponse void addOnResponse(void delegate(gint, Dialog) dlg, ConnectFlags connectFlags): Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls gtk_dialog_response(). On a delete event, the response ID is GTK_RESPONSE_DELETE_EVENT. Otherwise, it depends on which action widget was clicked. See Also GtkVBox, GtkWindow, GtkButton
callBackResponse void callBackResponse(GtkDialog* dialogStruct, gint responseId, Dialog _dialog): Undocumented in source. Be warned that the author may not have intended to support it.
run int run(): Blocks in a recursive main loop until the dialog either emits the "response" signal, or is destroyed. If the dialog is destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the ::response signal emission. Before entering the recursive main loop, gtk_dialog_run() calls gtk_widget_show() on the dialog for you. Note that you still need to show any children of the dialog yourself. During gtk_dialog_run(), the default behavior of "delete-event" is disabled; if the dialog receives ::delete_event, it will not be destroyed as windows usually are, and gtk_dialog_run() will return GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog will be modal. You can force gtk_dialog_run() to return at any time by calling gtk_dialog_response() to emit the ::response signal. Destroying the dialog during gtk_dialog_run() is a very bad idea, because your post-run code won't know whether the dialog was destroyed or not. After gtk_dialog_run() returns, you are responsible for hiding or destroying the dialog if you wish to do so.
response void response(int responseId): Emits the "response" signal with the given response ID. Used to indicate that the user has responded to the dialog in some way; typically either you or gtk_dialog_run() will be monitoring the ::response signal and take appropriate action.
addButton Widget addButton(string buttonText, int responseId): Adds a button with the given text and sets things up so that clicking the button will emit the "response" signal with the given response_id. The button is appended to the end of the dialog's action area. The button widget is returned, but usually you don't need it.
addActionWidget void addActionWidget(Widget child, int responseId): Adds an activatable widget to the action area of a GtkDialog, connecting a signal handler that will emit the "response" signal on the dialog when the widget is activated. The widget is appended to the end of the dialog's action area. If you want to add a non-activatable widget, simply pack it into the action_area field of the GtkDialog struct.
setDefaultResponse void setDefaultResponse(int responseId): Sets the last widget in the dialog's action area with the given response_id as the default widget for the dialog. Pressing "Enter" normally activates the default widget.
setResponseSensitive void setResponseSensitive(int responseId, int setting): Calls gtk_widget_set_sensitive (widget, setting) for each widget in the dialog's action area with the given response_id. A convenient way to sensitize/desensitize dialog buttons.
getResponseForWidget int getResponseForWidget(Widget widget): Gets the response id of a widget in the action area of a dialog. Since 2.8
getWidgetForResponse Widget getWidgetForResponse(int responseId): Gets the widget button that uses the given response ID in the action area of a dialog. Since 2.20
alternativeDialogButtonOrder int alternativeDialogButtonOrder(Screen screen): Returns TRUE if dialogs are expected to use an alternative button order on the screen screen. See gtk_dialog_set_alternative_button_order() for more details about alternative button order. If you need to use this function, you should probably connect to the ::notify:gtk-alternative-button-order signal on the GtkSettings object associated to screen, in order to be notified if the button order setting changes. Since 2.6
setAlternativeButtonOrder void setAlternativeButtonOrder(int[] newOrder): Sets an alternative button order. If the "gtk-alternative-button-order" setting is set to TRUE, the dialog buttons are reordered according to the order of the response ids in new_order. See gtk_dialog_set_alternative_button_order() for more information. This function is for use by language bindings. Since 2.6 Style Property Details The "action-area-border" style property "action-area-border" gint : Read Width of border around the button area at the bottom of the dialog. Allowed values: >= 0 Default value: 5

From RecentChooserIF

getRecentChooserTStruct GtkRecentChooser* getRecentChooserTStruct(): Undocumented in source.
getStruct void* getStruct(): the main Gtk struct as a void*
onItemActivatedListeners void delegate(RecentChooserIF)[] onItemActivatedListeners [@property getter]
addOnItemActivated void addOnItemActivated(void delegate(RecentChooserIF) dlg, ConnectFlags connectFlags): This signal is emitted when the user "activates" a recent item in the recent chooser. This can happen by double-clicking on an item in the recently used resources list, or by pressing Enter. Since 2.10
onSelectionChangedListeners void delegate(RecentChooserIF)[] onSelectionChangedListeners [@property getter]: Undocumented in source.
addOnSelectionChanged void addOnSelectionChanged(void delegate(RecentChooserIF) dlg, ConnectFlags connectFlags): This signal is emitted when there is a change in the set of selected recently used resources. This can happen when a user modifies the selection with the mouse or the keyboard, or when explicitely calling functions to change the selection. Since 2.10 See Also GtkRecentManager, GtkRecentChooserDialog, GtkRecentChooserWidget, GtkRecentChooserMenu
setShowPrivate void setShowPrivate(int showPrivate): Whether to show recently used resources marked registered as private. Since 2.10
getShowPrivate int getShowPrivate(): Returns whether chooser should display recently used resources registered as private. Since 2.10
setShowNotFound void setShowNotFound(int showNotFound): Sets whether chooser should display the recently used resources that it didn't find. This only applies to local resources. Since 2.10
getShowNotFound int getShowNotFound(): Retrieves whether chooser should show the recently used resources that were not found. Since 2.10
setShowIcons void setShowIcons(int showIcons): Sets whether chooser should show an icon near the resource when displaying it. Since 2.10
getShowIcons int getShowIcons(): Retrieves whether chooser should show an icon near the resource. Since 2.10
setSelectMultiple void setSelectMultiple(int selectMultiple): Sets whether chooser can select multiple items. Since 2.10
getSelectMultiple int getSelectMultiple(): Gets whether chooser can select multiple items. Since 2.10
setLocalOnly void setLocalOnly(int localOnly): Sets whether only local resources, that is resources using the file:// URI scheme, should be shown in the recently used resources selector. If local_only is TRUE (the default) then the shown resources are guaranteed to be accessible through the operating system native file system. Since 2.10
getLocalOnly int getLocalOnly(): Gets whether only local resources should be shown in the recently used resources selector. See gtk_recent_chooser_set_local_only() Since 2.10
setLimit void setLimit(int limit): Sets the number of items that should be returned by gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris(). Since 2.10
getLimit int getLimit(): Gets the number of items returned by gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris(). Since 2.10
setShowTips void setShowTips(int showTips): Sets whether to show a tooltips containing the full path of each recently used resource in a GtkRecentChooser widget. Since 2.10
getShowTips int getShowTips(): Gets whether chooser should display tooltips containing the full path of a recently user resource. Since 2.10
setSortType void setSortType(GtkRecentSortType sortType): Changes the sorting order of the recently used resources list displayed by chooser. Since 2.10
getSortType GtkRecentSortType getSortType(): Gets the value set by gtk_recent_chooser_set_sort_type(). Since 2.10
setSortFunc void setSortFunc(GtkRecentSortFunc sortFunc, void* sortData, GDestroyNotify dataDestroy): Sets the comparison function used when sorting to be sort_func. If the chooser has the sort type set to GTK_RECENT_SORT_CUSTOM then the chooser will sort using this function. To the comparison function will be passed two GtkRecentInfo structs and sort_data; sort_func should return a positive integer if the first item comes before the second, zero if the two items are equal and a negative integer if the first item comes after the second. Since 2.10
setCurrentUri int setCurrentUri(string uri): Sets uri as the current URI for chooser. Since 2.10
getCurrentUri string getCurrentUri(): Gets the URI currently selected by chooser. Since 2.10
getCurrentItem RecentInfo getCurrentItem(): Gets the GtkRecentInfo currently selected by chooser. Since 2.10
selectUri int selectUri(string uri): Selects uri inside chooser. Since 2.10
unselectUri void unselectUri(string uri): Unselects uri inside chooser. Since 2.10
selectAll void selectAll(): Selects all the items inside chooser, if the chooser supports multiple selection. Since 2.10
unselectAll void unselectAll(): Unselects all the items inside chooser. Since 2.10
getItems ListG getItems(): Gets the list of recently used resources in form of GtkRecentInfo objects. The return value of this function is affected by the "sort-type" and "limit" properties of chooser. Since 2.10
getUris string[] getUris(): Gets the URI of the recently used resources. The return value of this function is affected by the "sort-type" and "limit" properties of chooser. Since the returned array is NULL terminated, length may be NULL. Since 2.10
addFilter void addFilter(RecentFilter filter): Adds filter to the list of GtkRecentFilter objects held by chooser. If no previous filter objects were defined, this function will call gtk_recent_chooser_set_filter(). Since 2.10
removeFilter void removeFilter(RecentFilter filter): Removes filter from the list of GtkRecentFilter objects held by chooser. Since 2.10
listFilters ListSG listFilters(): Gets the GtkRecentFilter objects held by chooser. Since 2.10
setFilter void setFilter(RecentFilter filter): Sets filter as the current GtkRecentFilter object used by chooser to affect the displayed recently used resources. Since 2.10
getFilter RecentFilter getFilter(): Gets the GtkRecentFilter object currently used by chooser to affect the display of the recently used resources. Since 2.10