wxPython/src/_cmndlgs.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _cmndlgs.i
   3 // Purpose:     SWIG interface for the "Common Dialog" classes
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     25-July-1998
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17 %newgroup
  18
  19 MAKE_CONST_WXSTRING(FileSelectorPromptStr);
  20 MAKE_CONST_WXSTRING(DirSelectorPromptStr);
  21 MAKE_CONST_WXSTRING(DirDialogNameStr);
  22 MAKE_CONST_WXSTRING(FileSelectorDefaultWildcardStr);
  23 MAKE_CONST_WXSTRING(GetTextFromUserPromptStr);
  24 MAKE_CONST_WXSTRING(MessageBoxCaptionStr);
  25
  26 //---------------------------------------------------------------------------
  27
  28
  29 DocStr(wxColourData,
  30 "This class holds a variety of information related to the colour
  31 chooser dialog, used to transfer settings and results to and from the
  32 `wx.ColourDialog`.", "");
  33
  34 class wxColourData : public wxObject {
  35 public:
  36     DocCtorStr(
  37         wxColourData(),
  38         "Constructor, sets default values.", "");
  39
  40     ~wxColourData();
  41
  42
  43     DocDeclStr(
  44         bool , GetChooseFull(),
  45         "Under Windows, determines whether the Windows colour dialog will
  46 display the full dialog with custom colour selection controls. Has no
  47 meaning under other platforms.  The default value is true.", "");
  48
  49     DocDeclStr(
  50         wxColour , GetColour(),
  51         "Gets the colour (pre)selected by the dialog.", "");
  52
  53     DocDeclStr(
  54         wxColour , GetCustomColour(int i),
  55         "Gets the i'th custom colour associated with the colour dialog. i
  56 should be an integer between 0 and 15. The default custom colours are
  57 all invalid colours.", "");
  58
  59     DocDeclStr(
  60         void , SetChooseFull(int flag),
  61         "Under Windows, tells the Windows colour dialog to display the full
  62 dialog with custom colour selection controls. Under other platforms,
  63 has no effect.  The default value is true.", "");
  64
  65     DocDeclStr(
  66         void , SetColour(const wxColour& colour),
  67         "Sets the default colour for the colour dialog.  The default colour is
  68 black.", "");
  69
  70     DocDeclStr(
  71         void , SetCustomColour(int i, const wxColour& colour),
  72         "Sets the i'th custom colour for the colour dialog. i should be an
  73 integer between 0 and 15. The default custom colours are all invalid colours.", "");
  74
  75
  76     %property(ChooseFull, GetChooseFull, SetChooseFull, doc="See `GetChooseFull` and `SetChooseFull`");
  77     %property(Colour, GetColour, SetColour, doc="See `GetColour` and `SetColour`");
  78     %property(CustomColour, GetCustomColour, SetCustomColour, doc="See `GetCustomColour` and `SetCustomColour`");
  79
  80 };
  81
  82
  83
  84
  85 DocStr(wxColourDialog,
  86        "This class represents the colour chooser dialog.", "");
  87
  88 MustHaveApp(wxColourDialog);
  89
  90 class wxColourDialog : public wxDialog {
  91 public:
  92     %pythonAppend wxColourDialog   "self._setOORInfo(self)"
  93
  94    DocCtorStr(
  95        wxColourDialog(wxWindow* parent, wxColourData* data = NULL),
  96        "Constructor. Pass a parent window, and optionally a `wx.ColourData`,
  97 which will be copied to the colour dialog's internal ColourData
  98 instance.", "");
  99
 100     DocDeclStr(
 101         wxColourData& , GetColourData(),
 102         "Returns a reference to the `wx.ColourData` used by the dialog.", "");
 103
 104     %property(ColourData, GetColourData, doc="See `GetColourData`");
 105 };
 106
 107
 108 wxColour wxGetColourFromUser(wxWindow *parent = (wxWindow *)NULL,
 109                              const wxColour& colInit = wxNullColour,
 110                              const wxString& caption = wxPyEmptyString);
 111
 112
 113 //--------------------------------------------------------------------------------
 114
 115 enum {
 116     wxDD_NEW_DIR_BUTTON,
 117     wxDD_DEFAULT_STYLE,
 118     wxDD_CHANGE_DIR,
 119 };
 120
 121 DocStr(wxDirDialog,
 122        "wx.DirDialog allows the user to select a directory by browising the
 123 file system.", "
 124
 125 Window  Styles
 126 --------------
 127     ====================  ==========================================
 128     wx.DD_DEFAULT_STYLE   Equivalent to a combination of
 129                           wx.DEFAULT_DIALOG_STYLE, wx.DD_NEW_DIR_BUTTON
 130                           and wx.RESIZE_BORDER.
 131
 132     wx.DD_NEW_DIR_BUTTON  Add 'Create new directory' button and allow
 133                           directory names to be editable. On Windows
 134                           the new directory button is only available
 135                           with recent versions of the common dialogs.
 136
 137     wx.DD_CHANGE_DIR      Change the current working directory to the
 138                           directory chosen by the user.
 139     ====================  ==========================================
 140 ");
 141
 142 MustHaveApp(wxDirDialog);
 143
 144 class wxDirDialog : public wxDialog {
 145 public:
 146     %pythonAppend wxDirDialog   "self._setOORInfo(self)"
 147     %pythonAppend wxDirDialog() ""
 148
 149     DocCtorStr(
 150         wxDirDialog(wxWindow* parent,
 151                     const wxString& message = wxPyDirSelectorPromptStr,
 152                     const wxString& defaultPath = wxPyEmptyString,
 153                     long style = wxDD_DEFAULT_STYLE,
 154                     const wxPoint& pos = wxDefaultPosition,
 155                     const wxSize& size = wxDefaultSize,
 156                     const wxString& name = wxPyDirDialogNameStr),
 157         "Constructor.  Use ShowModal method to show the dialog.", "");
 158
 159 //     %RenameCtor(PreDirDialog, wxDirDialog());
 160
 161 //     bool Create(wxWindow *parent,
 162 //                 const wxString& title = wxDirSelectorPromptStr,
 163 //                 const wxString& defaultPath = wxEmptyString,
 164 //                 long style = wxDD_DEFAULT_STYLE,
 165 //                 const wxPoint& pos = wxDefaultPosition,
 166 //                 const wxSize& sz = wxDefaultSize,
 167 //                 const wxString& name = wxPyDirDialogNameStr);
 168
 169     DocDeclStr(
 170         wxString , GetPath(),
 171         "Returns the default or user-selected path.", "");
 172
 173     DocDeclStr(
 174         wxString , GetMessage(),
 175         "Returns the message that will be displayed on the dialog.", "");
 176
 177     DocDeclStr(
 178         void , SetMessage(const wxString& message),
 179         "Sets the message that will be displayed on the dialog.", "");
 180
 181     DocDeclStr(
 182         void , SetPath(const wxString& path),
 183         "Sets the default path.", "");
 184
 185     %property(Message, GetMessage, SetMessage, doc="See `GetMessage` and `SetMessage`");
 186     %property(Path, GetPath, SetPath, doc="See `GetPath` and `SetPath`");
 187 };
 188
 189
 190 //---------------------------------------------------------------------------
 191
 192 %{
 193 // for compatibility only
 194 #define wxHIDE_READONLY 0
 195 %}
 196
 197 enum {
 198     // These will dissappear in 2.8
 199     wxOPEN,
 200     wxSAVE,
 201     wxOVERWRITE_PROMPT,
 202     wxFILE_MUST_EXIST,
 203     wxMULTIPLE,
 204     wxCHANGE_DIR,
 205     wxHIDE_READONLY,
 206
 207     wxFD_OPEN,
 208     wxFD_SAVE,
 209     wxFD_OVERWRITE_PROMPT,
 210     wxFD_FILE_MUST_EXIST,
 211     wxFD_MULTIPLE,
 212     wxFD_CHANGE_DIR,
 213     wxFD_PREVIEW,
 214     wxFD_DEFAULT_STYLE,
 215 };
 216
 217 DocStr(wxFileDialog,
 218 "wx.FileDialog allows the user to select one or more files from the
 219 filesystem.", "
 220
 221 In Windows, this is the common file selector dialog. On X based
 222 platforms a generic alternative is used.  The path and filename are
 223 distinct elements of a full file pathname. If path is \"\", the
 224 current directory will be used. If filename is \"\", no default
 225 filename will be supplied. The wildcard determines what files are
 226 displayed in the file selector, and file extension supplies a type
 227 extension for the required filename.
 228
 229 Both the X and Windows versions implement a wildcard filter. Typing a
 230 filename containing wildcards (\*, ?) in the filename text item, and
 231 clicking on Ok, will result in only those files matching the pattern
 232 being displayed. The wildcard may be a specification for multiple
 233 types of file with a description for each, such as::
 234
 235    \"BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif\"
 236
 237
 238 Window  Styles
 239 --------------
 240     ======================   ==========================================
 241     wx.FD_OPEN               This is an open dialog.
 242
 243     wx.FD_SAVE               This is a save dialog.
 244
 245     wx.FD_OVERWRITE_PROMPT   For save dialog only: prompt for a confirmation
 246                              if a file will be overwritten.
 247
 248     wx.FD_MULTIPLE           For open dialog only: allows selecting multiple
 249                              files.
 250
 251     wx.FD_CHANGE_DIR         Change the current working directory to the
 252                              directory  where the file(s) chosen by the user
 253                              are.
 254     ======================   ==========================================
 255 ");
 256
 257
 258
 259 MustHaveApp(wxFileDialog);
 260
 261 class wxFileDialog : public wxDialog {
 262 public:
 263     %pythonAppend wxFileDialog   "self._setOORInfo(self)"
 264
 265     DocCtorStr(
 266         wxFileDialog(wxWindow* parent,
 267                      const wxString& message = wxPyFileSelectorPromptStr,
 268                      const wxString& defaultDir = wxPyEmptyString,
 269                      const wxString& defaultFile = wxPyEmptyString,
 270                      const wxString& wildcard = wxPyFileSelectorDefaultWildcardStr,
 271                      long style = wxFD_DEFAULT_STYLE,
 272                      const wxPoint& pos = wxDefaultPosition),
 273         "Constructor.  Use ShowModal method to show the dialog.", "");
 274
 275
 276     DocDeclStr(
 277         void , SetMessage(const wxString& message),
 278         "Sets the message that will be displayed on the dialog.", "");
 279
 280     DocDeclStr(
 281         void , SetPath(const wxString& path),
 282         "Sets the path (the combined directory and filename that will be
 283 returned when the dialog is dismissed).", "");
 284
 285     DocDeclStr(
 286         void , SetDirectory(const wxString& dir),
 287         "Sets the default directory.", "");
 288
 289     DocDeclStr(
 290         void , SetFilename(const wxString& name),
 291         "Sets the default filename.", "");
 292
 293     DocDeclStr(
 294         void , SetWildcard(const wxString& wildCard),
 295         "Sets the wildcard, which can contain multiple file types, for
 296 example::
 297
 298     \"BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif\"
 299 ", "");
 300
 301     DocDeclStr(
 302         void , SetFilterIndex(int filterIndex),
 303         "Sets the default filter index, starting from zero.", "");
 304
 305     DocDeclStr(
 306         wxString , GetMessage() const,
 307         "Returns the message that will be displayed on the dialog.", "");
 308
 309     DocDeclStr(
 310         wxString , GetPath() const,
 311         "Returns the full path (directory and filename) of the selected file.", "");
 312
 313     DocDeclStr(
 314         wxString , GetDirectory() const,
 315         "Returns the default directory.", "");
 316
 317     DocDeclStr(
 318         wxString , GetFilename() const,
 319         "Returns the default filename.", "");
 320
 321     DocDeclStr(
 322         wxString , GetWildcard() const,
 323         "Returns the file dialog wildcard.", "");
 324
 325     DocDeclStr(
 326         int , GetFilterIndex() const,
 327         "Returns the index into the list of filters supplied, optionally, in
 328 the wildcard parameter. Before the dialog is shown, this is the index
 329 which will be used when the dialog is first displayed. After the
 330 dialog is shown, this is the index selected by the user.", "");
 331
 332
 333     %extend {
 334         DocStr(GetFilenames,
 335                "Returns a list of filenames chosen in the dialog.  This function
 336 should only be used with the dialogs which have wx.MULTIPLE style, use
 337 GetFilename for the others.", "");
 338         PyObject* GetFilenames() {
 339             wxArrayString arr;
 340             self->GetFilenames(arr);
 341             return wxArrayString2PyList_helper(arr);
 342         }
 343
 344         DocStr(GetPaths,
 345                "Fills the array paths with the full paths of the files chosen. This
 346 function should only be used with the dialogs which have wx.MULTIPLE
 347 style, use GetPath for the others.", "");
 348
 349         PyObject* GetPaths() {
 350             wxArrayString arr;
 351             self->GetPaths(arr);
 352             return wxArrayString2PyList_helper(arr);
 353         }
 354     }
 355
 356 // TODO
 357 //     // Utility functions
 358
 359 //     // Parses the wildCard, returning the number of filters.
 360 //     // Returns 0 if none or if there's a problem,
 361 //     // The arrays will contain an equal number of items found before the error.
 362 //     // wildCard is in the form:
 363 //     // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
 364 //     static int ParseWildcard(const wxString& wildCard,
 365 //                              wxArrayString& descriptions,
 366 //                              wxArrayString& filters);
 367
 368 //     // Append first extension to filePath from a ';' separated extensionList
 369 //     // if filePath = "path/foo.bar" just return it as is
 370 //     // if filePath = "foo[.]" and extensionList = "*.jpg;*.png" return "foo.jpg"
 371 //     // if the extension is "*.j?g" (has wildcards) or "jpg" then return filePath
 372 //     static wxString AppendExtension(const wxString &filePath,
 373 //                                     const wxString &extensionList);
 374
 375
 376 };
 377
 378
 379 //---------------------------------------------------------------------------
 380
 381 enum { wxCHOICEDLG_STYLE };
 382
 383
 384 DocStr(wxMultiChoiceDialog,
 385        "A simple dialog with a multi selection listbox.", "");
 386
 387 MustHaveApp(wxMultiChoiceDialog);
 388
 389 class wxMultiChoiceDialog : public wxDialog
 390 {
 391 public:
 392     %pythonAppend wxMultiChoiceDialog   "self._setOORInfo(self)"
 393
 394     DocCtorAStr(
 395         wxMultiChoiceDialog(wxWindow *parent,
 396                             const wxString& message,
 397                             const wxString& caption,
 398                             int choices=0, wxString* choices_array=NULL,
 399                             long style = wxCHOICEDLG_STYLE,
 400                             const wxPoint& pos = wxDefaultPosition),
 401         "__init__(self, Window parent, String message, String caption,
 402     List choices=EmptyList, long style=CHOICEDLG_STYLE,
 403     Point pos=DefaultPosition) -> MultiChoiceDialog",
 404         "Constructor.  Use the `ShowModal` method to show the dialog.
 405
 406     :param parent: The parent window.
 407     :param message: Text to display above the list of selections.
 408     :param caption: Text to use in the title bar of the dialog.
 409     :param choices: A list of strings or unicode objects that the
 410         user is allowed to choose from.
 411     :param style: Styles to apply to the dialog.  The default value is
 412         equivallent to wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.OK|wx.CANCEL|wx.CENTER.
 413     :param pos: Where to position the dialog (not used on Windows)
 414
 415 ", "");
 416
 417
 418     DocDeclAStr(
 419         void, SetSelections(const wxArrayInt& selections),
 420         "SetSelections(List selections)",
 421         "Specify the items in the list that should be selected, using a list of
 422 integers.  The list should specify the indexes of the items that
 423 should be selected.", "");
 424
 425     DocAStr(GetSelections,
 426             "GetSelections() -> [selections]",
 427             "Returns a list of integers representing the items that are selected.
 428 If an item is selected then its index will appear in the list.", "");
 429     %extend {
 430         PyObject* GetSelections() {
 431             return wxArrayInt2PyList_helper(self->GetSelections());
 432         }
 433     }
 434 };
 435
 436
 437 //---------------------------------------------------------------------------
 438
 439 DocStr(wxSingleChoiceDialog,
 440        "A simple dialog with a single selection listbox.", "");
 441
 442 MustHaveApp(wxSingleChoiceDialog);
 443
 444 class wxSingleChoiceDialog : public wxDialog {
 445 public:
 446     %pythonAppend wxSingleChoiceDialog   "self._setOORInfo(self)"
 447
 448     DocAStr(wxSingleChoiceDialog,
 449             "__init__(Window parent, String message, String caption,
 450     List choices=EmptyList, long style=CHOICEDLG_STYLE,
 451     Point pos=DefaultPosition) -> SingleChoiceDialog",
 452             "Constructor.  Use ShowModal method to show the dialog.", "");
 453
 454     %extend {
 455         // TODO: ignoring clientData for now...  FIX THIS
 456         //       SWIG is messing up the &/*'s for some reason.
 457         wxSingleChoiceDialog(wxWindow* parent,
 458                              const wxString& message,
 459                              const wxString& caption,
 460                              int choices, wxString* choices_array,
 461                              //char** clientData = NULL,
 462                              long style = wxCHOICEDLG_STYLE,
 463                              const wxPoint& pos = wxDefaultPosition) {
 464             return new wxSingleChoiceDialog(parent, message, caption,
 465                                             choices, choices_array, NULL, style, pos);
 466         }
 467     }
 468
 469     DocDeclStr(
 470         int , GetSelection(),
 471         "Get the index of the currently selected item.", "");
 472
 473     DocDeclStr(
 474         wxString , GetStringSelection(),
 475         "Returns the string value of the currently selected item", "");
 476
 477     DocDeclStr(
 478         void , SetSelection(int sel),
 479         "Set the current selected item to sel", "");
 480 };
 481
 482
 483 //---------------------------------------------------------------------------
 484
 485 DocStr(wxTextEntryDialog,
 486        "A dialog with text control, [ok] and [cancel] buttons", "");
 487
 488 MustHaveApp(wxTextEntryDialog);
 489
 490 enum { wxTextEntryDialogStyle };
 491
 492 class wxTextEntryDialog : public wxDialog {
 493 public:
 494     %pythonAppend wxTextEntryDialog   "self._setOORInfo(self)"
 495
 496     DocCtorStr(
 497         wxTextEntryDialog(wxWindow* parent,
 498                           const wxString& message,
 499                           const wxString& caption = wxPyGetTextFromUserPromptStr,
 500                           const wxString& defaultValue = wxPyEmptyString,
 501                           long style = wxTextEntryDialogStyle,
 502                           const wxPoint& pos = wxDefaultPosition),
 503         "Constructor.  Use ShowModal method to show the dialog.", "");
 504
 505     DocDeclStr(
 506         wxString , GetValue(),
 507         "Returns the text that the user has entered if the user has pressed OK,
 508 or the original value if the user has pressed Cancel.", "");
 509
 510     DocDeclStr(
 511         void , SetValue(const wxString& value),
 512         "Sets the default text value.", "");
 513 };
 514
 515 //---------------------------------------------------------------------------
 516
 517 MAKE_CONST_WXSTRING(GetPasswordFromUserPromptStr);
 518
 519 class wxPasswordEntryDialog : public wxTextEntryDialog
 520 {
 521 public:
 522     wxPasswordEntryDialog(wxWindow *parent,
 523                       const wxString& message,
 524                       const wxString& caption = wxPyGetPasswordFromUserPromptStr,
 525                       const wxString& value = wxPyEmptyString,
 526                       long style = wxTextEntryDialogStyle,
 527                       const wxPoint& pos = wxDefaultPosition);
 528 };
 529
 530 //---------------------------------------------------------------------------
 531
 532 DocStr( wxNumberEntryDialog,
 533 "A dialog with spin control, ok and cancel buttons.", "")
 534
 535 MustHaveApp(wxNumberEntryDialog);
 536
 537 class wxNumberEntryDialog : public wxDialog
 538 {
 539 public:
 540     %pythonAppend wxNumberEntryDialog   "self._setOORInfo(self)"
 541
 542     DocCtorStr(
 543         wxNumberEntryDialog(wxWindow *parent,
 544                             const wxString& message,
 545                             const wxString& prompt,
 546                             const wxString& caption,
 547                             long value, long min, long max,
 548                             const wxPoint& pos = wxDefaultPosition),
 549         "Constructor.  Use ShowModal method to show the dialog.", "");
 550
 551     long GetValue();
 552 };
 553
 554 //---------------------------------------------------------------------------
 555
 556
 557 DocStr(wxFontData,
 558        "This class holds a variety of information related to font dialogs and
 559 is used to transfer settings to and results from a `wx.FontDialog`.", "");
 560
 561
 562 class wxFontData : public wxObject {
 563 public:
 564     wxFontData();
 565     ~wxFontData();
 566
 567     DocDeclStr(
 568         void , EnableEffects(bool enable),
 569         "Enables or disables 'effects' under MS Windows only. This refers to
 570 the controls for manipulating colour, strikeout and underline
 571 properties.  The default value is true.", "");
 572
 573     DocDeclStr(
 574         bool , GetAllowSymbols(),
 575         "Under MS Windows, returns a flag determining whether symbol fonts can
 576 be selected. Has no effect on other platforms. The default value is
 577 true.", "");
 578
 579     DocDeclStr(
 580         wxColour , GetColour(),
 581         "Gets the colour associated with the font dialog. The default value is
 582 black.", "");
 583
 584     DocDeclStr(
 585         wxFont , GetChosenFont(),
 586         "Gets the font chosen by the user.", "");
 587
 588     DocDeclStr(
 589         bool , GetEnableEffects(),
 590         "Determines whether 'effects' are enabled under Windows.", "");
 591
 592     DocDeclStr(
 593         wxFont , GetInitialFont(),
 594         "Gets the font that will be initially used by the font dialog. This
 595 should have previously been set by the application.", "");
 596
 597     DocDeclStr(
 598         bool , GetShowHelp(),
 599         "Returns true if the Help button will be shown (Windows only).  The
 600 default value is false.", "");
 601
 602     DocDeclStr(
 603         void , SetAllowSymbols(bool allowSymbols),
 604         "Under MS Windows, determines whether symbol fonts can be selected. Has
 605 no effect on other platforms.  The default value is true.", "");
 606
 607     DocDeclStr(
 608         void , SetChosenFont(const wxFont& font),
 609         "Sets the font that will be returned to the user (normally for internal
 610 use only).", "");
 611
 612     DocDeclStr(
 613         void , SetColour(const wxColour& colour),
 614         "Sets the colour that will be used for the font foreground colour.  The
 615 default colour is black.", "");
 616
 617     DocDeclStr(
 618         void , SetInitialFont(const wxFont& font),
 619         "Sets the font that will be initially used by the font dialog.", "");
 620
 621     DocDeclStr(
 622         void , SetRange(int min, int max),
 623         "Sets the valid range for the font point size (Windows only).  The
 624 default is 0, 0 (unrestricted range).", "");
 625
 626     DocDeclStr(
 627         void , SetShowHelp(bool showHelp),
 628         "Determines whether the Help button will be displayed in the font
 629 dialog (Windows only).  The default value is false.", "");
 630 };
 631
 632
 633
 634
 635 DocStr(wxFontDialog,
 636        "wx.FontDialog allows the user to select a system font and its attributes.
 637
 638 :see: `wx.FontData`
 639 ", "");
 640
 641 MustHaveApp(wxFontDialog);
 642
 643 class wxFontDialog : public wxDialog {
 644 public:
 645     %pythonAppend wxFontDialog   "self._setOORInfo(self)"
 646
 647     DocStr(wxFontDialog,
 648            "Constructor. Pass a parent window and the `wx.FontData` object to be
 649 used to initialize the dialog controls.  Call `ShowModal` to display
 650 the dialog.  If ShowModal returns ``wx.ID_OK`` then you can fetch the
 651 results with via the `wx.FontData` returned by `GetFontData`.", "");
 652     wxFontDialog(wxWindow* parent, const wxFontData& data);
 653
 654
 655     DocDeclStr(
 656         wxFontData& , GetFontData(),
 657         "Returns a reference to the internal `wx.FontData` used by the
 658 wx.FontDialog.", "");
 659 };
 660
 661
 662 wxFont wxGetFontFromUser(wxWindow *parent = NULL,
 663                          const wxFont& fontInit = wxNullFont,
 664                          const wxString& caption = wxPyEmptyString);
 665
 666
 667 //---------------------------------------------------------------------------
 668
 669
 670 DocStr(wxMessageDialog,
 671 "This class provides a simple dialog that shows a single or multi-line
 672 message, with a choice of OK, Yes, No and/or Cancel buttons.", "
 673
 674 Window Styles
 675 --------------
 676     ===================    =============================================
 677     wx.OK                  Show an OK button.
 678     wx.CANCEL              Show a Cancel button.
 679     wx.YES_NO              Show Yes and No buttons.
 680     wx.YES_DEFAULT         Used with wxYES_NO, makes Yes button the
 681                            default - which is the default behaviour.
 682     wx.NO_DEFAULT          Used with wxYES_NO, makes No button the default.
 683     wx.ICON_EXCLAMATION    Shows an exclamation mark icon.
 684     wx.ICON_HAND           Shows an error icon.
 685     wx.ICON_ERROR          Shows an error icon - the same as wxICON_HAND.
 686     wx.ICON_QUESTION       Shows a question mark icon.
 687     wx.ICON_INFORMATION    Shows an information (i) icon.
 688     wx.STAY_ON_TOP         The message box stays on top of all other
 689                            window, even those of the other applications
 690                            (Windows only).
 691     ===================    =============================================
 692 ");
 693
 694
 695 MustHaveApp(wxMessageDialog);
 696
 697 class wxMessageDialog : public wxDialog {
 698 public:
 699     %pythonAppend wxMessageDialog   "self._setOORInfo(self)"
 700
 701     DocCtorStr(
 702         wxMessageDialog(wxWindow* parent,
 703                         const wxString& message,
 704                         const wxString& caption = wxPyMessageBoxCaptionStr,
 705                         long style = wxOK | wxCANCEL | wxCENTRE,
 706                         const wxPoint& pos = wxDefaultPosition),
 707         "Constructor, use `ShowModal` to display the dialog.", "");
 708
 709 };
 710
 711 //---------------------------------------------------------------------------
 712
 713
 714 DocStr(wxProgressDialog,
 715 "A dialog that shows a short message and a progress bar. Optionally, it
 716 can display an ABORT button.", "
 717
 718 Window Styles
 719 --------------
 720     ====================     =============================================
 721     wx.PD_APP_MODAL          Make the progress dialog modal. If this flag is
 722                              not given, it is only \"locally\" modal -
 723                              that is the input to the parent window is
 724                              disabled, but not to the other ones.
 725
 726     wx.PD_AUTO_HIDE          Causes the progress dialog to disappear from
 727                              screen as soon as the maximum value of the
 728                              progress meter has been reached.
 729
 730     wx.PD_CAN_ABORT          This flag tells the dialog that it should have
 731                              a \"Cancel\" button which the user may press. If
 732                              this happens, the next call to Update() will
 733                              return False in the first component of its return
 734                              value.
 735
 736     wx.PD_CAN_SKIP           This flag tells the dialog that it should have a
 737                              \"Skip\" button which the user may press. If this
 738                              happens, the next call to Update() will return
 739                              True in the second component of its return value.
 740
 741     wx.PD_ELAPSED_TIME       This flag tells the dialog that it should show
 742                              elapsed time (since creating the dialog).
 743
 744     wx.PD_ESTIMATED_TIME     This flag tells the dialog that it should show
 745                              estimated time.
 746
 747     wx.PD_REMAINING_TIME     This flag tells the dialog that it should show
 748                              remaining time.
 749
 750     wx.PD_SMOOTH             Uses the wx.GA_SMOOTH style on the embedded
 751                              wx.Gauge widget.
 752     ====================     =============================================
 753 ");
 754
 755
 756 // TODO: wxPD_CAN_SKIP
 757
 758 MustHaveApp(wxProgressDialog);
 759
 760 class wxProgressDialog : public wxFrame {
 761 public:
 762     %pythonAppend wxProgressDialog   "self._setOORInfo(self)"
 763
 764     DocCtorStr(
 765         wxProgressDialog(const wxString& title,
 766                          const wxString& message,
 767                          int maximum = 100,
 768                          wxWindow* parent = NULL,
 769                          int style = wxPD_AUTO_HIDE | wxPD_APP_MODAL ),
 770         "Constructor. Creates the dialog, displays it and disables user input
 771 for other windows, or, if wx.PD_APP_MODAL flag is not given, for its
 772 parent window only.", "");
 773
 774     // TODO: support getting the skipped value back in the return value, but
 775     // only if style is set.  This is so the API doesn't change for existing
 776     // users...
 777     DocDeclAStr(
 778         virtual bool , Update(int value, const wxString& newmsg = wxPyEmptyString,
 779                               bool *OUTPUT),
 780         "Update(self, int value, String newmsg) --> (continue, skip)",
 781         "Updates the dialog, setting the progress bar to the new value and, if
 782 given changes the message above it. The value given should be less
 783 than or equal to the maximum value given to the constructor and the
 784 dialog is closed if it is equal to the maximum.  Returns a tuple of
 785 boolean values, ``(continue, skip)`` where ``continue`` is ``True``
 786 unless the Cancel button has been pressed, and ``skip`` is ``False``
 787 unless the Skip button (if any) has been pressed.
 788
 789 If the ``continue`` return value is ``false``, the application can either
 790 immediately destroy the dialog or ask the user for confirmation, and if the
 791 abort is not confirmed the dialog may be resumed with `Resume` function.
 792 ", "");
 793
 794     DocDeclStr(
 795         void , Resume(),
 796         "Can be used to continue with the dialog, after the user had chosen to
 797 abort.", "");
 798
 799 };
 800
 801 //---------------------------------------------------------------------------
 802
 803 enum wxFindReplaceFlags
 804 {
 805     // downward search/replace selected (otherwise - upwards)
 806     wxFR_DOWN       = 1,
 807
 808     // whole word search/replace selected
 809     wxFR_WHOLEWORD  = 2,
 810
 811     // case sensitive search/replace selected (otherwise - case insensitive)
 812     wxFR_MATCHCASE  = 4
 813 };
 814
 815
 816 enum wxFindReplaceDialogStyles
 817 {
 818     // replace dialog (otherwise find dialog)
 819     wxFR_REPLACEDIALOG = 1,
 820
 821     // don't allow changing the search direction
 822     wxFR_NOUPDOWN      = 2,
 823
 824     // don't allow case sensitive searching
 825     wxFR_NOMATCHCASE   = 4,
 826
 827     // don't allow whole word searching
 828     wxFR_NOWHOLEWORD   = 8
 829 };
 830
 831
 832
 833 %constant wxEventType wxEVT_COMMAND_FIND;
 834 %constant wxEventType wxEVT_COMMAND_FIND_NEXT;
 835 %constant wxEventType wxEVT_COMMAND_FIND_REPLACE;
 836 %constant wxEventType wxEVT_COMMAND_FIND_REPLACE_ALL;
 837 %constant wxEventType wxEVT_COMMAND_FIND_CLOSE;
 838
 839
 840 %pythoncode {
 841 EVT_FIND = wx.PyEventBinder( wxEVT_COMMAND_FIND, 1 )
 842 EVT_FIND_NEXT = wx.PyEventBinder( wxEVT_COMMAND_FIND_NEXT, 1 )
 843 EVT_FIND_REPLACE = wx.PyEventBinder( wxEVT_COMMAND_FIND_REPLACE, 1 )
 844 EVT_FIND_REPLACE_ALL = wx.PyEventBinder( wxEVT_COMMAND_FIND_REPLACE_ALL, 1 )
 845 EVT_FIND_CLOSE = wx.PyEventBinder( wxEVT_COMMAND_FIND_CLOSE, 1 )
 846
 847 %# For backwards compatibility.  Should they be removed?
 848 EVT_COMMAND_FIND             = EVT_FIND
 849 EVT_COMMAND_FIND_NEXT        = EVT_FIND_NEXT
 850 EVT_COMMAND_FIND_REPLACE     = EVT_FIND_REPLACE
 851 EVT_COMMAND_FIND_REPLACE_ALL = EVT_FIND_REPLACE_ALL
 852 EVT_COMMAND_FIND_CLOSE       = EVT_FIND_CLOSE
 853 }
 854
 855
 856 DocStr(wxFindDialogEvent,
 857        "Events for the FindReplaceDialog", "");
 858
 859 class wxFindDialogEvent : public wxCommandEvent
 860 {
 861 public:
 862     wxFindDialogEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 863
 864     DocDeclStr(
 865         int , GetFlags(),
 866         "Get the currently selected flags: this is the combination of
 867 wx.FR_DOWN, wx.FR_WHOLEWORD and wx.FR_MATCHCASE flags.", "");
 868
 869     DocDeclStr(
 870         const wxString& , GetFindString(),
 871         "Return the string to find (never empty).", "");
 872
 873     DocDeclStr(
 874         const wxString& , GetReplaceString(),
 875         "Return the string to replace the search string with (only for replace
 876 and replace all events).", "");
 877
 878     DocDeclStr(
 879         wxFindReplaceDialog *, GetDialog(),
 880         "Return the pointer to the dialog which generated this event.", "");
 881
 882     DocDeclStr(
 883         void , SetFlags(int flags),
 884         "", "");
 885
 886     DocDeclStr(
 887         void , SetFindString(const wxString& str),
 888         "", "");
 889
 890     DocDeclStr(
 891         void , SetReplaceString(const wxString& str),
 892         "", "");
 893 };
 894
 895
 896
 897 DocStr(wxFindReplaceData,
 898 "wx.FindReplaceData holds the data for wx.FindReplaceDialog. It is used
 899 to initialize the dialog with the default values and will keep the
 900 last values from the dialog when it is closed. It is also updated each
 901 time a `wx.FindDialogEvent` is generated so instead of using the
 902 `wx.FindDialogEvent` methods you can also directly query this object.
 903
 904 Note that all SetXXX() methods may only be called before showing the
 905 dialog and calling them has no effect later.", "
 906
 907 Flags
 908 -----
 909     ================   ===============================================
 910     wx.FR_DOWN         Downward search/replace selected (otherwise,
 911                        upwards)
 912
 913     wx.FR_WHOLEWORD    Whole word search/replace selected
 914
 915     wx.FR_MATCHCASE    Case sensitive search/replace selected
 916                        (otherwise, case insensitive)
 917     ================   ===============================================
 918 ");
 919
 920
 921
 922
 923 class wxFindReplaceData : public wxObject
 924 {
 925 public:
 926     DocCtorStr(
 927         wxFindReplaceData(int flags=0),
 928         "Constuctor initializes the flags to default value (0).", "");
 929
 930     ~wxFindReplaceData();
 931
 932
 933     DocDeclStr(
 934         const wxString& , GetFindString(),
 935         "Get the string to find.", "");
 936
 937     DocDeclStr(
 938         const wxString& , GetReplaceString(),
 939         "Get the replacement string.", "");
 940
 941     DocDeclStr(
 942         int , GetFlags(),
 943         "Get the combination of flag values.", "");
 944
 945     DocDeclStr(
 946         void , SetFlags(int flags),
 947         "Set the flags to use to initialize the controls of the dialog.", "");
 948
 949     DocDeclStr(
 950         void , SetFindString(const wxString& str),
 951         "Set the string to find (used as initial value by the dialog).", "");
 952
 953     DocDeclStr(
 954         void , SetReplaceString(const wxString& str),
 955         "Set the replacement string (used as initial value by the dialog).", "");
 956
 957 };
 958
 959
 960
 961
 962 DocStr(wxFindReplaceDialog,
 963 "wx.FindReplaceDialog is a standard modeless dialog which is used to
 964 allow the user to search for some text (and possibly replace it with
 965 something else). The actual searching is supposed to be done in the
 966 owner window which is the parent of this dialog. Note that it means
 967 that unlike for the other standard dialogs this one must have a parent
 968 window. Also note that there is no way to use this dialog in a modal
 969 way; it is always, by design and implementation, modeless.", "
 970
 971
 972 Window Styles
 973 -------------
 974
 975     =====================  =========================================
 976     wx.FR_REPLACEDIALOG    replace dialog (otherwise find dialog)
 977
 978     wx.FR_NOUPDOWN         don't allow changing the search direction
 979
 980     wx.FR_NOMATCHCASE      don't allow case sensitive searching
 981
 982     wx.FR_NOWHOLEWORD      don't allow whole word searching
 983     =====================  =========================================
 984 ");
 985
 986 MustHaveApp(wxFindReplaceDialog);
 987
 988 class wxFindReplaceDialog : public wxDialog {
 989 public:
 990     %pythonAppend wxFindReplaceDialog     "self._setOORInfo(self)"
 991     %pythonAppend wxFindReplaceDialog()   ""
 992
 993     DocCtorStr(
 994         wxFindReplaceDialog(wxWindow *parent,
 995                             wxFindReplaceData *data,
 996                             const wxString &title,
 997                             int style = 0),
 998         "Create a FindReplaceDialog.  The parent and data parameters must be
 999 non-None.  Use Show to display the dialog.", "");
1000
1001     DocCtorStrName(
1002         wxFindReplaceDialog(),
1003         "Precreate a FindReplaceDialog for 2-phase creation", "",
1004         PreFindReplaceDialog);
1005
1006
1007     DocDeclStr(
1008         bool , Create(wxWindow *parent, wxFindReplaceData *data,
1009                       const wxString &title, int style = 0),
1010         "Create the dialog, for 2-phase create.", "");
1011
1012
1013     DocDeclStr(
1014         const wxFindReplaceData *, GetData(),
1015         "Get the FindReplaceData object used by this dialog.", "");
1016
1017     DocDeclStr(
1018         void , SetData(wxFindReplaceData *data),
1019         "Set the FindReplaceData object used by this dialog.", "");
1020
1021 };
1022
1023 //---------------------------------------------------------------------------
1024 //---------------------------------------------------------------------------