Module: Win::Gui::Dialog

Extended by:
Library
Includes:
Window
Included in:
Win::Gui
Defined in:
lib/win/gui/dialog.rb

Overview

Contains constants and Win32 API functions related to dialog manipulation. Windows dialog basics can be found here: msdn.microsoft.com/en-us/library/ms644996#init_box

Constant Summary collapse

MB_OK =

The message box contains one push button: OK. This is the default.

0x00000000
MB_OKCANCEL =

The message box contains two push buttons: OK and Cancel.

0x00000001
MB_ABORTRETRYIGNORE =

The message box contains three push buttons: Abort, Retry, and Ignore (considered obsolete)

0x00000002
MB_YESNOCANCEL =

The message box contains three push buttons: Yes, No, and Cancel.

0x00000003
MB_YESNO =

The message box contains two push buttons: Yes and No.

0x00000004
MB_RETRYCANCEL =

The message box contains two push buttons: Retry and Cancel.

0x00000005
MB_CANCELTRYCONTINUE =

The message box contains three push buttons: Cancel, Try Again, Continue (Win 2000/XP). Use this message box type instead of MB_ABORTRETRYIGNORE.

0x00000006
MB_ICONHAND =

A stop-sign icon appears in the message box.

0x00000010
MB_ICONQUESTION =

A question-mark icon appears in the message box. The question-mark message icon is no longer recommended because it does not clearly represent a specific type of message and because the phrasing of a message as a question could apply to any message type. In addition, users can confuse the message symbol question mark with Help information. Therefore, do not use this question mark message symbol in your message boxes. The system continues to support its inclusion only for backward compatibility.

0x00000020
MB_ICONEXCLAMATION =

An exclamation-point icon appears in the message box.

0x00000030
MB_ICONASTERISK =

An icon consisting of a lowercase letter i in a circle appears in the message box.

0x00000040
MB_USERICON = 
0x00000080
MB_ICONWARNING =

An exclamation-point icon appears in the message box.

MB_ICONEXCLAMATION
MB_ICONERROR =

A stop-sign icon appears in the message box.

MB_ICONHAND
MB_ICONINFORMATION =

An icon consisting of a lowercase letter i in a circle appears in the message box.

MB_ICONASTERISK
MB_ICONSTOP =

A stop-sign icon appears in the message box.

MB_ICONHAND
MB_DEFBUTTON1 =

The first button is the default button. MB_DEFBUTTON1 is the default unless MB_DEFBUTTON2, MB_DEFBUTTON3, or MB_DEFBUTTON4 is specified.

0x00000000
MB_DEFBUTTON2 =

The second button is the default button.

0x00000100
MB_DEFBUTTON3 =

The 3rd button is the default button.

0x00000200
MB_DEFBUTTON4 =

The 4th button is the default button.

0x00000300
MB_APPLMODAL =

The user must respond to the message box before continuing work in the window identified by the hWnd parameter. However, the user can move to the windows of other threads and work in those windows. Depending on the hierarchy of windows in the App, the user may be able to move to other windows within the thread. All child windows of the parent of the message box are automatically disabled, but pop-up windows are not. MB_APPLMODAL is the default if neither MB_SYSTEMMODAL nor MB_TASKMODAL is specified.

0x00000000
MB_SYSTEMMODAL =

Same as MB_APPLMODAL except that the message box has the WS_EX_TOPMOST style. Use system-modal message boxes to notify the user of serious, potentially damaging errors that require immediate attention (for example, running out of memory). This flag has no effect on the user’s ability to interact with windows other than those associated with hWnd.

0x00001000
MB_TASKMODAL =

Same as MB_APPLMODAL except that all the top-level windows belonging to the current thread are disabled if the hWnd parameter is NULL. Use this flag when the calling App or library does not have a window handle available but still needs to prevent input to other windows in the calling thread without suspending other threads.

0x00002000
MB_HELP =

Adds a Help button to the message box. When the user clicks the Help button or presses F1, the system sends a WM_HELP message to the owner.

0x00004000
MB_NOFOCUS = 
0x00008000
MB_SETFOREGROUND =

The message box becomes the foreground window. Internally, the system calls the SetForegroundWindow function for the message box.

0x00010000
MB_DEFAULT_DESKTOP_ONLY =

Windows NT/2000/XP: Same as desktop of the interactive window station. For more information, see Window Stations. Windows NT 4.0 and earlier: If the current input desktop is not the default desktop, MessageBox fails. Windows 2000/XP: If the current input desktop is not the default desktop, MessageBox does not return until the user switches to the default desktop. Windows 95/98/Me: This flag has no effect.

0x00020000
MB_TOPMOST =

