IupDialog
Creates a dialog element. It manages user interaction with the interface elements. For any interface element to be shown, it must be encapsulated in a dialog.
Creation
Ihandle* IupDialog(Ihandle *child); [in C]
iup.dialog{child: ihandle} -> (elem: ihandle) [in Lua]
dialog(child) [in LED]
child: Identifier of an interface element. The dialog has only one child.
Returns the identifier of the created dialog, or NULL if an error occurs.
Attributes
Common
CURSOR: Defines a cursor for the dialog.
VISIBLE: Simply call IupShow or IupHide for the dialog.
TITLE: Dialog’s title.
BGCOLOR: Dialogs background color.
BORDER: (Creation Only) Shows a border around the dialog. Default: "YES".
BORDER=NO is usefull only when RESIZE=NO, MAXBOX=NO, MINBOX=NO, MENUBOX=NO and TITLE=NULL, if any of these are defined there will be always some border.
SIZE: Dialog’s size.
Additionally the following values can also be defined for width and/or height:
- "FULL": Defines the dialog’s width (or height) equal to the screen's width (or height)
- "HALF": Defines the dialog’s width (or height) equal to half the screen's width (or height)
- "THIRD": Defines the dialog’s width (or height) equal to 1/3 the screen's width (or height)
- "QUARTER": Defines the dialog’s width (or height) equal to 1/4 of the screen's width (or height)
- "EIGHTH": Defines the dialog’s width (or height) equal to 1/8 of the screen's width (or height)
Default: the smallest size that allows viewing all the elements inside the dialog.
The dialog’s size has precedence over the smallest size required by its children (either if it was specified in its creation or in run-time). Attributing a NULL value to SIZE or RASTERSIZE in a dialog will return to the default.
ACTIVE, FONT, EXPAND, X, Y, WID, TIP, CLIENTSIZE, RASTERSIZE, ZORDER: also accepted. Note that ACTIVE, BGCOLOR, EXPAND and FONT will also affect all the controls inside the dialog.
Exclusive
ICON: Dialog’s icon.
MAXBOX: (Creation Only) Requires a maximize button from the window manager. If RESIZE=NO then MAXBOX will be set to NO. Default: YES. See comments about Motif in Notes bellow. In Windows MAXBOX is hidden only if MINBOX is hidden as well, or else it will be just disabled.
MENU: Associates a menu to the dialog.
MENUBOX: (Creation Only) Requires a menu box from the window manager. If hidden will also remove the Close button. Default: YES. See comments about Motif in Notes bellow. In Windows if hidden will hide also MAXBOX and MINBOX.
MINBOX: (Creation Only) Requires a minimize button from the window manager. Default: YES. See comments about Motif in Notes bellow. In Windows MINBOX is hidden only if MAXBOX is hidden as well, or else it will be just disabled.
RESIZE: (Creation Only) Allows interactively changing the dialog’s size. Default: YES. See comments about Motif in Notes bellow.
DIALOGFRAME: Set the common decorations for modal dialogs. This means RESIZE=NO, MINBOX=NO and MAXBOX=NO. In Windows, if the PARENTDIALOG is defined then the MENUBOX is also removed, but the Close button remains.
STARTFOCUS: Name of the dialog element that must receive the focus right after the dialog is opened.
DEFAULTENTER: Name of the button activated when Enter is hit.
DEFAULTESC: Name of the button activated when Esc is hit.
SHRINK: Allows changing the elements’ distribution when the dialog is smaller than the minimum size. Default: NO.
PARENTDIALOG: (Creation Only) Name of a dialog to be used as parent. This dialog will be always in front of the parent dialog.
IMPORTANT: When the parent is destroyed the child dialog is also destroyed, then the CLOSE_CB callback of the child dialog is NOT called. The application must take care of destroying the children dialogs before destroying the parent. This is usually done when CLOSE_CB of the parent dialog is called.
MODAL: (read-only) Returns the popup state. It is "YES" if the dialog was shown using IupPopup. It is "NO" if IupShow was used or it is not visible.
MINSIZE: Minimum size for the dialog in raster units (pixels). The windowing system will not be able to change the size beyond this limit. Default: 1x1.
MAXSIZE: Maximum size for the dialog in raster units (pixels). The windowing system will not be able to change the size beyond this limit. Default: 65535x65535.
FULLSCREEN: Makes the dialog occupy the whole screen.
All
dialog details, such as title bar, borders, maximize button, etc, are removed. Possible values: YES, NO. In Motif
you may have to click in the dialog to set its focus.
In Motif if set to YES when the dialog is hidden, then it can not be changed after it is visible.
SAVEUNDER: [Windows and Motif Only] (Creation Only)
When this attribute is true (YES), the dialog stores the original image of the desktop region it occupies (if the system has enough memory to store the image). In this case, when the dialog is closed or moved, a redrawing event is not generated for the windows that were shadowed by it. Its default value is YES. To save memory disable it for your main dialog. Not available in GTK (in fact all the controls in GTK are double buffered to speed up redraw).
PLACEMENT: (Used during IupShow Only)
Changes how the dialog will be shown. Values: "FULL", "MAXIMIZED", "MINIMIZED" and "NORMAL". Default: NORMAL. After IupShow the attribute is set back to "NORMAL". FULL is similar to FULLSCREEN but only the dialog client area covers the screen area, menu and decorations will be there but out of the screen. Not used in IupPopup. In UNIX there is a chance that the placement won't work correctly, that depends on the Window Manager.
Exclusive [Windows Only]
TOPMOST: [Windows Only] This attribute puts the dialog always in front of all other dialogs in all applications. Default: NO.
TOOLBOX: [Windows Only] (Creation Only): This attribute makes the dialog look like a toolbar. It is only valid if the PARENTDIALOG or NATIVEPARENT attribute is also defined. Default: NO.
CLIPCHILDREN: [Windows Only] (Creation Only)
When option YES is selected, the area occupied by the children in the dialog is not redrawn, thus preventing the children from blinking when a resize is made. Usually this brings better performance, but in some cases it may bring a performance reduction, as every time the dialog needs to be redrawn all children are redrawn as well. Default: YES.
BRINGFRONT: [Windows Only] (write-only)
This attribute makes the dialog the foreground window. Use "YES" to activate it. Useful for multithreaded applications.
COMPOSITED: [Windows XP Only] (Creation Only)
This attribute controls if the window will have an automatic double buffer for all controls. Default is "NO".
LAYERED: [Windows Only]
This attribute sets and removes the layered style bit. Use "YES" to activate it. Default is "NO". The LAYERALPHA attribute must also be set, just after this one.
LAYERALPHA: [Windows Only]
This attribute sets the dialog transparency alpha value. The dialog must have LAYERED=YES. Valid values range from 0 (completely transparent) to 255 (opaque).
NATIVEPARENT: [Windows Only] (Creation Only)
Makes any window created in the system (even from outside IUP) able to be parent of a IUP dialog. The value provided should be a valid window handle (HWND.)
HELPBUTTON: [Windows Only] (Creation Only)
Inserts a help button in the same place of the maximize button. It can only be used for dialogs without the minimize and maximize buttons, and with the menu box. For the next interaction of the user with a control in the dialog, the callback HELP_CB will be called instead of the control defined ACTION callback. Possible values: YES, NO. Default: NO.
TRAY: [Windows Only] When set to "YES", displays an icon on the system tray.
TRAYIMAGE: [Windows Only] System tray icon
TRAYTIP: [Windows Only] Tray icon's tooltip text
HIDETASKBAR: [Windows Only] (write-only)
When set to "YES", hides the dialog from the task bar. Must be used with TRAYICON attribute.
CONTROL: [Windows Only] Embeds the dialog inside another window. Creation-only attribute.
MDIMENU: [Windows Only] Name of a IupSubmenu to be used as the Window list of a MDI frame window. The system will automatically add the list of MDI child windows there. Used in the IupDialog configured as a MDI frame. This dialog must contains one IupCanvas configured with MDICLIENT=YES.
MDICHILD: [Windows Only] Configure this dialog to be a MDI child window. The MDICLIENT attribute must also be set. Each MDI child is automatically named (IupSetHandle) to "mdichild%d", where "%d" is a sequencial number.
MDICLIENT: [Windows Only] Name of the IupCanvas used as MDI client window. The MDI frame window must have one and only one MDI client window.
MDIARRANGE: [Windows Only] (write-only): Action to arrange MDI child windows. Possible values: TILEHORIZONTAL, TILEVERTICAL, CASCADE and ICON (arrange the minimized icons).
MDIACTIVATE: [Windows Only] (write-only): Name of a MDI child window to be activated. If value is "NEXT" will activate the next window after the current active window. If value is "PREVIOUS" will activate the previous one.
MDIACTIVE: [Windows Only] (read-only): Returns the the name of the current active MDI child.
MDINEXT: [Windows Only] (read-only): Returns the name of the next available MDI child. Must use MDIACTIVE to retrieve the first child. If the application is going to destroy the child retreive the next child before destroying the current.
MDICLOSEALL: [Windows Only] (write-only): Action to close and destroy all MDI child windows. The CLOSE_CB callback will be called for each child.
IMPORTANT: When a MDI child window is closed it is automatically destroyed. The application can override this returning IUP_IGNORE in CLOSE_CB.
Callbacks
GETFOCUS_CB, KILLFOCUS_CB, ENTERWINDOW_CB, LEAVEWINDOW_CB, K_ANY, HELP_CB: All common callback are supported.
SHOW_CB: Called right after the dialog is opened, minimized or restored from a minimization.
MAP_CB: Called right after the element is mapped.
CLOSE_CB: Called right before the dialog is closed.
DROPFILES_CB: [Windows Only] Action generated when one or more files are dropped from the Windows Explorer in the dialog.
RESIZE_CB: Action generated when the dialog size is changed.
TRAYCLICK_CB: [Windows Only] Called right after the mouse button is pressed or released over the tray icon.
int function(Ihandle *ih, int but, int pressed, int dclick); [in C]
elem:trayclick_cb(but, pressed, dclick: number) -> (ret: number) [in Lua]
but: identifies the activated mouse button.
Can be: 1, 2 or 3. Note that this is different from the BUTTON_CB canvas callback definition.
pressed:
indicates the state of the button.
dclick:
indicates a double click.
Returning CLOSE closes the dialog.
MDIACTIVATE_CB: [Windows Only] Called when a MDI child window is activated. Only the MDI child receive this message. It is not called when the child is shown for the first time.
int function(Ihandle *ih); [in C]
elem:mdiactivate_cb() -> (ret: number) [in Lua]
Notes
Do not associate an IupDialog with the native "dialog" nomenclature in Windows, GTK or Motif. IupDialog use native standard windows in all drivers.
Except for the menu, all other elements must be inside a dialog to interact with the user. Therefore, an interface element will only be visible if its dialog is also visible.
Values attributed to the SIZE attribute of a dialog are always accepted, regardless of the minimum size required by its children. For a dialog to have the minimum necessary size to fit all elements contained in it, simply define NULL (in C) to SIZE. In the case of partial dimensions, a specified dimension is always used, while a non-defined dimension uses the smallest necessary size for the elements in the corresponding direction. See the SIZE attribute for further details.
In Motif the decorations ICON, MENUBOX, MINBOX, MAXBOX, RESIZE and BORDER are controled by the Window Manager and may not be possible to be changed from IUP.
The MDI support is composed of 3 components: the MDI frame window (IupDialog), the MDI client window (IupCanvas) and the MDI children (IupDialog). Altough the MDI client is a IupCanvas it is not used directly by the application, but it must be created and included in the dialog that will be the MDI frame, other controls can also be available in the same dialog, like buttons and other canvases composing toolbars and status area. The following picture illustrates the e components:
Examples
Very simple dialog with a label and a button. The application is closed when the button is pressed.
#include <iup.h>
int quit_cb(void)
{
return IUP_CLOSE;
}
int main(int argc, char* argv[])
{
Ihandle *dialog, *quit_bt, *vbox;
IupOpen(&argc, &argv);
/* Creating the button */
quit_bt = IupButton("Quit", 0);
IupSetCallback(quit_bt, "ACTION", (Icallback)quit_cb);
/* the container with a label and the button */
vbox = IupVbox(
IupSetAttributes(IupLabel("Very Long Text Label"), "EXPAND=YES, ALIGNMENT=ACENTER"),
quit_bt,
0);
IupSetAttribute(vbox, "MARGIN", "10x10");
IupSetAttribute(vbox, "GAP", "5");
/* Creating the dialog */
dialog = IupDialog(vbox);
IupSetAttribute(dialog, "TITLE", "Dialog Title");
IupSetAttributeHandle(dialog, "DEFAULTESC", quit_bt);
IupShow(dialog);
IupMainLoop();
IupDestroy(dialog);
IupClose();
return 0;
}
Other: Browse Example Files