SDL  2.0
SDL_windowstaskdialog.h File Reference
#include <pshpack1.h>
#include <poppack.h>
+ Include dependency graph for SDL_windowstaskdialog.h:

Go to the source code of this file.

Data Structures

struct  TASKDIALOG_BUTTON
 
struct  TASKDIALOGCONFIG
 

Macros

#define TD_WARNING_ICON   MAKEINTRESOURCEW(-1)
 
#define TD_ERROR_ICON   MAKEINTRESOURCEW(-2)
 
#define TD_INFORMATION_ICON   MAKEINTRESOURCEW(-3)
 
#define TD_SHIELD_ICON   MAKEINTRESOURCEW(-4)
 

Typedefs

typedef HRESULT(CALLBACK * PFTASKDIALOGCALLBACK) (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam, LONG_PTR lpRefData)
 
typedef int TASKDIALOG_FLAGS
 
typedef int TASKDIALOG_COMMON_BUTTON_FLAGS
 

Enumerations

enum  _TASKDIALOG_FLAGS {
  TDF_ENABLE_HYPERLINKS = 0x0001,
  TDF_USE_HICON_MAIN = 0x0002,
  TDF_USE_HICON_FOOTER = 0x0004,
  TDF_ALLOW_DIALOG_CANCELLATION = 0x0008,
  TDF_USE_COMMAND_LINKS = 0x0010,
  TDF_USE_COMMAND_LINKS_NO_ICON = 0x0020,
  TDF_EXPAND_FOOTER_AREA = 0x0040,
  TDF_EXPANDED_BY_DEFAULT = 0x0080,
  TDF_VERIFICATION_FLAG_CHECKED = 0x0100,
  TDF_SHOW_PROGRESS_BAR = 0x0200,
  TDF_SHOW_MARQUEE_PROGRESS_BAR = 0x0400,
  TDF_CALLBACK_TIMER = 0x0800,
  TDF_POSITION_RELATIVE_TO_WINDOW = 0x1000,
  TDF_RTL_LAYOUT = 0x2000,
  TDF_NO_DEFAULT_RADIO_BUTTON = 0x4000,
  TDF_CAN_BE_MINIMIZED = 0x8000,
  TDF_NO_SET_FOREGROUND = 0x00010000,
  TDF_SIZE_TO_CONTENT = 0x01000000
}
 
enum  TASKDIALOG_MESSAGES {
  TDM_NAVIGATE_PAGE = WM_USER + 101,
  TDM_CLICK_BUTTON = WM_USER + 102,
  TDM_SET_MARQUEE_PROGRESS_BAR = WM_USER + 103,
  TDM_SET_PROGRESS_BAR_STATE = WM_USER + 104,
  TDM_SET_PROGRESS_BAR_RANGE = WM_USER + 105,
  TDM_SET_PROGRESS_BAR_POS = WM_USER + 106,
  TDM_SET_PROGRESS_BAR_MARQUEE = WM_USER + 107,
  TDM_SET_ELEMENT_TEXT = WM_USER + 108,
  TDM_CLICK_RADIO_BUTTON = WM_USER + 110,
  TDM_ENABLE_BUTTON = WM_USER + 111,
  TDM_ENABLE_RADIO_BUTTON = WM_USER + 112,
  TDM_CLICK_VERIFICATION = WM_USER + 113,
  TDM_UPDATE_ELEMENT_TEXT = WM_USER + 114,
  TDM_SET_BUTTON_ELEVATION_REQUIRED_STATE = WM_USER + 115,
  TDM_UPDATE_ICON = WM_USER + 116
}
 
enum  TASKDIALOG_NOTIFICATIONS {
  TDN_CREATED = 0,
  TDN_NAVIGATED = 1,
  TDN_BUTTON_CLICKED = 2,
  TDN_HYPERLINK_CLICKED = 3,
  TDN_TIMER = 4,
  TDN_DESTROYED = 5,
  TDN_RADIO_BUTTON_CLICKED = 6,
  TDN_DIALOG_CONSTRUCTED = 7,
  TDN_VERIFICATION_CLICKED = 8,
  TDN_HELP = 9,
  TDN_EXPANDO_BUTTON_CLICKED = 10
}
 
enum  TASKDIALOG_ELEMENTS {
  TDE_CONTENT,
  TDE_EXPANDED_INFORMATION,
  TDE_FOOTER,
  TDE_MAIN_INSTRUCTION
}
 
enum  TASKDIALOG_ICON_ELEMENTS {
  TDIE_ICON_MAIN,
  TDIE_ICON_FOOTER
}
 
enum  _TASKDIALOG_COMMON_BUTTON_FLAGS {
  TDCBF_OK_BUTTON = 0x0001,
  TDCBF_YES_BUTTON = 0x0002,
  TDCBF_NO_BUTTON = 0x0004,
  TDCBF_CANCEL_BUTTON = 0x0008,
  TDCBF_RETRY_BUTTON = 0x0010,
  TDCBF_CLOSE_BUTTON = 0x0020
}
 

