Dialog

Dialog boxes are a convenient way to prompt the user for a small amount of input, e.g. to display a message, ask a question, or anything else that does not require extensive effort on the user’s part.

GTK+ treats a dialog as a window split vertically. The top section is a gtk.VBox, and is where widgets such as a gtk.Label or a gtk.Entry should be packed. The bottom area is known as the “action area”. This is generally used for packing buttons into the dialog which may perform functions such as cancel, ok, or apply.

gtk.Dialog boxes are created with a call to Dialog.new or Dialog.newWithButtons. Dialog.newWithButtons is recommended; it allows you to set the dialog title, some convenient flags, and add simple buttons.

If “dialog” is a newly created dialog, the two primary areas of the window can be accessed through Dialog.getContentArea and Dialog.getActionArea, as can be seen from the example below.

A “modal” dialog (that is, one which freezes the rest of the application from user input), can be created by calling Window.setModal on the dialog. Use the GTK_WINDOW() macro to cast the widget returned from Dialog.new into a gtk.Window When using Dialog.newWithButtons you can also pass the GTK_DIALOG_MODAL flag to make a dialog modal.

If you add buttons to gtk.Dialog using Dialog.newWithButtons, Dialog.addButton, Dialog.addButtons, or Dialog.addActionWidget, clicking the button will emit a signal called response with a response ID that you specified. GTK+ will never assign a meaning to positive response IDs; these are entirely user-defined. But for convenience, you can use the response IDs in the GtkResponseType enumeration (these all have values less than zero). If a dialog receives a delete event, the response signal will be emitted with a response ID of GTK_RESPONSE_DELETE_EVENT

If you want to block waiting for a dialog to return before returning control flow to your code, you can call Dialog.run. This function enters a recursive main loop and waits for the user to respond to the dialog, returning the response ID corresponding to the button the user clicked.

For the simple dialog in the following example, in reality you’d probably use gtk.MessageDialog to save yourself some effort. But you’d need to create the dialog contents manually if you had more than a simple message in the dialog.

An example for simple GtkDialog usage:

// Function to open a dialog box with a message
void
quick_message (GtkWindow *parent, gchar *message)
{
GtkWidget *dialog, *label, *content_area;
GtkDialogFlags flags;

// Create the widgets
flags = GTK_DIALOG_DESTROY_WITH_PARENT;
dialog = gtk_dialog_new_with_buttons ("Message",
parent,
flags,
_("_OK"),
GTK_RESPONSE_NONE,
NULL);
content_area = gtk_dialog_get_content_area (GTK_DIALOG (dialog));
label = gtk_label_new (message);

// Ensure that the dialog box is destroyed when the user responds

g_signal_connect_swapped (dialog,
"response",
G_CALLBACK (gtk_widget_destroy),
dialog);

// Add the label, and show everything we’ve added

gtk_container_add (GTK_CONTAINER (content_area), label);
gtk_widget_show_all (dialog);
}

GtkDialog as GtkBuildable

The GtkDialog implementation of the GtkBuildable interface exposes the vbox and action_area as internal children with the names “vbox” and “action_area”.

GtkDialog supports a custom <action-widgets> element, which can contain multiple <action-widget> elements. The “response” attribute specifies a numeric response, and the content of the element is the id of widget (which should be a child of the dialogs action_area). To mark a response as default, set the “default“ attribute of the <action-widget> element to true.

GtkDialog supports adding action widgets by specifying “action“ as the “type“ attribute of a <child> element. The widget will be added either to the action area or the headerbar of the dialog, depending on the “use-header-bar“ property. The response id has to be associated with the action widget using the <action-widgets> element.

