RecentChooserDialog

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

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

Typical usage

In the simplest of cases, you can use the following code to use a gtk.RecentChooserDialog to select a recently used file:

GtkWidget *dialog;
gint res;

dialog = gtk_recent_chooser_dialog_new ("Recent Documents",
parent_window,
_("_Cancel"),
GTK_RESPONSE_CANCEL,
_("_Open"),
GTK_RESPONSE_ACCEPT,
NULL);

res = gtk_dialog_run (GTK_DIALOG (dialog));
if (res == GTK_RESPONSE_ACCEPT)
{
GtkRecentInfo *info;
GtkRecentChooser *chooser = GTK_RECENT_CHOOSER (dialog);

info = gtk_recent_chooser_get_current_item (chooser);
open_file (gtk_recent_info_get_uri (info));
gtk_recent_info_unref (info);
}

gtk_widget_destroy (dialog);

Recently used files are supported since GTK+ 2.10.

class RecentChooserDialog : Dialog , RecentChooserIF {

protected

GtkRecentChooserDialog* gtkRecentChooserDialog;

GtkRecentChooserDialog* getRecentChooserDialogStruct(bool transferOwnership);

void* getStruct();

this(GtkRecentChooserDialog* gtkRecentChooserDialog, bool ownedRef);

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

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

static GType getType();

}

Constructors

this this(GtkRecentChooserDialog* gtkRecentChooserDialog, bool ownedRef): 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(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*

Static functions

getType GType getType()

Variables

gtkRecentChooserDialog GtkRecentChooserDialog* gtkRecentChooserDialog;: the main Gtk struct

Inherited Members

From Dialog

gtkDialog GtkDialog* gtkDialog;: the main Gtk struct
getDialogStruct GtkDialog* getDialogStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
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.
getContentArea VBox getContentArea(): Returns the content area of dialog.
getType GType getType()
addActionWidget void addActionWidget(Widget child, int responseId): Adds an activatable widget to the action area of a gtk.Dialog, 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 gtk.Dialog struct.
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.
getHeaderBar Widget getHeaderBar(): Returns the header bar of dialog. Note that the headerbar is only used by the dialog if the use-header-bar property is TRUE.
getResponseForWidget int getResponseForWidget(Widget widget): Gets the response id of a widget in the action area of a dialog.
getWidgetForResponse Widget getWidgetForResponse(int responseId): Gets the widget button that uses the given response ID in the action area of a dialog.
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 Dialog.run will be monitoring the ::response signal and take appropriate action.
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 Dialog.run, Dialog.run returns GTK_RESPONSE_NONE Otherwise, it returns the response ID from the ::response signal emission.
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.
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, bool 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.
addOnClose gulong addOnClose(void delegate(Dialog) dlg, ConnectFlags connectFlags): The ::close signal is a [keybinding signal]GtkBindingSignal which gets emitted when the user uses a keybinding to close the dialog.
addOnResponse gulong addOnResponse(void delegate(int, Dialog) dlg, ConnectFlags connectFlags): Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls Dialog.response. On a delete event, the response ID is GTK_RESPONSE_DELETE_EVENT Otherwise, it depends on which action widget was clicked.
alternativeDialogButtonOrder bool alternativeDialogButtonOrder(Screen screen): Returns TRUE if dialogs are expected to use an alternative button order on the screen screen. See Dialog.setAlternativeButtonOrder for more details about alternative button order.

From RecentChooserIF

getRecentChooserStruct GtkRecentChooser* getRecentChooserStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
addFilter void addFilter(RecentFilter filter): Adds filter to the list of gtk.RecentFilter objects held by chooser.
getCurrentItem RecentInfo getCurrentItem(): Gets the gtk.RecentInfo currently selected by chooser.
getCurrentUri string getCurrentUri(): Gets the URI currently selected by chooser.
getFilter RecentFilter getFilter(): Gets the gtk.RecentFilter object currently used by chooser to affect the display of the recently used resources.
getItems ListG getItems(): Gets the list of recently used resources in form of gtk.RecentInfo objects.
getLimit int getLimit(): Gets the number of items returned by gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris().
getLocalOnly bool getLocalOnly(): Gets whether only local resources should be shown in the recently used resources selector. See gtk_recent_chooser_set_local_only()
getSelectMultiple bool getSelectMultiple(): Gets whether chooser can select multiple items.
getShowIcons bool getShowIcons(): Retrieves whether chooser should show an icon near the resource.
getShowNotFound bool getShowNotFound(): Retrieves whether chooser should show the recently used resources that were not found.
getShowPrivate bool getShowPrivate(): Returns whether chooser should display recently used resources registered as private.
getShowTips bool getShowTips(): Gets whether chooser should display tooltips containing the full path of a recently user resource.
getSortType GtkRecentSortType getSortType(): Gets the value set by gtk_recent_chooser_set_sort_type().
getUris string[] getUris(): Gets the URI of the recently used resources.
listFilters ListSG listFilters(): Gets the gtk.RecentFilter objects held by chooser.
removeFilter void removeFilter(RecentFilter filter): Removes filter from the list of gtk.RecentFilter objects held by chooser.
selectAll void selectAll(): Selects all the items inside chooser, if the chooser supports multiple selection.
selectUri bool selectUri(string uri): Selects uri inside chooser.
setCurrentUri bool setCurrentUri(string uri): Sets uri as the current URI for chooser.
setFilter void setFilter(RecentFilter filter): Sets filter as the current gtk.RecentFilter object used by chooser to affect the displayed recently used resources.
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().
setLocalOnly void setLocalOnly(bool 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.
setSelectMultiple void setSelectMultiple(bool selectMultiple): Sets whether chooser can select multiple items.
setShowIcons void setShowIcons(bool showIcons): Sets whether chooser should show an icon near the resource when displaying it.
setShowNotFound void setShowNotFound(bool showNotFound): Sets whether chooser should display the recently used resources that it didn’t find. This only applies to local resources.
setShowPrivate void setShowPrivate(bool showPrivate): Whether to show recently used resources marked registered as private.
setShowTips void setShowTips(bool showTips): Sets whether to show a tooltips containing the full path of each recently used resource in a GtkRecentChooser widget.
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.
setSortType void setSortType(GtkRecentSortType sortType): Changes the sorting order of the recently used resources list displayed by chooser.
unselectAll void unselectAll(): Unselects all the items inside chooser.
unselectUri void unselectUri(string uri): Unselects uri inside chooser.
addOnItemActivated gulong 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.
addOnSelectionChanged gulong 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 explicitly calling functions to change the selection.

gtk RecentChooserDialog classes

RecentChooserDialog