Macro Definition Documentation

◆ TD_ERROR_ICON

#define TD_ERROR_ICON   MAKEINTRESOURCEW(-2)

Definition at line 105 of file SDL_windowstaskdialog.h.

◆ TD_INFORMATION_ICON

#define TD_INFORMATION_ICON   MAKEINTRESOURCEW(-3)

Definition at line 106 of file SDL_windowstaskdialog.h.

◆ TD_SHIELD_ICON

#define TD_SHIELD_ICON   MAKEINTRESOURCEW(-4)

Definition at line 107 of file SDL_windowstaskdialog.h.

◆ TD_WARNING_ICON

#define TD_WARNING_ICON   MAKEINTRESOURCEW(-1)

Definition at line 104 of file SDL_windowstaskdialog.h.

Typedef Documentation

◆ PFTASKDIALOGCALLBACK

typedef HRESULT(CALLBACK * PFTASKDIALOGCALLBACK) (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam, LONG_PTR lpRefData)

Definition at line 23 of file SDL_windowstaskdialog.h.

◆ TASKDIALOG_COMMON_BUTTON_FLAGS

Definition at line 118 of file SDL_windowstaskdialog.h.

◆ TASKDIALOG_FLAGS

typedef int TASKDIALOG_FLAGS

Definition at line 48 of file SDL_windowstaskdialog.h.

Enumeration Type Documentation

◆ _TASKDIALOG_COMMON_BUTTON_FLAGS

Enumerator
TDCBF_OK_BUTTON 
TDCBF_YES_BUTTON 
TDCBF_NO_BUTTON 
TDCBF_CANCEL_BUTTON 
TDCBF_RETRY_BUTTON 
TDCBF_CLOSE_BUTTON 

Definition at line 109 of file SDL_windowstaskdialog.h.

110 {
111  TDCBF_OK_BUTTON = 0x0001, // selected control return value IDOK
112  TDCBF_YES_BUTTON = 0x0002, // selected control return value IDYES
113  TDCBF_NO_BUTTON = 0x0004, // selected control return value IDNO
114  TDCBF_CANCEL_BUTTON = 0x0008, // selected control return value IDCANCEL
115  TDCBF_RETRY_BUTTON = 0x0010, // selected control return value IDRETRY
116  TDCBF_CLOSE_BUTTON = 0x0020 // selected control return value IDCLOSE
117 };

◆ _TASKDIALOG_FLAGS

Enumerator
TDF_ENABLE_HYPERLINKS 
TDF_USE_HICON_MAIN 
TDF_USE_HICON_FOOTER 
TDF_ALLOW_DIALOG_CANCELLATION 
TDF_USE_COMMAND_LINKS 
TDF_USE_COMMAND_LINKS_NO_ICON 
TDF_EXPAND_FOOTER_AREA 
TDF_EXPANDED_BY_DEFAULT 
TDF_VERIFICATION_FLAG_CHECKED 
TDF_SHOW_PROGRESS_BAR 
TDF_SHOW_MARQUEE_PROGRESS_BAR 
TDF_CALLBACK_TIMER 
TDF_POSITION_RELATIVE_TO_WINDOW 
TDF_RTL_LAYOUT 
TDF_NO_DEFAULT_RADIO_BUTTON 
TDF_CAN_BE_MINIMIZED 
TDF_NO_SET_FOREGROUND 
TDF_SIZE_TO_CONTENT 

Definition at line 25 of file SDL_windowstaskdialog.h.

26 {
27  TDF_ENABLE_HYPERLINKS = 0x0001,
28  TDF_USE_HICON_MAIN = 0x0002,
29  TDF_USE_HICON_FOOTER = 0x0004,
31  TDF_USE_COMMAND_LINKS = 0x0010,
33  TDF_EXPAND_FOOTER_AREA = 0x0040,
34  TDF_EXPANDED_BY_DEFAULT = 0x0080,
36  TDF_SHOW_PROGRESS_BAR = 0x0200,
38  TDF_CALLBACK_TIMER = 0x0800,
40  TDF_RTL_LAYOUT = 0x2000,
42  TDF_CAN_BE_MINIMIZED = 0x8000,
43  //#if (NTDDI_VERSION >= NTDDI_WIN8)
44  TDF_NO_SET_FOREGROUND = 0x00010000, // Don't call SetForegroundWindow() when activating the dialog
45  //#endif // (NTDDI_VERSION >= NTDDI_WIN8)
46  TDF_SIZE_TO_CONTENT = 0x01000000 // used by ShellMessageBox to emulate MessageBox sizing behavior
47 };

◆ TASKDIALOG_ELEMENTS

Enumerator
TDE_CONTENT 
TDE_EXPANDED_INFORMATION 
TDE_FOOTER 
TDE_MAIN_INSTRUCTION 

Definition at line 90 of file SDL_windowstaskdialog.h.

