| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: wx/dialog.h |
| 3 | // Purpose: wxDialogBase class |
| 4 | // Author: Vadim Zeitlin |
| 5 | // Modified by: |
| 6 | // Created: 29.06.99 |
| 7 | // RCS-ID: $Id$ |
| 8 | // Copyright: (c) Vadim Zeitlin |
| 9 | // Licence: wxWindows licence |
| 10 | ///////////////////////////////////////////////////////////////////////////// |
| 11 | |
| 12 | #ifndef _WX_DIALOG_H_BASE_ |
| 13 | #define _WX_DIALOG_H_BASE_ |
| 14 | |
| 15 | #include "wx/defs.h" |
| 16 | #include "wx/toplevel.h" |
| 17 | |
| 18 | class WXDLLIMPEXP_FWD_CORE wxSizer; |
| 19 | class WXDLLIMPEXP_FWD_CORE wxStdDialogButtonSizer; |
| 20 | class WXDLLIMPEXP_FWD_CORE wxBoxSizer; |
| 21 | class WXDLLIMPEXP_FWD_CORE wxDialogLayoutAdapter; |
| 22 | class WXDLLIMPEXP_FWD_CORE wxDialog; |
| 23 | class WXDLLIMPEXP_FWD_CORE wxButton; |
| 24 | class WXDLLIMPEXP_FWD_CORE wxScrolledWindow; |
| 25 | class wxTextSizerWrapper; |
| 26 | |
| 27 | // Also see the bit summary table in wx/toplevel.h. |
| 28 | |
| 29 | #define wxDIALOG_NO_PARENT 0x00000020 // Don't make owned by apps top window |
| 30 | |
| 31 | #ifdef __WXWINCE__ |
| 32 | #define wxDEFAULT_DIALOG_STYLE (wxCAPTION | wxMAXIMIZE | wxCLOSE_BOX | wxNO_BORDER) |
| 33 | #else |
| 34 | #define wxDEFAULT_DIALOG_STYLE (wxCAPTION | wxSYSTEM_MENU | wxCLOSE_BOX) |
| 35 | #endif |
| 36 | |
| 37 | // Layout adaptation levels, for SetLayoutAdaptationLevel |
| 38 | |
| 39 | // Don't do any layout adaptation |
| 40 | #define wxDIALOG_ADAPTATION_NONE 0 |
| 41 | |
| 42 | // Only look for wxStdDialogButtonSizer for non-scrolling part |
| 43 | #define wxDIALOG_ADAPTATION_STANDARD_SIZER 1 |
| 44 | |
| 45 | // Also look for any suitable sizer for non-scrolling part |
| 46 | #define wxDIALOG_ADAPTATION_ANY_SIZER 2 |
| 47 | |
| 48 | // Also look for 'loose' standard buttons for non-scrolling part |
| 49 | #define wxDIALOG_ADAPTATION_LOOSE_BUTTONS 3 |
| 50 | |
| 51 | // Layout adaptation mode, for SetLayoutAdaptationMode |
| 52 | enum wxDialogLayoutAdaptationMode |
| 53 | { |
| 54 | wxDIALOG_ADAPTATION_MODE_DEFAULT = 0, // use global adaptation enabled status |
| 55 | wxDIALOG_ADAPTATION_MODE_ENABLED = 1, // enable this dialog overriding global status |
| 56 | wxDIALOG_ADAPTATION_MODE_DISABLED = 2 // disable this dialog overriding global status |
| 57 | }; |
| 58 | |
| 59 | enum wxDialogModality |
| 60 | { |
| 61 | wxDIALOG_MODALITY_NONE = 0, |
| 62 | wxDIALOG_MODALITY_WINDOW_MODAL = 1, |
| 63 | wxDIALOG_MODALITY_APP_MODAL = 2 |
| 64 | }; |
| 65 | |
| 66 | extern WXDLLIMPEXP_DATA_CORE(const char) wxDialogNameStr[]; |
| 67 | |
| 68 | class WXDLLIMPEXP_CORE wxDialogBase : public wxTopLevelWindow |
| 69 | { |
| 70 | public: |
| 71 | wxDialogBase() { Init(); } |
| 72 | virtual ~wxDialogBase() { } |
| 73 | |
| 74 | // define public wxDialog methods to be implemented by the derived classes |
| 75 | virtual int ShowModal() = 0; |
| 76 | virtual void EndModal(int retCode) = 0; |
| 77 | virtual bool IsModal() const = 0; |
| 78 | // show the dialog frame-modally (needs a parent), using app-modal |
| 79 | // dialogs on platforms that don't support it |
| 80 | virtual void ShowWindowModal () ; |
| 81 | virtual void SendWindowModalDialogEvent ( wxEventType type ); |
| 82 | |
| 83 | // Modal dialogs have a return code - usually the id of the last |
| 84 | // pressed button |
| 85 | void SetReturnCode(int returnCode) { m_returnCode = returnCode; } |
| 86 | int GetReturnCode() const { return m_returnCode; } |
| 87 | |
| 88 | // Set the identifier for the affirmative button: this button will close |
| 89 | // the dialog after validating data and calling TransferDataFromWindow() |
| 90 | void SetAffirmativeId(int affirmativeId); |
| 91 | int GetAffirmativeId() const { return m_affirmativeId; } |
| 92 | |
| 93 | // Set identifier for Esc key translation: the button with this id will |
| 94 | // close the dialog without doing anything else; special value wxID_NONE |
| 95 | // means to not handle Esc at all while wxID_ANY means to map Esc to |
| 96 | // wxID_CANCEL if present and GetAffirmativeId() otherwise |
| 97 | void SetEscapeId(int escapeId); |
| 98 | int GetEscapeId() const { return m_escapeId; } |
| 99 | |
| 100 | // Find the parent to use for modal dialog: try to use the specified parent |
| 101 | // but fall back to the current active window or main application window as |
| 102 | // last resort if it is unsuitable. |
| 103 | // |
| 104 | // As this function is often called from the ctor, the window style may be |
| 105 | // not set yet and hence must be passed explicitly to it so that we could |
| 106 | // check whether it contains wxDIALOG_NO_PARENT bit. |
| 107 | // |
| 108 | // This function always returns a valid top level window or NULL. |
| 109 | wxWindow *GetParentForModalDialog(wxWindow *parent, long style) const; |
| 110 | |
| 111 | // This overload can only be used for already initialized windows, i.e. not |
| 112 | // from the ctor. It uses the current window parent and style. |
| 113 | wxWindow *GetParentForModalDialog() const |
| 114 | { |
| 115 | return GetParentForModalDialog(GetParent(), GetWindowStyle()); |
| 116 | } |
| 117 | |
| 118 | #if wxUSE_STATTEXT // && wxUSE_TEXTCTRL |
| 119 | // splits text up at newlines and places the lines into a vertical |
| 120 | // wxBoxSizer |
| 121 | wxSizer *CreateTextSizer( const wxString& message ); |
| 122 | |
| 123 | // same as above but uses a customized wxTextSizerWrapper to create |
| 124 | // non-standard controls for the lines |
| 125 | wxSizer *CreateTextSizer( const wxString& message, |
| 126 | wxTextSizerWrapper& wrapper ); |
| 127 | #endif // wxUSE_STATTEXT // && wxUSE_TEXTCTRL |
| 128 | |
| 129 | // returns a horizontal wxBoxSizer containing the given buttons |
| 130 | // |
| 131 | // notice that the returned sizer can be NULL if no buttons are put in the |
| 132 | // sizer (this mostly happens under smart phones and other atypical |
| 133 | // platforms which have hardware buttons replacing OK/Cancel and such) |
| 134 | wxSizer *CreateButtonSizer(long flags); |
| 135 | |
| 136 | // returns a sizer containing the given one and a static line separating it |
| 137 | // from the preceding elements if it's appropriate for the current platform |
| 138 | wxSizer *CreateSeparatedSizer(wxSizer *sizer); |
| 139 | |
| 140 | // returns the sizer containing CreateButtonSizer() below a separating |
| 141 | // static line for the platforms which use static lines for items |
| 142 | // separation (i.e. not Mac) |
| 143 | // |
| 144 | // this is just a combination of CreateButtonSizer() and |
| 145 | // CreateSeparatedSizer() |
| 146 | wxSizer *CreateSeparatedButtonSizer(long flags); |
| 147 | |
| 148 | #if wxUSE_BUTTON |
| 149 | wxStdDialogButtonSizer *CreateStdDialogButtonSizer( long flags ); |
| 150 | #endif // wxUSE_BUTTON |
| 151 | |
| 152 | // Do layout adaptation |
| 153 | virtual bool DoLayoutAdaptation(); |
| 154 | |
| 155 | // Can we do layout adaptation? |
| 156 | virtual bool CanDoLayoutAdaptation(); |
| 157 | |
| 158 | // Returns a content window if there is one. This can be used by the layout adapter, for |
| 159 | // example to make the pages of a book control into scrolling windows |
| 160 | virtual wxWindow* GetContentWindow() const { return NULL; } |
| 161 | |
| 162 | // Add an id to the list of main button identifiers that should be in the button sizer |
| 163 | void AddMainButtonId(wxWindowID id) { m_mainButtonIds.Add((int) id); } |
| 164 | wxArrayInt& GetMainButtonIds() { return m_mainButtonIds; } |
| 165 | |
| 166 | // Is this id in the main button id array? |
| 167 | bool IsMainButtonId(wxWindowID id) const { return (m_mainButtonIds.Index((int) id) != wxNOT_FOUND); } |
| 168 | |
| 169 | // Level of adaptation, from none (Level 0) to full (Level 3). To disable adaptation, |
| 170 | // set level 0, for example in your dialog constructor. You might |
| 171 | // do this if you know that you are displaying on a large screen and you don't want the |
| 172 | // dialog changed. |
| 173 | void SetLayoutAdaptationLevel(int level) { m_layoutAdaptationLevel = level; } |
| 174 | int GetLayoutAdaptationLevel() const { return m_layoutAdaptationLevel; } |
| 175 | |
| 176 | /// Override global adaptation enabled/disabled status |
| 177 | void SetLayoutAdaptationMode(wxDialogLayoutAdaptationMode mode) { m_layoutAdaptationMode = mode; } |
| 178 | wxDialogLayoutAdaptationMode GetLayoutAdaptationMode() const { return m_layoutAdaptationMode; } |
| 179 | |
| 180 | // Returns true if the adaptation has been done |
| 181 | void SetLayoutAdaptationDone(bool adaptationDone) { m_layoutAdaptationDone = adaptationDone; } |
| 182 | bool GetLayoutAdaptationDone() const { return m_layoutAdaptationDone; } |
| 183 | |
| 184 | // Set layout adapter class, returning old adapter |
| 185 | static wxDialogLayoutAdapter* SetLayoutAdapter(wxDialogLayoutAdapter* adapter); |
| 186 | static wxDialogLayoutAdapter* GetLayoutAdapter() { return sm_layoutAdapter; } |
| 187 | |
| 188 | // Global switch for layout adaptation |
| 189 | static bool IsLayoutAdaptationEnabled() { return sm_layoutAdaptation; } |
| 190 | static void EnableLayoutAdaptation(bool enable) { sm_layoutAdaptation = enable; } |
| 191 | |
| 192 | // modality kind |
| 193 | virtual wxDialogModality GetModality() const; |
| 194 | protected: |
| 195 | // emulate click of a button with the given id if it's present in the dialog |
| 196 | // |
| 197 | // return true if button was "clicked" or false if we don't have it |
| 198 | bool EmulateButtonClickIfPresent(int id); |
| 199 | |
| 200 | // this function is used by OnCharHook() to decide whether the given key |
| 201 | // should close the dialog |
| 202 | // |
| 203 | // for most platforms the default implementation (which just checks for |
| 204 | // Esc) is sufficient, but Mac port also adds Cmd-. here and other ports |
| 205 | // could do something different if needed |
| 206 | virtual bool IsEscapeKey(const wxKeyEvent& event); |
| 207 | |
| 208 | // end either modal or modeless dialog, for the modal dialog rc is used as |
| 209 | // the dialog return code |
| 210 | void EndDialog(int rc); |
| 211 | |
| 212 | // call Validate() and TransferDataFromWindow() and close dialog with |
| 213 | // wxID_OK return code |
| 214 | void AcceptAndClose(); |
| 215 | |
| 216 | // The return code from modal dialog |
| 217 | int m_returnCode; |
| 218 | |
| 219 | // The identifier for the affirmative button (usually wxID_OK) |
| 220 | int m_affirmativeId; |
| 221 | |
| 222 | // The identifier for cancel button (usually wxID_CANCEL) |
| 223 | int m_escapeId; |
| 224 | |
| 225 | // Flags whether layout adaptation has been done for this dialog |
| 226 | bool m_layoutAdaptationDone; |
| 227 | |
| 228 | // Extra button identifiers to be taken as 'main' button identifiers |
| 229 | // to be placed in the non-scrolling area |
| 230 | wxArrayInt m_mainButtonIds; |
| 231 | |
| 232 | // Adaptation level |
| 233 | int m_layoutAdaptationLevel; |
| 234 | |
| 235 | // Local override for global adaptation enabled status |
| 236 | wxDialogLayoutAdaptationMode m_layoutAdaptationMode; |
| 237 | |
| 238 | // Global layout adapter |
| 239 | static wxDialogLayoutAdapter* sm_layoutAdapter; |
| 240 | |
| 241 | // Global adaptation switch |
| 242 | static bool sm_layoutAdaptation; |
| 243 | |
| 244 | private: |
| 245 | // common part of all ctors |
| 246 | void Init(); |
| 247 | |
| 248 | // helper of GetParentForModalDialog(): returns the passed in window if it |
| 249 | // can be used as our parent or NULL if it can't |
| 250 | wxWindow *CheckIfCanBeUsedAsParent(wxWindow *parent) const; |
| 251 | |
| 252 | // Helper of OnCharHook() and OnCloseWindow(): find the appropriate button |
| 253 | // for closing the dialog and send a click event for it. |
| 254 | // |
| 255 | // Return true if we found a button to close the dialog and "clicked" it or |
| 256 | // false otherwise. |
| 257 | bool SendCloseButtonClickEvent(); |
| 258 | |
| 259 | // handle Esc key presses |
| 260 | void OnCharHook(wxKeyEvent& event); |
| 261 | |
| 262 | // handle closing the dialog window |
| 263 | void OnCloseWindow(wxCloseEvent& event); |
| 264 | |
| 265 | // handle the standard buttons |
| 266 | void OnButton(wxCommandEvent& event); |
| 267 | |
| 268 | // update the background colour |
| 269 | void OnSysColourChanged(wxSysColourChangedEvent& event); |
| 270 | |
| 271 | |
| 272 | wxDECLARE_NO_COPY_CLASS(wxDialogBase); |
| 273 | DECLARE_EVENT_TABLE() |
| 274 | }; |
| 275 | |
| 276 | /*! |
| 277 | * Base class for layout adapters - code that, for example, turns a dialog into a |
| 278 | * scrolling dialog if there isn't enough screen space. You can derive further |
| 279 | * adapter classes to do any other kind of adaptation, such as applying a watermark, or adding |
| 280 | * a help mechanism. |
| 281 | */ |
| 282 | |
| 283 | class WXDLLIMPEXP_CORE wxDialogLayoutAdapter: public wxObject |
| 284 | { |
| 285 | DECLARE_CLASS(wxDialogLayoutAdapter) |
| 286 | public: |
| 287 | wxDialogLayoutAdapter() {} |
| 288 | |
| 289 | // Override this function to indicate that adaptation should be done |
| 290 | virtual bool CanDoLayoutAdaptation(wxDialog* dialog) = 0; |
| 291 | |
| 292 | // Override this function to do the adaptation |
| 293 | virtual bool DoLayoutAdaptation(wxDialog* dialog) = 0; |
| 294 | }; |
| 295 | |
| 296 | /*! |
| 297 | * Standard adapter. Does scrolling adaptation for paged and regular dialogs. |
| 298 | * |
| 299 | */ |
| 300 | |
| 301 | class WXDLLIMPEXP_CORE wxStandardDialogLayoutAdapter: public wxDialogLayoutAdapter |
| 302 | { |
| 303 | DECLARE_CLASS(wxStandardDialogLayoutAdapter) |
| 304 | public: |
| 305 | wxStandardDialogLayoutAdapter() {} |
| 306 | |
| 307 | // Overrides |
| 308 | |
| 309 | // Indicate that adaptation should be done |
| 310 | virtual bool CanDoLayoutAdaptation(wxDialog* dialog); |
| 311 | |
| 312 | // Do layout adaptation |
| 313 | virtual bool DoLayoutAdaptation(wxDialog* dialog); |
| 314 | |
| 315 | // Implementation |
| 316 | |
| 317 | // Create the scrolled window |
| 318 | virtual wxScrolledWindow* CreateScrolledWindow(wxWindow* parent); |
| 319 | |
| 320 | #if wxUSE_BUTTON |
| 321 | // Find a standard or horizontal box sizer |
| 322 | virtual wxSizer* FindButtonSizer(bool stdButtonSizer, wxDialog* dialog, wxSizer* sizer, int& retBorder, int accumlatedBorder = 0); |
| 323 | |
| 324 | // Check if this sizer contains standard buttons, and so can be repositioned in the dialog |
| 325 | virtual bool IsOrdinaryButtonSizer(wxDialog* dialog, wxBoxSizer* sizer); |
| 326 | |
| 327 | // Check if this is a standard button |
| 328 | virtual bool IsStandardButton(wxDialog* dialog, wxButton* button); |
| 329 | |
| 330 | // Find 'loose' main buttons in the existing layout and add them to the standard dialog sizer |
| 331 | virtual bool FindLooseButtons(wxDialog* dialog, wxStdDialogButtonSizer* buttonSizer, wxSizer* sizer, int& count); |
| 332 | #endif // wxUSE_BUTTON |
| 333 | |
| 334 | // Reparent the controls to the scrolled window, except those in buttonSizer |
| 335 | virtual void ReparentControls(wxWindow* parent, wxWindow* reparentTo, wxSizer* buttonSizer = NULL); |
| 336 | static void DoReparentControls(wxWindow* parent, wxWindow* reparentTo, wxSizer* buttonSizer = NULL); |
| 337 | |
| 338 | // A function to fit the dialog around its contents, and then adjust for screen size. |
| 339 | // If scrolled windows are passed, scrolling is enabled in the required orientation(s). |
| 340 | virtual bool FitWithScrolling(wxDialog* dialog, wxScrolledWindow* scrolledWindow); |
| 341 | virtual bool FitWithScrolling(wxDialog* dialog, wxWindowList& windows); |
| 342 | static bool DoFitWithScrolling(wxDialog* dialog, wxScrolledWindow* scrolledWindow); |
| 343 | static bool DoFitWithScrolling(wxDialog* dialog, wxWindowList& windows); |
| 344 | |
| 345 | // Find whether scrolling will be necessary for the dialog, returning wxVERTICAL, wxHORIZONTAL or both |
| 346 | virtual int MustScroll(wxDialog* dialog, wxSize& windowSize, wxSize& displaySize); |
| 347 | static int DoMustScroll(wxDialog* dialog, wxSize& windowSize, wxSize& displaySize); |
| 348 | }; |
| 349 | |
| 350 | #if defined(__WXUNIVERSAL__) && !defined(__WXMICROWIN__) |
| 351 | #include "wx/univ/dialog.h" |
| 352 | #else |
| 353 | #if defined(__WXMSW__) |
| 354 | #include "wx/msw/dialog.h" |
| 355 | #elif defined(__WXMOTIF__) |
| 356 | #include "wx/motif/dialog.h" |
| 357 | #elif defined(__WXGTK20__) |
| 358 | #include "wx/gtk/dialog.h" |
| 359 | #elif defined(__WXGTK__) |
| 360 | #include "wx/gtk1/dialog.h" |
| 361 | #elif defined(__WXMAC__) |
| 362 | #include "wx/osx/dialog.h" |
| 363 | #elif defined(__WXCOCOA__) |
| 364 | #include "wx/cocoa/dialog.h" |
| 365 | #elif defined(__WXPM__) |
| 366 | #include "wx/os2/dialog.h" |
| 367 | #endif |
| 368 | #endif |
| 369 | |
| 370 | class WXDLLIMPEXP_CORE wxWindowModalDialogEvent : public wxCommandEvent |
| 371 | { |
| 372 | public: |
| 373 | wxWindowModalDialogEvent (wxEventType commandType = wxEVT_NULL, int id = 0) |
| 374 | : wxCommandEvent(commandType, id) { } |
| 375 | |
| 376 | wxDialog *GetDialog() const |
| 377 | { return wxStaticCast(GetEventObject(), wxDialog); } |
| 378 | |
| 379 | int GetReturnCode() const |
| 380 | { return GetDialog()->GetReturnCode(); } |
| 381 | |
| 382 | virtual wxEvent *Clone() const { return new wxWindowModalDialogEvent (*this); } |
| 383 | |
| 384 | private: |
| 385 | DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowModalDialogEvent ) |
| 386 | }; |
| 387 | |
| 388 | wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_WINDOW_MODAL_DIALOG_CLOSED , wxWindowModalDialogEvent ); |
| 389 | |
| 390 | typedef void (wxEvtHandler::*wxWindowModalDialogEventFunction)(wxWindowModalDialogEvent &); |
| 391 | |
| 392 | #define wxWindowModalDialogEventHandler(func) \ |
| 393 | wxEVENT_HANDLER_CAST(wxWindowModalDialogEventFunction, func) |
| 394 | |
| 395 | #define EVT_WINDOW_MODAL_DIALOG_CLOSED(winid, func) \ |
| 396 | wx__DECLARE_EVT1(wxEVT_WINDOW_MODAL_DIALOG_CLOSED, winid, wxWindowModalDialogEventHandler(func)) |
| 397 | |
| 398 | #endif |
| 399 | // _WX_DIALOG_H_BASE_ |