The message box is created with the WS_EX_TOPMOST window style.

0x00040000
MB_RIGHT =

The text is right-justified.

0x00080000
MB_RTLREADING =

Displays message and caption text using right-to-left reading order on Hebrew and Arabic systems.

0x00100000
MB_SERVICE_NOTIFICATION =

Assume Win2k or later Windows NT/2000/XP: The caller is a service notifying the user of an event. The function displays a message box on the current active desktop, even if there is no user logged on to the computer. Terminal Services: If the calling thread has an impersonation token, the function directs the message box to the session specified in the impersonation token. If this flag is set, the hWnd parameter must be NULL. This is so that the message box can appear on a desktop other than the desktop corresponding to the hWnd. For more information on the changes between Microsoft Windows NT 3.51 and Windows NT 4.0, see Remarks. For information on security considerations in regard to using this flag, see Interactive Services.

0x00200000
MB_SERVICE_NOTIFICATION_NT3X =

Windows NT/2000/XP: This value corresponds to the value defined for MB_SERVICE_NOTIFICATION for Windows NT version 3.51.

0x00040000
MB_TYPEMASK = 
0x0000000F
MB_ICONMASK = 
0x000000F0
MB_DEFMASK = 
0x00000F00
MB_MODEMASK = 
0x00003000
MB_MISCMASK = 
0x0000C000
IDOK =

These are returned as user input from modal dialog:

0x01
IDCANCEL =

The OK button was selected.

0x02
IDABORT =

The Cancel button was selected.

0x03
IDRETRY =

The Abort button was selected.

0x04
IDIGNORE =

The Retry button was selected.

0x05
IDYES =

The Ignore button was selected.

0x06
IDNO =

The YES button was selected.

0x07
IDTRYAGAIN =

The NO button was selected.

0x10
IDCONTINUE =

The Try Again button was selected.

0x11
ErrorIcon =

These are not returned, their presence helps to programmatically identify type of present dialog:

0x14

Constants included from Library

Library::TYPES

Constants included from Window

Window::GA_PARENT, Window::GA_ROOT, Window::GA_ROOTOWNER, Window::GW_CHILD, Window::GW_ENABLEDPOPUP, Window::GW_HWNDFIRST, Window::GW_HWNDLAST, Window::GW_HWNDNEXT, Window::GW_HWNDPREV, Window::GW_OWNER, Window::SW_FORCEMINIMIZE, Window::SW_HIDE, Window::SW_MAXIMIZE, Window::SW_MINIMIZE, Window::SW_NORMAL, Window::SW_RESTORE, Window::SW_SHOW, Window::SW_SHOWDEFAULT, Window::SW_SHOWMAXIMIZED, Window::SW_SHOWMINIMIZED, Window::SW_SHOWMINNOACTIVE, Window::SW_SHOWNA, Window::SW_SHOWNOACTIVATE, Window::SW_SHOWNORMAL

Instance Method Summary collapse

Methods included from Library

callback, define_api, define_snake_method, enforce_count, extended, function, generate_names, generate_signature, generate_snake_method_body, try_function

Methods included from Window

#foreground?, #hide_window, return_enum, return_string, #shut_window, #text

Instance Method Details

#CreateDialog(hInstance, lpName, hParent, lpDialogFunc) ⇒ Object

Macros from WinUser.h



370
371
372
 
# File 'lib/win/gui/dialog.rb', line 370

def CreateDialog(hInstance, lpName, hParent, lpDialogFunc)
   CreateDialogParam(hInstance, lpName, hParent, lpDialogFunc, 0)
end

#CreateDialogIndirect(hInst, lpTemp, hPar, lpDialFunc) ⇒ Object 



374
375
376
 
# File 'lib/win/gui/dialog.rb', line 374

def CreateDialogIndirect(hInst, lpTemp, hPar, lpDialFunc)
   CreateDialogIndirectParam(hInst, lpTemp, hPar, lpDialFunc, 0)
end

#DialogBox(hInstance, lpTemp, hParent, lpDialogFunc) ⇒ Object 



378
379
380
 
# File 'lib/win/gui/dialog.rb', line 378

def DialogBox(hInstance, lpTemp, hParent, lpDialogFunc)
   DialogBoxParam(hInstance, lpTemp, hParent, lpDialogFunc, 0)
end

#DialogBoxIndirect(hInst, lpTemp, hParent, lpDialogFunc) ⇒ Object 



382
383
384
 
# File 'lib/win/gui/dialog.rb', line 382

def DialogBoxIndirect(hInst, lpTemp, hParent, lpDialogFunc)
   DialogBoxParamIndirect(hInst, lpTemp, hParent, lpDialogFunc, 0)
end