An example of a gtk.Dialog UI definition fragment: |[ <object class="GtkDialog" id="dialog1"> <child type="action"> <object class="GtkButton" id="button_cancel"/> </child> <child type="action"> <object class="GtkButton" id="button_ok"> <property name="can-default">True</property> </object> </child> <action-widgets> <action-widget response="cancel">button_cancel</action-widget> <action-widget response="ok" default="true">button_ok</action-widget> </action-widgets> </object>

class Dialog : Window {

protected

GtkDialog* gtkDialog;

GtkDialog* getDialogStruct(bool transferOwnership);

void* getStruct();

this(GtkDialog* gtkDialog, bool ownedRef);

this(string title, Window parent, GtkDialogFlags flags, string[] buttonsText, ResponseType[] responses);

this(string title, Window parent, GtkDialogFlags flags, StockID[] stockIDs, ResponseType[] responses);

Button addButton(StockID stockID, int responseId);

void addButtons(string[] buttonsText, ResponseType[] responses);

void addButtons(StockID[] stockIDs, ResponseType[] responses);

HButtonBox getActionArea();

VBox getContentArea();

static GType getType();

this();

void addActionWidget(Widget child, int responseId);

Widget addButton(string buttonText, int responseId);

Widget getHeaderBar();

int getResponseForWidget(Widget widget);

Widget getWidgetForResponse(int responseId);

void response(int responseId);

int run();

void setAlternativeButtonOrder(int[] newOrder);

void setDefaultResponse(int responseId);

void setResponseSensitive(int responseId, bool setting);

gulong addOnClose(void delegate(Dialog) dlg, ConnectFlags connectFlags);

gulong addOnResponse(void delegate(int, Dialog) dlg, ConnectFlags connectFlags);

static bool alternativeDialogButtonOrder(Screen screen);

}

Constructors

this this(GtkDialog* gtkDialog, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(string title, Window parent, GtkDialogFlags flags, string[] buttonsText, ResponseType[] responses)
this(string title, Window parent, GtkDialogFlags flags, StockID[] stockIDs, ResponseType[] responses): Both title and parent can be null.
this this(): Creates a new dialog box.

Members

Functions

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 Button addButton(StockID stockID, int responseId)
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.
addButtons void addButtons(string[] buttonsText, ResponseType[] responses)
addButtons void addButtons(StockID[] stockIDs, ResponseType[] responses)
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.
getActionArea HButtonBox getActionArea(): Returns the action area of dialog.
getContentArea VBox getContentArea(): Returns the content area of dialog.
getDialogStruct GtkDialog* getDialogStruct(bool transferOwnership): Get the main Gtk struct
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.
getStruct void* getStruct(): the main Gtk struct as a void*
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.

Static functions

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.
getType GType getType()

Variables

gtkDialog GtkDialog* gtkDialog;: the main Gtk struct

Inherited Members

From Window

gtkWindow GtkWindow* gtkWindow;: the main Gtk struct
getWindowStruct GtkWindow* getWindowStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
move void move(double x, double y): Move the window to an absolute position. just calls move(int, int). convinience because GdkEvent structs return the position coords as doubles
getType GType getType()
getDefaultIconList ListG getDefaultIconList(): Gets the value set by Window.setDefaultIconList. The list is a copy and should be freed with g_list_free(), but the pixbufs in the list have not had their reference count incremented.
getDefaultIconName string getDefaultIconName(): Returns the fallback icon name for windows that has been set with Window.setDefaultIconName. The returned string is owned by GTK+ and should not be modified. It is only valid until the next call to Window.setDefaultIconName.
listToplevels ListG listToplevels(): Returns a list of all existing toplevel windows. The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call g_list_foreach (result, (GFunc)g_object_ref, NULL) first, and then unref all the widgets afterwards.
setAutoStartupNotification void setAutoStartupNotification(bool setting): By default, after showing the first gtk.Window, GTK+ calls gdk_notify_startup_complete(). Call this function to disable the automatic startup notification. You might do this if your first window is a splash screen, and you want to delay notification until after your real main window has been shown, for example.
setDefaultIcon void setDefaultIcon(Pixbuf icon): Sets an icon to be used as fallback for windows that haven't had Window.setIcon called on them from a pixbuf.
setDefaultIconFromFile bool setDefaultIconFromFile(string filename): Sets an icon to be used as fallback for windows that haven't had Window.setIconList called on them from a file on disk. Warns on failure if err is NULL.
setDefaultIconList void setDefaultIconList(ListG list): Sets an icon list to be used as fallback for windows that haven't had Window.setIconList called on them to set up a window-specific icon list. This function allows you to set up the icon for all windows in your app at once.
setDefaultIconName void setDefaultIconName(string name): Sets an icon to be used as fallback for windows that haven't had Window.setIconList called on them from a named themed icon, see Window.setIconName.
setInteractiveDebugging void setInteractiveDebugging(bool enable): Opens or closes the [interactive debugger][interactive-debugging], which offers access to the widget hierarchy of the application and to useful debugging tools.
activateDefault bool activateDefault(): Activates the default widget for the window, unless the current focused widget has been configured to receive the default action (see Widget.setReceivesDefault), in which case the focused widget is activated.
activateFocus bool activateFocus(): Activates the current focused widget within the window.
activateKey bool activateKey(GdkEventKey* event): Activates mnemonics and accelerators for this gtk.Window This is normally called by the default ::key_press_event handler for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window.
addAccelGroup void addAccelGroup(AccelGroup accelGroup): Associate accel_group with window, such that calling gtk_accel_groups_activate() on window will activate accelerators in accel_group.
addMnemonic void addMnemonic(uint keyval, Widget target): Adds a mnemonic to this window.
beginMoveDrag void beginMoveDrag(int button, int rootX, int rootY, uint timestamp): Starts moving a window. This function is used if an application has window movement grips. When GDK can support it, the window movement will be done using the standard mechanism for the [window manager][gtk-X11-arch] or windowing system. Otherwise, GDK will try to emulate window movement, potentially not all that well, depending on the windowing system.
beginResizeDrag void beginResizeDrag(GdkWindowEdge edge, int button, int rootX, int rootY, uint timestamp): Starts resizing a window. This function is used if an application has window resizing controls. When GDK can support it, the resize will be done using the standard mechanism for the [window manager][gtk-X11-arch] or windowing system. Otherwise, GDK will try to emulate window resizing, potentially not all that well, depending on the windowing system.
close void close(): Requests that the window is closed, similar to what happens when a window manager close button is clicked.
deiconify void deiconify(): Asks to deiconify (i.e. unminimize) the specified window. Note that you shouldn’t assume the window is definitely deiconified afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch])) could iconify it again before your code which assumes deiconification gets to run.
fullscreen void fullscreen(): Asks to place window in the fullscreen state. Note that you shouldn’t assume the window is definitely full screen afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could unfullscreen it again, and not all window managers honor requests to fullscreen windows. But normally the window will end up fullscreen. Just don’t write code that crashes if not.
fullscreenOnMonitor void fullscreenOnMonitor(Screen screen, int monitor): Asks to place window in the fullscreen state. Note that you shouldn't assume the window is definitely full screen afterward.
getAcceptFocus bool getAcceptFocus(): Gets the value set by Window.setAcceptFocus.
getApplication Application getApplication(): Gets the gtk.Application associated with the window (if any).
getAttachedTo Widget getAttachedTo(): Fetches the attach widget for this window. See Window.setAttachedTo.
getDecorated bool getDecorated(): Returns whether the window has been set to have decorations such as a title bar via Window.setDecorated.
getDefaultSize void getDefaultSize(int width, int height): Gets the default size of the window. A value of -1 for the width or height indicates that a default size has not been explicitly set for that dimension, so the “natural” size of the window will be used.
getDefaultWidget Widget getDefaultWidget(): Returns the default widget for window. See Window.setDefault for more details.
getDeletable bool getDeletable(): Returns whether the window has been set to have a close button via Window.setDeletable.
getDestroyWithParent bool getDestroyWithParent(): Returns whether the window will be destroyed with its transient parent. See gtk_window_set_destroy_with_parent ().
getFocus Widget getFocus(): Retrieves the current focused widget within the window. Note that this is the widget that would have the focus if the toplevel window focused; if the toplevel window is not focused then gtk_widget_has_focus (widget) will not be TRUE for the widget.
getFocusOnMap bool getFocusOnMap(): Gets the value set by Window.setFocusOnMap.
getFocusVisible bool getFocusVisible(): Gets the value of the focus-visible property.
getGravity GdkGravity getGravity(): Gets the value set by Window.setGravity.
getGroup WindowGroup getGroup(): Returns the group for window or the default group, if window is NULL or if window does not have an explicit window group.
getHasResizeGrip bool getHasResizeGrip(): Determines whether the window may have a resize grip.
getHideTitlebarWhenMaximized bool getHideTitlebarWhenMaximized(): Returns whether the window has requested to have its titlebar hidden when maximized. See gtk_window_set_hide_titlebar_when_maximized ().
getIcon Pixbuf getIcon(): Gets the value set by Window.setIcon (or if you've called Window.setIconList, gets the first icon in the icon list).
getIconList ListG getIconList(): Retrieves the list of icons set by Window.setIconList. The list is copied, but the reference count on each member won’t be incremented.
getIconName string getIconName(): Returns the name of the themed icon for the window, see Window.setIconName.
getMnemonicModifier GdkModifierType getMnemonicModifier(): Returns the mnemonic modifier for this window. See Window.setMnemonicModifier.
getMnemonicsVisible bool getMnemonicsVisible(): Gets the value of the mnemonics-visible property.
getModal bool getModal(): Returns whether the window is modal. See Window.setModal.
getOpacity double getOpacity(): Fetches the requested opacity for this window. See Window.setOpacity.
getPosition void getPosition(int rootX, int rootY): This function returns the position you need to pass to Window.move to keep window in its current position. This means that the meaning of the returned value varies with window gravity. See Window.move for more details.
getResizable bool getResizable(): Gets the value set by Window.setResizable.
getResizeGripArea bool getResizeGripArea(GdkRectangle rect): If a window has a resize grip, this will retrieve the grip position, width and height into the specified gdk.Rectangle
getRole string getRole(): Returns the role of the window. See Window.setRole for further explanation.
getScreen Screen getScreen(): Returns the gdk.Screen associated with window.
getSize void getSize(int width, int height): Obtains the current size of window.
getSkipPagerHint bool getSkipPagerHint(): Gets the value set by Window.setSkipPagerHint.
getSkipTaskbarHint bool getSkipTaskbarHint(): Gets the value set by Window.setSkipTaskbarHint
getTitle string getTitle(): Retrieves the title of the window. See Window.setTitle.
getTitlebar Widget getTitlebar(): Returns the custom titlebar that has been set with Window.setTitlebar.
getTransientFor Window getTransientFor(): Fetches the transient parent for this window. See Window.setTransientFor.
getTypeHint GdkWindowTypeHint getTypeHint(): Gets the type hint for this window. See Window.setTypeHint.
getUrgencyHint bool getUrgencyHint(): Gets the value set by Window.setUrgencyHint
getWindowType GtkWindowType getWindowType(): Gets the type of the window. See GtkWindowType
hasGroup bool hasGroup(): Returns whether window has an explicit window group.
hasToplevelFocus bool hasToplevelFocus(): Returns whether the input focus is within this GtkWindow. For real toplevel windows, this is identical to Window.isActive, but for embedded windows, like gtk.Plug, the results will differ.
iconify void iconify(): Asks to iconify (i.e. minimize) the specified window. Note that you shouldn’t assume the window is definitely iconified afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could deiconify it again, or there may not be a window manager in which case iconification isn’t possible, etc. But normally the window will end up iconified. Just don’t write code that crashes if not.
isActive bool isActive(): Returns whether the window is part of the current active toplevel. (That is, the toplevel window receiving keystrokes.) The return value is TRUE if the window is active toplevel itself, but also if it is, say, a gtk.Plug embedded in the active toplevel. You might use this function if you wanted to draw a widget differently in an active window from a widget in an inactive window. See Window.hasToplevelFocus
isMaximized bool isMaximized(): Retrieves the current maximized state of window.
maximize void maximize(): Asks to maximize window, so that it becomes full-screen. Note that you shouldn’t assume the window is definitely maximized afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could unmaximize it again, and not all window managers support maximization. But normally the window will end up maximized. Just don’t write code that crashes if not.
mnemonicActivate bool mnemonicActivate(uint keyval, GdkModifierType modifier): Activates the targets associated with the mnemonic.
move void move(int x, int y): Asks the [window manager][gtk-X11-arch] to move window to the given position. Window managers are free to ignore this; most window managers ignore requests for initial window positions (instead using a user-defined placement algorithm) and honor requests after the window has already been shown.
parseGeometry bool parseGeometry(string geometry): Parses a standard X Window System geometry string - see the manual page for X (type “man X”) for details on this. Window.parseGeometry does work on all GTK+ ports including Win32 but is primarily intended for an X environment.
present void present(): Presents a window to the user. This function should not be used as when it is called, it is too late to gather a valid timestamp to allow focus stealing prevention to work correctly.
presentWithTime void presentWithTime(uint timestamp): Presents a window to the user. This may mean raising the window in the stacking order, deiconifying it, moving it to the current desktop, and/or giving it the keyboard focus, possibly dependent on the user’s platform, window manager, and preferences.
propagateKeyEvent bool propagateKeyEvent(GdkEventKey* event): Propagate a key press or release event to the focus widget and up the focus container chain until a widget handles event. This is normally called by the default ::key_press_event and ::key_release_event handlers for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window.
removeAccelGroup void removeAccelGroup(AccelGroup accelGroup): Reverses the effects of Window.addAccelGroup.
removeMnemonic void removeMnemonic(uint keyval, Widget target): Removes a mnemonic from this window.
reshowWithInitialSize void reshowWithInitialSize(): Hides window, then reshows it, resetting the default size and position of the window. Used by GUI builders only.
resize void resize(int width, int height): Resizes the window as if the user had done so, obeying geometry constraints. The default geometry constraint is that windows may not be smaller than their size request; to override this constraint, call Widget.setSizeRequest to set the window's request to a smaller value.
resizeGripIsVisible bool resizeGripIsVisible(): Determines whether a resize grip is visible for the specified window.
resizeToGeometry void resizeToGeometry(int width, int height): Like Window.resize, but width and height are interpreted in terms of the base size and increment set with gtk_window_set_geometry_hints.
setAcceptFocus void setAcceptFocus(bool setting): Windows may set a hint asking the desktop environment not to receive the input focus. This function sets this hint.
setApplication void setApplication(Application application): Sets or unsets the gtk.Application associated with the window.
setAttachedTo void setAttachedTo(Widget attachWidget): Marks window as attached to attach_widget. This creates a logical binding between the window and the widget it belongs to, which is used by GTK+ to propagate information such as styling or accessibility to window as if it was a children of attach_widget.
setDecorated void setDecorated(bool setting): By default, windows are decorated with a title bar, resize controls, etc. Some [window managers][gtk-X11-arch] allow GTK+ to disable these decorations, creating a borderless window. If you set the decorated property to FALSE using this function, GTK+ will do its best to convince the window manager not to decorate the window. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling Widget.show.
setDefault void setDefault(Widget defaultWidget): The default widget is the widget that’s activated when the user presses Enter in a dialog (for example). This function sets or unsets the default widget for a gtk.Window When setting (rather than unsetting) the default widget it’s generally easier to call Widget.grabDefault on the widget. Before making a widget the default widget, you must call Widget.setCanDefault on the widget you’d like to make the default.
setDefaultGeometry void setDefaultGeometry(int width, int height): Like Window.setDefaultSize, but width and height are interpreted in terms of the base size and increment set with gtk_window_set_geometry_hints.
setDefaultSize void setDefaultSize(int width, int height): Sets the default size of a window. If the window’s “natural” size (its size request) is larger than the default, the default will be ignored. More generally, if the default size does not obey the geometry hints for the window (Window.setGeometryHints can be used to set these explicitly), the default size will be clamped to the nearest permitted size.
setDeletable void setDeletable(bool setting): By default, windows have a close button in the window frame. Some [window managers][gtk-X11-arch] allow GTK+ to disable this button. If you set the deletable property to FALSE using this function, GTK+ will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling Widget.show.
setDestroyWithParent void setDestroyWithParent(bool setting): If setting is TRUE, then destroying the transient parent of window will also destroy window itself. This is useful for dialogs that shouldn’t persist beyond the lifetime of the main window they're associated with, for example.
setFocus void setFocus(Widget focus): If focus is not the current focus widget, and is focusable, sets it as the focus widget for the window. If focus is NULL, unsets the focus widget for this window. To set the focus to a particular widget in the toplevel, it is usually more convenient to use Widget.grabFocus instead of this function.
setFocusOnMap void setFocusOnMap(bool setting): Windows may set a hint asking the desktop environment not to receive the input focus when the window is mapped. This function sets this hint.
setFocusVisible void setFocusVisible(bool setting): Sets the focus-visible property.
setGeometryHints void setGeometryHints(Widget geometryWidget, GdkGeometry* geometry, GdkWindowHints geomMask): This function sets up hints about how a window can be resized by the user. You can set a minimum and maximum size; allowed resize increments (e.g. for xterm, you can only resize by the size of a character); aspect ratios; and more. See the GdkGeometry struct.
setGravity void setGravity(GdkGravity gravity): Window gravity defines the meaning of coordinates passed to Window.move. See Window.move and GdkGravity for more details.
setHasResizeGrip void setHasResizeGrip(bool value): Sets whether window has a corner resize grip.
setHasUserRefCount void setHasUserRefCount(bool setting): Tells GTK+ whether to drop its extra reference to the window when Widget.destroy is called.
setHideTitlebarWhenMaximized void setHideTitlebarWhenMaximized(bool setting): If setting is TRUE, then window will request that it’s titlebar should be hidden when maximized. This is useful for windows that don’t convey any information other than the application name in the titlebar, to put the available screen space to better use. If the underlying window system does not support the request, the setting will not have any effect.
setIcon void setIcon(Pixbuf icon): Sets up the icon representing a gtk.Window This icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts. On others, the icon is not used at all, so your mileage may vary.
setIconFromFile bool setIconFromFile(string filename): Sets the icon for window. Warns on failure if err is NULL.
setIconList void setIconList(ListG list): Sets up the icon representing a gtk.Window The icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts. On others, the icon is not used at all, so your mileage may vary.
setIconName void setIconName(string name): Sets the icon for the window from a named themed icon. See the docs for gtk.IconTheme for more details. On some platforms, the window icon is not used at all.
setKeepAbove void setKeepAbove(bool setting): Asks to keep window above, so that it stays on top. Note that you shouldn’t assume the window is definitely above afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could not keep it above, and not all window managers support keeping windows above. But normally the window will end kept above. Just don’t write code that crashes if not.
setKeepBelow void setKeepBelow(bool setting): Asks to keep window below, so that it stays in bottom. Note that you shouldn’t assume the window is definitely below afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could not keep it below, and not all window managers support putting windows below. But normally the window will be kept below. Just don’t write code that crashes if not.
setMnemonicModifier void setMnemonicModifier(GdkModifierType modifier): Sets the mnemonic modifier for this window.
setMnemonicsVisible void setMnemonicsVisible(bool setting): Sets the mnemonics-visible property.
setModal void setModal(bool modal): Sets a window modal or non-modal. Modal windows prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use Window.setTransientFor to make the dialog transient for the parent; most [window managers][gtk-X11-arch] will then disallow lowering the dialog below the parent.
setOpacity void setOpacity(double opacity): Request the windowing system to make window partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Values of the opacity parameter are clamped to the [0,1] range.) On X11 this has any effect only on X screens with a compositing manager running. See Widget.isComposited. On Windows it should work always.
setPosition void setPosition(GtkWindowPosition position): Sets a position constraint for this window. If the old or new constraint is GTK_WIN_POS_CENTER_ALWAYS, this will also cause the window to be repositioned to satisfy the new constraint.
setResizable void setResizable(bool resizable): Sets whether the user can resize a window. Windows are user resizable by default.
setRole void setRole(string role): This function is only useful on X11, not with other GTK+ targets.
setScreen void setScreen(Screen screen): Sets the gdk.Screen where the window is displayed; if the window is already mapped, it will be unmapped, and then remapped on the new screen.
setSkipPagerHint void setSkipPagerHint(bool setting): Windows may set a hint asking the desktop environment not to display the window in the pager. This function sets this hint. (A "pager" is any desktop navigation tool such as a workspace switcher that displays a thumbnail representation of the windows on the screen.)
setSkipTaskbarHint void setSkipTaskbarHint(bool setting): Windows may set a hint asking the desktop environment not to display the window in the task bar. This function sets this hint.
setStartupId void setStartupId(string startupId): Startup notification identifiers are used by desktop environment to track application startup, to provide user feedback and other features. This function changes the corresponding property on the underlying GdkWindow. Normally, startup identifier is managed automatically and you should only use this function in special cases like transferring focus from other processes. You should use this function before calling Window.present or any equivalent function generating a window map event.
setTitle void setTitle(string title): Sets the title of the gtk.Window The title of a window will be displayed in its title bar; on the X Window System, the title bar is rendered by the [window manager][gtk-X11-arch], so exactly how the title appears to users may vary according to a user’s exact configuration. The title should help a user distinguish this window from other windows they may have open. A good title might include the application name and current document filename, for example.
setTitlebar void setTitlebar(Widget titlebar): Sets a custom titlebar for window.
setTransientFor void setTransientFor(Window parent): Dialog windows should be set transient for the main application window they were spawned from. This allows [window managers][gtk-X11-arch] to e.g. keep the dialog on top of the main window, or center the dialog over the main window. Dialog.newWithButtons and other convenience functions in GTK+ will sometimes call Window.setTransientFor on your behalf.
setTypeHint void setTypeHint(GdkWindowTypeHint hint): By setting the type hint for the window, you allow the window manager to decorate and handle the window in a way which is suitable to the function of the window in your application.
setUrgencyHint void setUrgencyHint(bool setting): Windows may set a hint asking the desktop environment to draw the users attention to the window. This function sets this hint.
setWmclass void setWmclass(string wmclassName, string wmclassClass): Don’t use this function. It sets the X Window System “class” and “name” hints for a window. According to the ICCCM, you should always set these to the same value for all windows in an application, and GTK+ sets them to that value by default, so calling this function is sort of pointless. However, you may want to call Window.setRole on each window in your application, for the benefit of the session manager. Setting the role allows the window manager to restore window positions when loading a saved session.
stick void stick(): Asks to stick window, which means that it will appear on all user desktops. Note that you shouldn’t assume the window is definitely stuck afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch] could unstick it again, and some window managers do not support sticking windows. But normally the window will end up stuck. Just don't write code that crashes if not.
unfullscreen void unfullscreen(): Asks to toggle off the fullscreen state for window. Note that you shouldn’t assume the window is definitely not full screen afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could fullscreen it again, and not all window managers honor requests to unfullscreen windows. But normally the window will end up restored to its normal state. Just don’t write code that crashes if not.
unmaximize void unmaximize(): Asks to unmaximize window. Note that you shouldn’t assume the window is definitely unmaximized afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could maximize it again, and not all window managers honor requests to unmaximize. But normally the window will end up unmaximized. Just don’t write code that crashes if not.
unstick void unstick(): Asks to unstick window, which means that it will appear on only one of the user’s desktops. Note that you shouldn’t assume the window is definitely unstuck afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could stick it again. But normally the window will end up stuck. Just don’t write code that crashes if not.
addOnActivateDefault gulong addOnActivateDefault(void delegate(Window) dlg, ConnectFlags connectFlags): The ::activate-default signal is a [keybinding signal]GtkBindingSignal which gets emitted when the user activates the default widget of window.
addOnActivateFocus gulong addOnActivateFocus(void delegate(Window) dlg, ConnectFlags connectFlags): The ::activate-focus signal is a [keybinding signal]GtkBindingSignal which gets emitted when the user activates the currently focused widget of window.
addOnEnableDebugging gulong addOnEnableDebugging(bool delegate(bool, Window) dlg, ConnectFlags connectFlags): The ::enable-debugging signal is a [keybinding signal]GtkBindingSignal which gets emitted when the user enables or disables interactive debugging. When toggle is TRUE, interactive debugging is toggled on or off, when it is FALSE, the debugger will be pointed at the widget under the pointer.
addOnKeysChanged gulong addOnKeysChanged(void delegate(Window) dlg, ConnectFlags connectFlags): The ::keys-changed signal gets emitted when the set of accelerators or mnemonics that are associated with window changes.
addOnSetFocus gulong addOnSetFocus(void delegate(Widget, Window) dlg, ConnectFlags connectFlags)
showUriOnWindow bool showUriOnWindow(Window parent, string uri, uint timestamp): This is a convenience function for launching the default application to show the uri. The uri must be of a form understood by GIO (i.e. you need to install gvfs to get support for uri schemes such as http:// or ftp://, as only local files are handled by GIO itself). Typical examples are - file:///home/gnome/pict.jpg - http://www.gnome.org - mailto:megnome.org

gtk Dialog classes

Dialog