interface/wx/dialog.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dialog.h
   3 // Purpose:     interface of wxDialog
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     Modes used for wxDialog::SetLayoutAdaptationMode().
  11 */
  12 enum wxDialogLayoutAdaptationMode
  13 {
  14     wxDIALOG_ADAPTATION_MODE_DEFAULT = 0,   ///< Use global adaptation enabled status.
  15     wxDIALOG_ADAPTATION_MODE_ENABLED = 1,   ///< Enable this dialog overriding global status.
  16     wxDIALOG_ADAPTATION_MODE_DISABLED = 2   ///< Disable this dialog overriding global status.
  17 };
  18
  19 /**
  20     @class wxDialog
  21
  22     A dialog box is a window with a title bar and sometimes a system menu,
  23     which can be moved around the screen. It can contain controls and other
  24     windows and is often used to allow the user to make some choice or to
  25     answer a question.
  26
  27     Dialogs can be made scrollable, automatically, for computers with low
  28     resolution screens: please see @ref overview_dialog_autoscrolling for
  29     further details.
  30
  31     Dialogs usually contains either a single button allowing to close the
  32     dialog or two buttons, one accepting the changes and the other one
  33     discarding them (such button, if present, is automatically activated if the
  34     user presses the "Esc" key). By default, buttons with the standard wxID_OK
  35     and wxID_CANCEL identifiers behave as expected. Starting with wxWidgets 2.7
  36     it is also possible to use a button with a different identifier instead,
  37     see SetAffirmativeId() and SetEscapeId().
  38
  39     Also notice that the CreateButtonSizer() should be used to create the
  40     buttons appropriate for the current platform and positioned correctly
  41     (including their order which is platform-dependent).
  42
  43     @section dialog_modal Modal and Modeless
  44
  45     There are two kinds of dialog, modal and modeless. A modal dialog blocks
  46     program flow and user input on other windows until it is dismissed, whereas
  47     a modeless dialog behaves more like a frame in that program flow continues,
  48     and input in other windows is still possible. To show a modal dialog you
  49     should use the ShowModal() method while to show a dialog modelessly you
  50     simply use Show(), just as with frames.
  51
  52     Note that the modal dialog is one of the very few examples of
  53     wxWindow-derived objects which may be created on the stack and not on the
  54     heap. In other words, while most windows would be created like this:
  55
  56     @code
  57     void AskUser()
  58     {
  59         MyAskDialog *dlg = new MyAskDialog(...);
  60         if ( dlg->ShowModal() == wxID_OK )
  61             // ...
  62         //else: dialog was cancelled or some another button pressed
  63
  64         dlg->Destroy();
  65     }
  66     @endcode
  67
  68     You can achieve the same result with dialogs by using simpler code:
  69
  70     @code
  71     void AskUser()
  72     {
  73         MyAskDialog dlg(...);
  74         if ( dlg.ShowModal() == wxID_OK )
  75             // ...
  76
  77         // no need to call Destroy() here
  78     }
  79     @endcode
  80
  81     An application can define a wxCloseEvent handler for the dialog to respond
  82     to system close events.
  83
  84     @beginStyleTable
  85     @style{wxCAPTION}
  86            Puts a caption on the dialog box.
  87     @style{wxDEFAULT_DIALOG_STYLE}
  88            Equivalent to a combination of wxCAPTION, wxCLOSE_BOX and
  89            wxSYSTEM_MENU (the last one is not used under Unix).
  90     @style{wxRESIZE_BORDER}
  91            Display a resizeable frame around the window.
  92     @style{wxSYSTEM_MENU}
  93            Display a system menu.
  94     @style{wxCLOSE_BOX}
  95            Displays a close box on the frame.
  96     @style{wxMAXIMIZE_BOX}
  97            Displays a maximize box on the dialog.
  98     @style{wxMINIMIZE_BOX}
  99            Displays a minimize box on the dialog.
 100     @style{wxTHICK_FRAME}
 101            Display a thick frame around the window.
 102     @style{wxSTAY_ON_TOP}
 103            The dialog stays on top of all other windows.
 104     @style{wxNO_3D}
 105            Under Windows, specifies that the child controls should not have 3D
 106            borders unless specified in the control.
 107     @style{wxDIALOG_NO_PARENT}
 108            By default, a dialog created with a @NULL parent window will be
 109            given the @ref wxApp::GetTopWindow() "application's top level window"
 110            as parent. Use this style to prevent this from happening and create
 111            an orphan dialog. This is not recommended for modal dialogs.
 112     @style{wxDIALOG_EX_CONTEXTHELP}
 113            Under Windows, puts a query button on the caption. When pressed,
 114            Windows will go into a context-sensitive help mode and wxWidgets
 115            will send a wxEVT_HELP event if the user clicked on an application
 116            window. Note that this is an extended style and must be set by
 117            calling SetExtraStyle() before Create is called (two-step
 118            construction).
 119     @style{wxDIALOG_EX_METAL}
 120            On Mac OS X, frames with this style will be shown with a metallic
 121            look. This is an extra style.
 122     @endStyleTable
 123
 124     Under Unix or Linux, MWM (the Motif Window Manager) or other window
 125     managers recognizing the MHM hints should be running for any of these
 126     styles to have an effect.
 127
 128     @library{wxcore}
 129     @category{cmndlg}
 130
 131     @see @ref overview_dialog, wxFrame, @ref overview_validator
 132 */
 133 class wxDialog : public wxTopLevelWindow
 134 {
 135 public:
 136     /**
 137         Default constructor.
 138     */
 139     wxDialog();
 140     /**
 141         Constructor.
 142
 143         @param parent
 144             Can be @NULL, a frame or another dialog box.
 145         @param id
 146             An identifier for the dialog. A value of -1 is taken to mean a
 147             default.
 148         @param title
 149             The title of the dialog.
 150         @param pos
 151             The dialog position. The value wxDefaultPosition indicates a
 152             default position, chosen by either the windowing system or
 153             wxWidgets, depending on platform.
 154         @param size
 155             The dialog size. The value wxDefaultSize indicates a default size,
 156             chosen by either the windowing system or wxWidgets, depending on
 157             platform.
 158         @param style
 159             The window style.
 160         @param name
 161             Used to associate a name with the window, allowing the application
 162             user to set Motif resource values for individual dialog boxes.
 163
 164         @see Create()
 165     */
 166     wxDialog(wxWindow* parent, wxWindowID id, const wxString& title,
 167              const wxPoint& pos = wxDefaultPosition,
 168              const wxSize& size = wxDefaultSize,
 169              long style = wxDEFAULT_DIALOG_STYLE,
 170              const wxString& name = wxDialogNameStr);
 171
 172     /**
 173         Destructor. Deletes any child windows before deleting the physical
 174         window.
 175     */
 176     virtual ~wxDialog();
 177
 178     /**
 179         Adds an identifier to be regarded as a main button for the
 180         non-scrolling area of a dialog.
 181
 182         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
 183     */
 184     void AddMainButtonId(wxWindowID id);
 185
 186     /**
 187         Returns @true if this dialog can and should perform layout adaptation
 188         using DoLayoutAdaptation(), usually if the dialog is too large to fit
 189         on the display.
 190
 191         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
 192     */
 193     bool CanDoLayoutAdaptation();
 194
 195     /**
 196         Centres the dialog box on the display.
 197
 198         @param direction
 199             May be wxHORIZONTAL, wxVERTICAL or wxBOTH.
 200     */
 201     void Centre(int direction = wxBOTH);
 202
 203     /**
 204         Used for two-step dialog box construction.
 205
 206         @see wxDialog()
 207     */
 208     bool Create(wxWindow* parent, wxWindowID id, const wxString& title,
 209                 const wxPoint& pos = wxDefaultPosition,
 210                 const wxSize& size = wxDefaultSize,
 211                 long style = wxDEFAULT_DIALOG_STYLE,
 212                 const wxString& name = wxDialogNameStr);
 213
 214     /**
 215         Creates a sizer with standard buttons. @a flags is a bit list of the
 216         following flags: wxOK, wxCANCEL, wxYES, wxNO, wxAPPLY, wxCLOSE, wxHELP,
 217         wxNO_DEFAULT.
 218
 219         The sizer lays out the buttons in a manner appropriate to the platform.
 220
 221         This function uses CreateStdDialogButtonSizer() internally for most
 222         platforms but doesn't create the sizer at all for the platforms with
 223         hardware buttons (such as smartphones) for which it sets up the
 224         hardware buttons appropriately and returns @NULL, so don't forget to
 225         test that the return value is valid before using it.
 226     */
 227     wxSizer* CreateButtonSizer(long flags);
 228
 229     /**
 230         Creates a sizer with standard buttons using CreateButtonSizer()
 231         separated from the rest of the dialog contents by a horizontal
 232         wxStaticLine.
 233
 234         @note Just like CreateButtonSizer(), this function may return @NULL if
 235               no buttons were created.
 236     */
 237     wxSizer* CreateSeparatedButtonSizer(long flags);
 238
 239     /**
 240         Creates a wxStdDialogButtonSizer with standard buttons. @a flags is a
 241         bit list of the following flags: wxOK, wxCANCEL, wxYES, wxNO, wxAPPLY,
 242         wxCLOSE, wxHELP, wxNO_DEFAULT.
 243
 244         The sizer lays out the buttons in a manner appropriate to the platform.
 245     */
 246     wxStdDialogButtonSizer* CreateStdDialogButtonSizer(long flags);
 247
 248     /**
 249         Performs layout adaptation, usually if the dialog is too large to fit
 250         on the display.
 251
 252         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
 253     */
 254     bool DoLayoutAdaptation();
 255
 256     /**
 257         This function is called when the titlebar OK button is pressed
 258         (PocketPC only). A command event for the identifier returned by
 259         GetAffirmativeId() is sent by default. You can override this function.
 260         If the function returns @false, wxWidgets will call Close() for the
 261         dialog.
 262     */
 263     virtual bool DoOK();
 264
 265     /**
 266         A static function enabling or disabling layout adaptation for all
 267         dialogs.
 268
 269         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
 270     */
 271     static void EnableLayoutAdaptation(bool enable);
 272
 273     /**
 274         Ends a modal dialog, passing a value to be returned from the
 275         ShowModal() invocation.
 276
 277         @param retCode
 278             The value that should be returned by ShowModal.
 279
 280         @see ShowModal(), GetReturnCode(), SetReturnCode()
 281     */
 282     virtual void EndModal(int retCode);
 283
 284     /**
 285         Gets the identifier of the button which works like standard OK button
 286         in this dialog.
 287
 288         @see SetAffirmativeId()
 289     */
 290     int GetAffirmativeId() const;
 291
 292     /**
 293         Override this to return a window containing the main content of the
 294         dialog. This is particularly useful when the dialog implements pages,
 295         such as wxPropertySheetDialog, and allows the
 296         @ref overview_dialog "layout adaptation code" to know that only the
 297         pages need to be made scrollable.
 298     */
 299     virtual wxWindow* GetContentWindow() const;
 300
 301     /**
 302         Gets the identifier of the button to map presses of @c ESC button to.
 303
 304         @see SetEscapeId()
 305     */
 306     int GetEscapeId() const;
 307
 308     /**
 309         Returns @true if the dialog has been adapted, usually by making it
 310         scrollable to work with a small display.
 311
 312         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
 313     */
 314     bool GetLayoutAdaptationDone() const;
 315
 316     /**
 317         Gets a value representing the aggressiveness of search for buttons and
 318         sizers to be in the non-scrolling part of a layout-adapted dialog. Zero
 319         switches off adaptation, and 3 allows search for standard buttons
 320         anywhere in the dialog.
 321
 322         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
 323     */
 324     int GetLayoutAdaptationLevel() const;
 325
 326     /**
 327         Gets the adaptation mode, overriding the global adaptation flag.
 328
 329         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
 330     */
 331     wxDialogLayoutAdaptationMode GetLayoutAdaptationMode() const;
 332
 333     /**
 334         A static function getting the current layout adapter object.
 335
 336         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
 337     */
 338     static wxDialogLayoutAdapter* GetLayoutAdapter();
 339
 340     /**
 341         Returns an array of identifiers to be regarded as the main buttons for
 342         the non-scrolling area of a dialog.
 343
 344         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
 345     */
 346     wxArrayInt& GetMainButtonIds();
 347
 348     /**
 349         Gets the return code for this window.
 350
 351         @remarks A return code is normally associated with a modal dialog,
 352                  where ShowModal() returns a code to the application.
 353
 354         @see SetReturnCode(), ShowModal(), EndModal()
 355     */
 356     int GetReturnCode() const;
 357
 358     /**
 359         On PocketPC, a dialog is automatically provided with an empty toolbar.
 360         This function allows you to access the toolbar and add tools to it.
 361         Removing tools and adding arbitrary controls are not currently
 362         supported.
 363
 364         This function is not available on any other platform.
 365     */
 366     wxToolBar* GetToolBar() const;
 367
 368     /**
 369         Iconizes or restores the dialog. Windows only.
 370
 371         @param iconize
 372             If @true, iconizes the dialog box; if @false, shows and restores it.
 373
 374         @remarks Note that in Windows, iconization has no effect since dialog
 375                  boxes cannot be iconized. However, applications may need to
 376                  explicitly restore dialog boxes under Motif which have
 377                  user-iconizable frames, and under Windows calling
 378                  Iconize(@false) will bring the window to the front, as does
 379                  Show(@true).
 380     */
 381     virtual void Iconize(bool iconize = true);
 382
 383     /**
 384         Returns @true if the dialog box is iconized. Windows only.
 385
 386         @remarks Always returns @false under Windows since dialogs cannot be
 387                  iconized.
 388     */
 389     virtual bool IsIconized() const;
 390
 391     /**
 392         A static function returning @true if layout adaptation is enabled for
 393         all dialogs.
 394
 395         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
 396     */
 397     static bool IsLayoutAdaptationEnabled();
 398
 399     /**
 400         Returns @true if @a id is in the array of identifiers to be regarded as
 401         the main buttons for the non-scrolling area of a dialog.
 402
 403         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
 404     */
 405     bool IsMainButton(wxWindowID& id) const;
 406
 407     /**
 408         Returns @true if the dialog box is modal, @false otherwise.
 409     */
 410     virtual bool IsModal() const;
 411
 412     /**
 413         The default handler for wxEVT_SYS_COLOUR_CHANGED.
 414
 415         @param event
 416             The colour change event.
 417
 418         @remarks Changes the dialog's colour to conform to the current settings
 419                  (Windows only). Add an event table entry for your dialog class
 420                  if you wish the behaviour to be different (such as keeping a
 421                  user-defined background colour). If you do override this
 422                  function, call wxEvent::Skip() to propagate the notification
 423                  to child windows and controls.
 424
 425         @see wxSysColourChangedEvent
 426     */
 427     void OnSysColourChanged(wxSysColourChangedEvent& event);
 428
 429     /**
 430         Sets the identifier to be used as OK button. When the button with this
 431         identifier is pressed, the dialog calls wxWindow::Validate() and
 432         wxWindow::TransferDataFromWindow() and, if they both return @true,
 433         closes the dialog with wxID_OK return code.
 434
 435         Also, when the user presses a hardware OK button on the devices having
 436         one or the special OK button in the PocketPC title bar, an event with
 437         this id is generated.
 438
 439         By default, the affirmative id is wxID_OK.
 440
 441         @see GetAffirmativeId(), SetEscapeId()
 442     */
 443     void SetAffirmativeId(int id);
 444
 445     /**
 446         Sets the identifier of the button which should work like the standard
 447         "Cancel" button in this dialog. When the button with this id is
 448         clicked, the dialog is closed. Also, when the user presses @c ESC key
 449         in the dialog or closes the dialog using the close button in the title
 450         bar, this is mapped to the click of the button with the specified id.
 451
 452         By default, the escape id is the special value wxID_ANY meaning that
 453         wxID_CANCEL button is used if it's present in the dialog and otherwise
 454         the button with GetAffirmativeId() is used. Another special value for
 455         @a id is wxID_NONE meaning that @c ESC presses should be ignored. If
 456         any other value is given, it is interpreted as the id of the button to
 457         map the escape key to.
 458     */
 459     void SetEscapeId(int id);
 460
 461     /**
 462         Sets the icon for this dialog.
 463
 464         @param icon
 465             The icon to associate with this dialog.
 466
 467         @see wxIcon
 468     */
 469     void SetIcon(const wxIcon& icon);
 470
 471     /**
 472         Sets the icons for this dialog.
 473
 474         @param icons
 475             The icons to associate with this dialog.
 476
 477         @see wxIconBundle
 478     */
 479     void SetIcons(const wxIconBundle& icons);
 480
 481     /**
 482         Marks the dialog as having been adapted, usually by making it
 483         scrollable to work with a small display.
 484
 485         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
 486     */
 487     void SetLayoutAdaptationDone(bool done);
 488
 489     /**
 490         Sets the aggressiveness of search for buttons and sizers to be in the
 491         non-scrolling part of a layout-adapted dialog. Zero switches off
 492         adaptation, and 3 allows search for standard buttons anywhere in the
 493         dialog.
 494
 495         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
 496     */
 497     void SetLayoutAdaptationLevel(int level);
 498
 499     /**
 500         Sets the adaptation mode, overriding the global adaptation flag.
 501
 502         @see wxDialogLayoutAdaptationMode, @ref overview_dialog_autoscrolling
 503              (for more on layout adaptation)
 504     */
 505     void SetLayoutAdaptationMode(wxDialogLayoutAdaptationMode mode);
 506
 507     /**
 508         A static function for setting the current layout adapter object,
 509         returning the old adapter. If you call this, you should delete the old
 510         adapter object.
 511
 512         @see wxDialogLayoutAdapter, @ref overview_dialog_autoscrolling
 513     */
 514     static wxDialogLayoutAdapter* SetLayoutAdapter(wxDialogLayoutAdapter* adapter);
 515
 516     /**
 517         @deprecated This function doesn't work for all ports, just use
 518                     ShowModal() to show a modal dialog instead.
 519
 520         Allows the programmer to specify whether the dialog box is modal
 521         (Show() blocks control until the dialog is hidden) or modeless (control
 522         returns immediately).
 523
 524         @param flag
 525             If @true, the dialog will be modal, otherwise it will be modeless.
 526     */
 527     void SetModal(bool flag);
 528
 529     /**
 530         Sets the return code for this window.
 531
 532         A return code is normally associated with a modal dialog, where
 533         ShowModal() returns a code to the application. The function EndModal()
 534         calls SetReturnCode().
 535
 536         @param retCode
 537             The integer return code, usually a control identifier.
 538
 539         @see GetReturnCode(), ShowModal(), EndModal()
 540     */
 541     void SetReturnCode(int retCode);
 542
 543     /**
 544         Hides or shows the dialog. The preferred way of dismissing a modal
 545         dialog is to use EndModal().
 546
 547         @param show
 548             If @true, the dialog box is shown and brought to the front,
 549             otherwise the box is hidden. If @false and the dialog is modal,
 550             control is returned to the calling program.
 551     */
 552     virtual bool Show(bool show = 1);
 553
 554     /**
 555         Shows a modal dialog.
 556
 557         Program flow does not return until the dialog has been dismissed with
 558         EndModal().
 559
 560         Notice that it is possible to call ShowModal() for a dialog which had
 561         been previously shown with Show(), this allows to make an existing
 562         modeless dialog modal. However ShowModal() can't be called twice
 563         without intervening EndModal() calls.
 564
 565         @return The value set with SetReturnCode().
 566
 567         @see EndModal(), GetReturnCode(), SetReturnCode()
 568     */
 569     virtual int ShowModal();
 570 };
 571
 572
 573
 574 /**
 575     @class wxDialogLayoutAdapter
 576
 577     This abstract class is the base for classes that help wxWidgets peform
 578     run-time layout adaptation of dialogs. Principally, this is to cater for
 579     small displays by making part of the dialog scroll, but the application
 580     developer may find other uses for layout adaption.
 581
 582     By default, there is one instance of wxStandardDialogLayoutAdapter which
 583     can perform adaptation for most custom dialogs and dialogs with book
 584     controls such as wxPropertySheetDialog.
 585
 586     @library{wxcore}
 587     @category{winlayout}
 588
 589     @see @ref overview_dialog_autoscrolling
 590 */
 591 class wxDialogLayoutAdapter
 592 {
 593 public:
 594     /**
 595         Default constructor.
 596     */
 597     wxDialogLayoutAdapter();
 598
 599     /**
 600         Override this to returns @true if adaptation can and should be done.
 601     */
 602     virtual bool CanDoLayoutAdaptation(wxDialog* dialog) = 0;
 603
 604     /**
 605         Override this to perform layout adaptation, such as making parts of the
 606         dialog scroll and resizing the dialog to fit the display. Normally this
 607         function will be called just before the dialog is shown.
 608     */
 609     virtual bool DoLayoutAdaptation(wxDialog* dialog) = 0;
 610 };
 611