◆ TASKDIALOG_ICON_ELEMENTS

Enumerator
TDIE_ICON_MAIN 
TDIE_ICON_FOOTER 

Definition at line 98 of file SDL_windowstaskdialog.h.

◆ TASKDIALOG_MESSAGES

Enumerator
TDM_NAVIGATE_PAGE 
TDM_CLICK_BUTTON 
TDM_SET_MARQUEE_PROGRESS_BAR 
TDM_SET_PROGRESS_BAR_STATE 
TDM_SET_PROGRESS_BAR_RANGE 
TDM_SET_PROGRESS_BAR_POS 
TDM_SET_PROGRESS_BAR_MARQUEE 
TDM_SET_ELEMENT_TEXT 
TDM_CLICK_RADIO_BUTTON 
TDM_ENABLE_BUTTON 
TDM_ENABLE_RADIO_BUTTON 
TDM_CLICK_VERIFICATION 
TDM_UPDATE_ELEMENT_TEXT 
TDM_SET_BUTTON_ELEVATION_REQUIRED_STATE 
TDM_UPDATE_ICON 

Definition at line 50 of file SDL_windowstaskdialog.h.

51 {
52  TDM_NAVIGATE_PAGE = WM_USER + 101,
53  TDM_CLICK_BUTTON = WM_USER + 102, // wParam = Button ID
54  TDM_SET_MARQUEE_PROGRESS_BAR = WM_USER + 103, // wParam = 0 (nonMarque) wParam != 0 (Marquee)
55  TDM_SET_PROGRESS_BAR_STATE = WM_USER + 104, // wParam = new progress state
56  TDM_SET_PROGRESS_BAR_RANGE = WM_USER + 105, // lParam = MAKELPARAM(nMinRange, nMaxRange)
57  TDM_SET_PROGRESS_BAR_POS = WM_USER + 106, // wParam = new position
58  TDM_SET_PROGRESS_BAR_MARQUEE = WM_USER + 107, // wParam = 0 (stop marquee), wParam != 0 (start marquee), lparam = speed (milliseconds between repaints)
59  TDM_SET_ELEMENT_TEXT = WM_USER + 108, // wParam = element (TASKDIALOG_ELEMENTS), lParam = new element text (LPCWSTR)
60  TDM_CLICK_RADIO_BUTTON = WM_USER + 110, // wParam = Radio Button ID
61  TDM_ENABLE_BUTTON = WM_USER + 111, // lParam = 0 (disable), lParam != 0 (enable), wParam = Button ID
62  TDM_ENABLE_RADIO_BUTTON = WM_USER + 112, // lParam = 0 (disable), lParam != 0 (enable), wParam = Radio Button ID
63  TDM_CLICK_VERIFICATION = WM_USER + 113, // wParam = 0 (unchecked), 1 (checked), lParam = 1 (set key focus)
64  TDM_UPDATE_ELEMENT_TEXT = WM_USER + 114, // wParam = element (TASKDIALOG_ELEMENTS), lParam = new element text (LPCWSTR)
65  TDM_SET_BUTTON_ELEVATION_REQUIRED_STATE = WM_USER + 115, // wParam = Button ID, lParam = 0 (elevation not required), lParam != 0 (elevation required)
66  TDM_UPDATE_ICON = WM_USER + 116 // wParam = icon element (TASKDIALOG_ICON_ELEMENTS), lParam = new icon (hIcon if TDF_USE_HICON_* was set, PCWSTR otherwise)
TASKDIALOG_MESSAGES

◆ TASKDIALOG_NOTIFICATIONS

Enumerator
TDN_CREATED 
TDN_NAVIGATED 
TDN_BUTTON_CLICKED 
TDN_HYPERLINK_CLICKED 
TDN_TIMER 
TDN_DESTROYED 
TDN_RADIO_BUTTON_CLICKED 
TDN_DIALOG_CONSTRUCTED 
TDN_VERIFICATION_CLICKED 
TDN_HELP 
TDN_EXPANDO_BUTTON_CLICKED 

Definition at line 69 of file SDL_windowstaskdialog.h.

70 {
71  TDN_CREATED = 0,
72  TDN_NAVIGATED = 1,
73  TDN_BUTTON_CLICKED = 2, // wParam = Button ID
74  TDN_HYPERLINK_CLICKED = 3, // lParam = (LPCWSTR)pszHREF
75  TDN_TIMER = 4, // wParam = Milliseconds since dialog created or timer reset
76  TDN_DESTROYED = 5,
77  TDN_RADIO_BUTTON_CLICKED = 6, // wParam = Radio Button ID
79  TDN_VERIFICATION_CLICKED = 8, // wParam = 1 if checkbox checked, 0 if not, lParam is unused and always 0
80  TDN_HELP = 9,
81  TDN_EXPANDO_BUTTON_CLICKED = 10 // wParam = 0 (dialog is now collapsed), wParam != 0 (dialog is now expanded)
TASKDIALOG_NOTIFICATIONS