wxPython/src/misc2.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        misc2.i
   3 // Purpose:     Definitions of miscelaneous functions and classes that need
   4 //              to know about wxWindow.  (So they can't be in misc.i or an
   5 //              import loop will happen.)
   6 //
   7 // Author:      Robin Dunn
   8 //
   9 // Created:     18-June-1999
  10 // RCS-ID:      $Id$
  11 // Copyright:   (c) 1998 by Total Control Software
  12 // Licence:     wxWindows license
  13 /////////////////////////////////////////////////////////////////////////////
  14
  15 %module misc2
  16
  17 %{
  18 #include "helpers.h"
  19 #include "pyistream.h"
  20 #include <wx/resource.h>
  21 #include <wx/tooltip.h>
  22 #include <wx/caret.h>
  23 #include <wx/tipdlg.h>
  24 #include <wx/process.h>
  25
  26 #if wxUSE_JOYSTICK || defined(__WXMSW__)
  27 #include <wx/joystick.h>
  28 #endif
  29
  30 #if wxUSE_WAVE || defined(__WXMSW__)
  31 #include <wx/wave.h>
  32 #endif
  33
  34 #include <wx/mimetype.h>
  35 %}
  36
  37 //----------------------------------------------------------------------
  38
  39 %include typemaps.i
  40 %include my_typemaps.i
  41
  42 // Import some definitions of other classes, etc.
  43 %import _defs.i
  44 %import windows.i
  45 %import misc.i
  46 %import gdi.i
  47 %import events.i
  48 %import streams.i
  49 %import utils.i
  50
  51
  52 //----------------------------------------------------------------------
  53
  54 %{
  55     // Put some wx default wxChar* values into wxStrings.
  56     DECLARE_DEF_STRING(FileSelectorPromptStr);
  57     DECLARE_DEF_STRING(FileSelectorDefaultWildcardStr);
  58     DECLARE_DEF_STRING(DirSelectorPromptStr);
  59     static const wxString wxPyEmptyString(wxT(""));
  60 %}
  61
  62 //---------------------------------------------------------------------------
  63 // Dialog Functions
  64
  65 wxString wxFileSelector(const wxString& message = wxPyFileSelectorPromptStr,
  66                         const wxString& default_path = wxPyEmptyString,
  67                         const wxString& default_filename = wxPyEmptyString,
  68                         const wxString& default_extension = wxPyEmptyString,
  69                         const wxString& wildcard = wxPyFileSelectorDefaultWildcardStr,
  70                         int flags = 0,
  71                         wxWindow *parent = NULL,
  72                         int x = -1, int y = -1);
  73
  74 // Ask for filename to load
  75 wxString wxLoadFileSelector(const wxString& what,
  76                             const wxString& extension,
  77                             const wxString& default_name = wxPyEmptyString,
  78                             wxWindow *parent = NULL);
  79
  80 // Ask for filename to save
  81 wxString wxSaveFileSelector(const wxString& what,
  82                             const wxString& extension,
  83                             const wxString& default_name = wxPyEmptyString,
  84                             wxWindow *parent = NULL);
  85
  86
  87 wxString wxDirSelector(const wxString& message = wxPyDirSelectorPromptStr,
  88                        const wxString& defaultPath = wxPyEmptyString,
  89                        long style = wxDD_DEFAULT_STYLE,
  90                        const wxPoint& pos = wxDefaultPosition,
  91                        wxWindow *parent = NULL);
  92
  93 wxString wxGetTextFromUser(const wxString& message,
  94                            const wxString& caption = wxPyEmptyString,
  95                            const wxString& default_value = wxPyEmptyString,
  96                            wxWindow *parent = NULL,
  97                            int x = -1, int y = -1,
  98                            bool centre = TRUE);
  99
 100 wxString wxGetPasswordFromUser(const wxString& message,
 101                                const wxString& caption = wxPyEmptyString,
 102                                const wxString& default_value = wxPyEmptyString,
 103                                wxWindow *parent = NULL);
 104
 105
 106 // TODO: Need to custom wrap this one...
 107 // int wxGetMultipleChoice(char* message, char* caption,
 108 //                         int LCOUNT, char** choices,
 109 //                         int nsel, int *selection,
 110 //                         wxWindow *parent = NULL, int x = -1, int y = -1,
 111 //                         bool centre = TRUE, int width=150, int height=200);
 112
 113
 114 wxString wxGetSingleChoice(const wxString& message, const wxString& caption,
 115                            int LCOUNT, wxString* choices,
 116                            wxWindow *parent = NULL,
 117                            int x = -1, int y = -1,
 118                            bool centre = TRUE,
 119                            int width=150, int height=200);
 120
 121 int wxGetSingleChoiceIndex(const wxString& message, const wxString& caption,
 122                            int LCOUNT, wxString* choices,
 123                            wxWindow *parent = NULL,
 124                            int x = -1, int y = -1,
 125                            bool centre = TRUE,
 126                            int width=150, int height=200);
 127
 128
 129 int wxMessageBox(const wxString& message,
 130                  const wxString& caption = wxPyEmptyString,
 131                  int style = wxOK | wxCENTRE,
 132                  wxWindow *parent = NULL,
 133                  int x = -1, int y = -1);
 134
 135 long wxGetNumberFromUser(const wxString& message,
 136                          const wxString& prompt,
 137                          const wxString& caption,
 138                          long value,
 139                          long min = 0, long max = 100,
 140                          wxWindow *parent = NULL,
 141                          const wxPoint& pos = wxDefaultPosition);
 142
 143 //---------------------------------------------------------------------------
 144 // GDI Functions
 145
 146 bool wxColourDisplay();
 147
 148 int wxDisplayDepth();
 149 int wxGetDisplayDepth();
 150
 151 void   wxDisplaySize(int* OUTPUT, int* OUTPUT);
 152 wxSize wxGetDisplaySize();
 153
 154 void   wxDisplaySizeMM(int* OUTPUT, int* OUTPUT);
 155 wxSize wxGetDisplaySizeMM();
 156
 157 void   wxClientDisplayRect(int *OUTPUT, int *OUTPUT, int *OUTPUT, int *OUTPUT);
 158 wxRect wxGetClientDisplayRect();
 159
 160 void wxSetCursor(wxCursor& cursor);
 161
 162 //----------------------------------------------------------------------
 163 // Miscellaneous functions
 164
 165 void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
 166 wxWindow * wxGetActiveWindow();
 167
 168 wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
 169 wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
 170
 171 #ifdef __WXMSW__
 172 bool wxCheckForInterrupt(wxWindow *wnd);
 173 void wxFlushEvents();
 174 #endif
 175
 176 wxWindow* wxGetTopLevelParent(wxWindow *win);
 177
 178 //---------------------------------------------------------------------------
 179 // Resource System
 180
 181 bool wxResourceAddIdentifier(char* name, int value);
 182 void wxResourceClear(void);
 183 wxBitmap  wxResourceCreateBitmap(char* resource);
 184 wxIcon  wxResourceCreateIcon(char* resource);
 185 wxMenuBar * wxResourceCreateMenuBar(char* resource);
 186 int wxResourceGetIdentifier(char* name);
 187 bool wxResourceParseData(char* resource, wxResourceTable *table = NULL);
 188 bool wxResourceParseFile(char* filename, wxResourceTable *table = NULL);
 189 bool wxResourceParseString(char* resource, wxResourceTable *table = NULL);
 190
 191 //---------------------------------------------------------------------------
 192 // System Settings
 193
 194 // possible values for wxSystemSettings::GetFont() parameter
 195 //
 196 enum wxSystemFont
 197 {
 198     wxSYS_OEM_FIXED_FONT = 10,
 199     wxSYS_ANSI_FIXED_FONT,
 200     wxSYS_ANSI_VAR_FONT,
 201     wxSYS_SYSTEM_FONT,
 202     wxSYS_DEVICE_DEFAULT_FONT,
 203     wxSYS_DEFAULT_PALETTE,
 204     wxSYS_SYSTEM_FIXED_FONT,
 205     wxSYS_DEFAULT_GUI_FONT
 206 };
 207
 208 // possible values for wxSystemSettings::GetColour() parameter
 209 //
 210 enum wxSystemColour
 211 {
 212     wxSYS_COLOUR_SCROLLBAR,
 213     wxSYS_COLOUR_BACKGROUND,
 214     wxSYS_COLOUR_DESKTOP = wxSYS_COLOUR_BACKGROUND,
 215     wxSYS_COLOUR_ACTIVECAPTION,
 216     wxSYS_COLOUR_INACTIVECAPTION,
 217     wxSYS_COLOUR_MENU,
 218     wxSYS_COLOUR_WINDOW,
 219     wxSYS_COLOUR_WINDOWFRAME,
 220     wxSYS_COLOUR_MENUTEXT,
 221     wxSYS_COLOUR_WINDOWTEXT,
 222     wxSYS_COLOUR_CAPTIONTEXT,
 223     wxSYS_COLOUR_ACTIVEBORDER,
 224     wxSYS_COLOUR_INACTIVEBORDER,
 225     wxSYS_COLOUR_APPWORKSPACE,
 226     wxSYS_COLOUR_HIGHLIGHT,
 227     wxSYS_COLOUR_HIGHLIGHTTEXT,
 228     wxSYS_COLOUR_BTNFACE,
 229     wxSYS_COLOUR_3DFACE = wxSYS_COLOUR_BTNFACE,
 230     wxSYS_COLOUR_BTNSHADOW,
 231     wxSYS_COLOUR_3DSHADOW = wxSYS_COLOUR_BTNSHADOW,
 232     wxSYS_COLOUR_GRAYTEXT,
 233     wxSYS_COLOUR_BTNTEXT,
 234     wxSYS_COLOUR_INACTIVECAPTIONTEXT,
 235     wxSYS_COLOUR_BTNHIGHLIGHT,
 236     wxSYS_COLOUR_BTNHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
 237     wxSYS_COLOUR_3DHIGHLIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
 238     wxSYS_COLOUR_3DHILIGHT = wxSYS_COLOUR_BTNHIGHLIGHT,
 239     wxSYS_COLOUR_3DDKSHADOW,
 240     wxSYS_COLOUR_3DLIGHT,
 241     wxSYS_COLOUR_INFOTEXT,
 242     wxSYS_COLOUR_INFOBK,
 243     wxSYS_COLOUR_LISTBOX,
 244     wxSYS_COLOUR_HOTLIGHT,
 245     wxSYS_COLOUR_GRADIENTACTIVECAPTION,
 246     wxSYS_COLOUR_GRADIENTINACTIVECAPTION,
 247     wxSYS_COLOUR_MENUHILIGHT,
 248     wxSYS_COLOUR_MENUBAR,
 249
 250     wxSYS_COLOUR_MAX
 251 };
 252
 253 // possible values for wxSystemSettings::GetMetric() parameter
 254 //
 255 enum wxSystemMetric
 256 {
 257     wxSYS_MOUSE_BUTTONS = 1,
 258     wxSYS_BORDER_X,
 259     wxSYS_BORDER_Y,
 260     wxSYS_CURSOR_X,
 261     wxSYS_CURSOR_Y,
 262     wxSYS_DCLICK_X,
 263     wxSYS_DCLICK_Y,
 264     wxSYS_DRAG_X,
 265     wxSYS_DRAG_Y,
 266     wxSYS_EDGE_X,
 267     wxSYS_EDGE_Y,
 268     wxSYS_HSCROLL_ARROW_X,
 269     wxSYS_HSCROLL_ARROW_Y,
 270     wxSYS_HTHUMB_X,
 271     wxSYS_ICON_X,
 272     wxSYS_ICON_Y,
 273     wxSYS_ICONSPACING_X,
 274     wxSYS_ICONSPACING_Y,
 275     wxSYS_WINDOWMIN_X,
 276     wxSYS_WINDOWMIN_Y,
 277     wxSYS_SCREEN_X,
 278     wxSYS_SCREEN_Y,
 279     wxSYS_FRAMESIZE_X,
 280     wxSYS_FRAMESIZE_Y,
 281     wxSYS_SMALLICON_X,
 282     wxSYS_SMALLICON_Y,
 283     wxSYS_HSCROLL_Y,
 284     wxSYS_VSCROLL_X,
 285     wxSYS_VSCROLL_ARROW_X,
 286     wxSYS_VSCROLL_ARROW_Y,
 287     wxSYS_VTHUMB_Y,
 288     wxSYS_CAPTION_Y,
 289     wxSYS_MENU_Y,
 290     wxSYS_NETWORK_PRESENT,
 291     wxSYS_PENWINDOWS_PRESENT,
 292     wxSYS_SHOW_SOUNDS,
 293     wxSYS_SWAP_BUTTONS
 294 };
 295
 296 // possible values for wxSystemSettings::HasFeature() parameter
 297 enum wxSystemFeature
 298 {
 299     wxSYS_CAN_DRAW_FRAME_DECORATIONS = 1,
 300     wxSYS_CAN_ICONIZE_FRAME
 301 };
 302
 303 enum wxSystemScreenType
 304 {
 305     wxSYS_SCREEN_NONE = 0,  //   not yet defined
 306
 307     wxSYS_SCREEN_TINY,      //   <
 308     wxSYS_SCREEN_PDA,       //   >= 320x240
 309     wxSYS_SCREEN_SMALL,     //   >= 640x480
 310     wxSYS_SCREEN_DESKTOP    //   >= 800x600
 311 };
 312
 313
 314 class wxSystemSettings {
 315 public:
 316     // get a standard system colour
 317     static wxColour GetColour(wxSystemColour index);
 318
 319     // get a standard system font
 320     static wxFont GetFont(wxSystemFont index);
 321
 322     // get a system-dependent metric
 323     static int GetMetric(wxSystemMetric index);
 324
 325     // return true if the port has certain feature
 326     static bool HasFeature(wxSystemFeature index);
 327
 328    // Get system screen design (desktop, pda, ..) used for
 329    // laying out various dialogs.
 330    static wxSystemScreenType GetScreenType();
 331
 332    // Override default.
 333    static void SetScreenType( wxSystemScreenType screen );
 334
 335 };
 336
 337
 338
 339 //---------------------------------------------------------------------------
 340 // wxToolTip
 341
 342 class wxToolTip : public wxObject {
 343 public:
 344     wxToolTip(const wxString &tip);
 345
 346     void SetTip(const wxString& tip);
 347     wxString GetTip();
 348     // *** Not in the "public" interface void SetWindow(wxWindow *win);
 349     wxWindow *GetWindow();
 350
 351     static void Enable(bool flag);
 352     static void SetDelay(long milliseconds);
 353 };
 354
 355 //----------------------------------------------------------------------
 356
 357 class wxCaret {
 358 public:
 359     wxCaret(wxWindow* window, const wxSize& size);
 360     ~wxCaret();
 361
 362     bool IsOk();
 363     bool IsVisible();
 364     %name(GetPositionTuple)void GetPosition(int *OUTPUT, int *OUTPUT);
 365     wxPoint GetPosition();
 366     %name(GetSizeTuple)void GetSize(int *OUTPUT, int *OUTPUT);
 367     wxSize GetSize();
 368     wxWindow *GetWindow();
 369     %name(MoveXY)void Move(int x, int y);
 370     void Move(const wxPoint& pt);
 371     %name(SetSizeWH) void SetSize(int width, int height);
 372     void SetSize(const wxSize& size);
 373     void Show(int show = TRUE);
 374     void Hide();
 375 };
 376
 377 %inline %{
 378     int wxCaret_GetBlinkTime() {
 379         return wxCaret::GetBlinkTime();
 380     }
 381
 382     void wxCaret_SetBlinkTime(int milliseconds) {
 383         wxCaret::SetBlinkTime(milliseconds);
 384     }
 385 %}
 386
 387 //----------------------------------------------------------------------
 388
 389 class  wxBusyCursor {
 390 public:
 391     wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR);
 392     ~wxBusyCursor();
 393 };
 394
 395 //----------------------------------------------------------------------
 396
 397 class wxWindowDisabler {
 398 public:
 399     wxWindowDisabler(wxWindow *winToSkip = NULL);
 400     ~wxWindowDisabler();
 401 };
 402
 403 //----------------------------------------------------------------------
 404
 405 bool wxSafeYield(wxWindow* win=NULL);
 406 void wxPostEvent(wxEvtHandler *dest, wxEvent& event);
 407 void wxWakeUpIdle();
 408
 409
 410 #ifdef __WXMSW__
 411 void wxWakeUpMainThread();
 412 #endif
 413
 414 void wxMutexGuiEnter();
 415 void wxMutexGuiLeave();
 416
 417
 418 class wxMutexGuiLocker  {
 419 public:
 420     wxMutexGuiLocker();
 421     ~wxMutexGuiLocker();
 422 };
 423
 424
 425 %inline %{
 426     bool wxThread_IsMain() {
 427 #ifdef WXP_WITH_THREAD
 428         return wxThread::IsMain();
 429 #else
 430         return TRUE;
 431 #endif
 432     }
 433 %}
 434
 435 //----------------------------------------------------------------------
 436
 437
 438 class wxTipProvider
 439 {
 440 public:
 441     // wxTipProvider(size_t currentTip);  **** Abstract base class
 442     ~wxTipProvider();
 443
 444     virtual wxString GetTip() = 0;
 445     size_t GetCurrentTip();
 446
 447 };
 448
 449
 450 // The C++ version of wxPyTipProvider
 451 %{
 452 class wxPyTipProvider : public wxTipProvider {
 453 public:
 454     wxPyTipProvider(size_t currentTip)
 455         : wxTipProvider(currentTip) {}
 456
 457     DEC_PYCALLBACK_STRING__pure(GetTip);
 458
 459     PYPRIVATE;
 460 };
 461
 462 IMP_PYCALLBACK_STRING__pure( wxPyTipProvider, wxTipProvider, GetTip);
 463
 464 %}
 465
 466
 467 // Now let SWIG know about it
 468 class wxPyTipProvider : public wxTipProvider {
 469 public:
 470     wxPyTipProvider(size_t currentTip);
 471
 472     void _setCallbackInfo(PyObject* self, PyObject* _class);
 473     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyTipProvider)"
 474 };
 475
 476
 477
 478 bool wxShowTip(wxWindow *parent, wxTipProvider *tipProvider, bool showAtStartup = TRUE);
 479 %new wxTipProvider * wxCreateFileTipProvider(const wxString& filename, size_t currentTip);
 480
 481
 482 //----------------------------------------------------------------------
 483
 484 %{
 485 #include <wx/generic/dragimgg.h>
 486 %}
 487
 488 %name (wxDragImage) class wxGenericDragImage : public wxObject
 489 {
 490 public:
 491
 492     wxGenericDragImage(const wxBitmap& image,
 493                        const wxCursor& cursor = wxNullCursor);
 494     %name(wxDragIcon)wxGenericDragImage(const wxIcon& image,
 495                                         const wxCursor& cursor = wxNullCursor);
 496     %name(wxDragString)wxGenericDragImage(const wxString& str,
 497                                           const wxCursor& cursor = wxNullCursor);
 498     %name(wxDragTreeItem)wxGenericDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id);
 499     %name(wxDragListItem)wxGenericDragImage(const wxListCtrl& listCtrl, long id);
 500
 501     ~wxGenericDragImage();
 502
 503     void SetBackingBitmap(wxBitmap* bitmap);
 504     bool BeginDrag(const wxPoint& hotspot, wxWindow* window,
 505                    bool fullScreen = FALSE, wxRect* rect = NULL);
 506
 507     %name(BeginDrag2) bool BeginDrag(const wxPoint& hotspot, wxWindow* window,
 508                                      wxWindow* fullScreenRect);
 509
 510     bool EndDrag();
 511     bool Move(const wxPoint& pt);
 512     bool Show();
 513     bool Hide();
 514
 515     wxRect GetImageRect(const wxPoint& pos) const;
 516     bool RedrawImage(const wxPoint& oldPos, const wxPoint& newPos,
 517                      bool eraseOld, bool drawNew);
 518 };
 519
 520
 521 //----------------------------------------------------------------------
 522
 523 class wxPyTimer : public wxObject {
 524 public:
 525     wxPyTimer(PyObject* notify);
 526     ~wxPyTimer();
 527     int GetInterval();
 528     bool IsOneShot();
 529     bool IsRunning();
 530     void SetOwner(wxEvtHandler *owner, int id = -1);
 531     void Start(int milliseconds=-1, int oneShot=FALSE);
 532     void Stop();
 533 };
 534
 535
 536 class wxStopWatch
 537 {
 538 public:
 539     // ctor starts the stop watch
 540     wxStopWatch();
 541     ~wxStopWatch();
 542     void Start(long t = 0);
 543     void Pause();
 544     void Resume();
 545
 546     // get elapsed time since the last Start() or Pause() in milliseconds
 547     long Time() const;
 548 };
 549
 550
 551 //----------------------------------------------------------------------
 552 //----------------------------------------------------------------------
 553
 554
 555 enum
 556 {
 557     wxLOG_FatalError, // program can't continue, abort immediately
 558     wxLOG_Error,      // a serious error, user must be informed about it
 559     wxLOG_Warning,    // user is normally informed about it but may be ignored
 560     wxLOG_Message,    // normal message (i.e. normal output of a non GUI app)
 561     wxLOG_Info,       // informational message (a.k.a. 'Verbose')
 562     wxLOG_Status,     // informational: might go to the status line of GUI app
 563     wxLOG_Debug,      // never shown to the user, disabled in release mode
 564     wxLOG_Trace,      // trace messages are also only enabled in debug mode
 565     wxLOG_Progress,   // used for progress indicator (not yet)
 566     wxLOG_User = 100  // user defined levels start here
 567 };
 568
 569 #define wxTRACE_MemAlloc "memalloc" // trace memory allocation (new/delete)
 570 #define wxTRACE_Messages "messages" // trace window messages/X callbacks
 571 #define wxTRACE_ResAlloc "resalloc" // trace GDI resource allocation
 572 #define wxTRACE_RefCount "refcount" // trace various ref counting operations
 573
 574 #ifdef  __WXMSW__
 575 #define wxTRACE_OleCalls "ole"      // OLE interface calls
 576 #endif
 577
 578 enum {
 579     wxTraceMemAlloc,
 580     wxTraceMessages,
 581     wxTraceResAlloc,
 582     wxTraceRefCount,
 583
 584 #ifdef  __WXMSW__
 585     wxTraceOleCalls,
 586 #endif
 587 };
 588
 589
 590
 591 class wxLog
 592 {
 593 public:
 594     wxLog();
 595
 596     static bool IsEnabled();
 597     static bool EnableLogging(bool doIt = TRUE);
 598     static void OnLog(unsigned long level, const wxString& szString, int t=0);
 599
 600     virtual void Flush();
 601     bool HasPendingMessages() const;
 602
 603     static void FlushActive();
 604     static wxLog *GetActiveTarget();
 605     static wxLog *SetActiveTarget(wxLog *pLogger);
 606
 607     static void Suspend();
 608     static void Resume();
 609
 610     static void SetVerbose(bool bVerbose = TRUE);
 611
 612     static void DontCreateOnDemand();
 613     static void SetTraceMask(long ulMask);
 614     static void AddTraceMask(const wxString& str);
 615     static void RemoveTraceMask(const wxString& str);
 616     static void ClearTraceMasks();
 617
 618     static void SetTimestamp(const wxString& ts);
 619     static const wxString& GetTimestamp();
 620
 621     bool GetVerbose() const;
 622
 623     static unsigned long GetTraceMask();
 624     static bool IsAllowedTraceMask(const wxString& mask);
 625
 626     // static void TimeStamp(wxString *str);
 627     %addmethods {
 628         wxString TimeStamp() {
 629             wxString msg;
 630             wxLog::TimeStamp(&msg);
 631             return msg;
 632         }
 633     }
 634
 635 };
 636
 637
 638 class wxLogStderr : public wxLog
 639 {
 640 public:
 641     wxLogStderr(/* TODO: FILE *fp = (FILE *) NULL*/);
 642 };
 643
 644
 645 class wxLogTextCtrl : public wxLog
 646 {
 647 public:
 648     wxLogTextCtrl(wxTextCtrl *pTextCtrl);
 649 };
 650
 651
 652 class wxLogGui : public wxLog
 653 {
 654 public:
 655     wxLogGui();
 656 };
 657
 658 class wxLogWindow : public wxLog
 659 {
 660 public:
 661     wxLogWindow(wxFrame *pParent,         // the parent frame (can be NULL)
 662             const wxString& szTitle,      // the title of the frame
 663             bool bShow = TRUE,            // show window immediately?
 664             bool bPassToOld = TRUE);      // pass log messages to the old target?
 665
 666     void Show(bool bShow = TRUE);
 667     wxFrame *GetFrame() const;
 668     wxLog *GetOldLog() const;
 669     bool IsPassingMessages() const;
 670     void PassMessages(bool bDoPass);
 671 };
 672
 673
 674 class wxLogChain : public wxLog
 675 {
 676 public:
 677     wxLogChain(wxLog *logger);
 678     void SetLog(wxLog *logger);
 679     void PassMessages(bool bDoPass);
 680     bool IsPassingMessages();
 681     wxLog *GetOldLog();
 682 };
 683
 684
 685 unsigned long wxSysErrorCode();
 686 const wxString wxSysErrorMsg(unsigned long nErrCode = 0);
 687 void wxLogFatalError(const wxString& msg);
 688 void wxLogError(const wxString& msg);
 689 void wxLogWarning(const wxString& msg);
 690 void wxLogMessage(const wxString& msg);
 691 void wxLogInfo(const wxString& msg);
 692 void wxLogVerbose(const wxString& msg);
 693 void wxLogStatus(const wxString& msg);
 694 %name(wxLogStatusFrame)void wxLogStatus(wxFrame *pFrame, const wxString& msg);
 695 void wxLogSysError(const wxString& msg);
 696
 697 void wxLogTrace(const wxString& msg);
 698 %name(wxLogTraceMask)void wxLogTrace(const wxString& mask, const wxString& msg);
 699
 700 void wxLogGeneric(unsigned long level, const wxString& msg);
 701
 702 // wxLogFatalError helper: show the (fatal) error to the user in a safe way,
 703 // i.e. without using wxMessageBox() for example because it could crash
 704 void wxSafeShowMessage(const wxString& title, const wxString& text);
 705
 706
 707
 708 // Suspress logging while an instance of this class exists
 709 class wxLogNull
 710 {
 711 public:
 712     wxLogNull();
 713     ~wxLogNull();
 714 };
 715
 716
 717
 718
 719 %{
 720 // A wxLog class that can be derived from in wxPython
 721 class wxPyLog : public wxLog {
 722 public:
 723     wxPyLog() : wxLog() {}
 724
 725     virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t) {
 726         bool found;
 727         wxPyBeginBlockThreads();
 728         if ((found = wxPyCBH_findCallback(m_myInst, "DoLog"))) {
 729             PyObject* s = wx2PyString(szString);
 730             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iOi)", level, s, t));
 731             Py_DECREF(s);
 732         }
 733         wxPyEndBlockThreads();
 734         if (! found)
 735             wxLog::DoLog(level, szString, t);
 736     }
 737
 738     virtual void DoLogString(const wxChar *szString, time_t t) {
 739         bool found;
 740         wxPyBeginBlockThreads();
 741         if ((found = wxPyCBH_findCallback(m_myInst, "DoLogString"))) {
 742             PyObject* s = wx2PyString(szString);
 743             wxPyCBH_callCallback(m_myInst, Py_BuildValue("(Oi)", s, t));
 744             Py_DECREF(s);
 745         }
 746         wxPyEndBlockThreads();
 747         if (! found)
 748             wxLog::DoLogString(szString, t);
 749     }
 750
 751     PYPRIVATE;
 752 };
 753 %}
 754
 755 // Now tell SWIG about it
 756 class wxPyLog : public wxLog {
 757 public:
 758     wxPyLog();
 759     void _setCallbackInfo(PyObject* self, PyObject* _class);
 760     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyLog)"
 761     %addmethods { void Destroy() { delete self; } }
 762
 763 };
 764
 765
 766 //----------------------------------------------------------------------
 767
 768
 769 enum wxKillError
 770 {
 771     wxKILL_OK,              // no error
 772     wxKILL_BAD_SIGNAL,      // no such signal
 773     wxKILL_ACCESS_DENIED,   // permission denied
 774     wxKILL_NO_PROCESS,      // no such process
 775     wxKILL_ERROR            // another, unspecified error
 776 };
 777
 778 enum wxSignal
 779 {
 780     wxSIGNONE = 0,  // verify if the process exists under Unix
 781     wxSIGHUP,
 782     wxSIGINT,
 783     wxSIGQUIT,
 784     wxSIGILL,
 785     wxSIGTRAP,
 786     wxSIGABRT,
 787     wxSIGIOT = wxSIGABRT,   // another name
 788     wxSIGEMT,
 789     wxSIGFPE,
 790     wxSIGKILL,
 791     wxSIGBUS,
 792     wxSIGSEGV,
 793     wxSIGSYS,
 794     wxSIGPIPE,
 795     wxSIGALRM,
 796     wxSIGTERM
 797
 798     // further signals are different in meaning between different Unix systems
 799 };
 800
 801
 802
 803 enum {
 804     /* event type */
 805     wxEVT_END_PROCESS
 806 };
 807
 808
 809
 810 class wxProcessEvent : public wxEvent {
 811 public:
 812     wxProcessEvent(int id = 0, int pid = 0, int exitcode = 0);
 813     int GetPid();
 814     int GetExitCode();
 815     int m_pid, m_exitcode;
 816 };
 817
 818
 819
 820
 821 %{ // C++ version of wxProcess derived class
 822
 823 class wxPyProcess : public wxProcess {
 824 public:
 825     wxPyProcess(wxEvtHandler *parent = NULL, int id = -1)
 826         : wxProcess(parent, id)
 827         {}
 828
 829     DEC_PYCALLBACK_VOID_INTINT(OnTerminate);
 830
 831     PYPRIVATE;
 832 };
 833
 834 IMP_PYCALLBACK_VOID_INTINT( wxPyProcess, wxProcess, OnTerminate);
 835
 836 %}
 837
 838
 839 %name(wxProcess)class wxPyProcess : public wxEvtHandler {
 840 public:
 841     // kill the process with the given PID
 842     static wxKillError Kill(int pid, wxSignal sig = wxSIGTERM);
 843
 844     // test if the given process exists
 845     static bool Exists(int pid);
 846
 847     // this function replaces the standard popen() one: it launches a process
 848     // asynchronously and allows the caller to get the streams connected to its
 849     // std{in|out|err}
 850     //
 851     // on error NULL is returned, in any case the process object will be
 852     // deleted automatically when the process terminates and should *not* be
 853     // deleted by the caller
 854     static wxPyProcess *Open(const wxString& cmd, int flags = wxEXEC_ASYNC);
 855
 856
 857
 858     wxPyProcess(wxEvtHandler *parent = NULL, int id = -1);
 859     %addmethods { void Destroy() { delete self; } }
 860
 861     void _setCallbackInfo(PyObject* self, PyObject* _class);
 862     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxProcess)"
 863
 864     void base_OnTerminate(int pid, int status);
 865
 866     void Redirect();
 867     bool IsRedirected();
 868     void Detach();
 869
 870     wxInputStream *GetInputStream();
 871     wxInputStream *GetErrorStream();
 872     wxOutputStream *GetOutputStream();
 873
 874     void CloseOutput();
 875 };
 876
 877
 878 enum
 879 {
 880     // execute the process asynchronously
 881     wxEXEC_ASYNC    = 0,
 882
 883     // execute it synchronously, i.e. wait until it finishes
 884     wxEXEC_SYNC     = 1,
 885
 886     // under Windows, don't hide the child even if it's IO is redirected (this
 887     // is done by default)
 888     wxEXEC_NOHIDE   = 2,
 889
 890     // under Unix, if the process is the group leader then killing -pid kills
 891     // all children as well as pid
 892     wxEXEC_MAKE_GROUP_LEADER = 4
 893 };
 894
 895
 896 long wxExecute(const wxString& command,
 897                int flags = wxEXEC_ASYNC,
 898                wxPyProcess *process = NULL);
 899
 900 //----------------------------------------------------------------------
 901
 902
 903 // Which joystick? Same as Windows ids so no conversion necessary.
 904 enum
 905 {
 906     wxJOYSTICK1,
 907     wxJOYSTICK2
 908 };
 909
 910 // Which button is down?
 911 enum
 912 {
 913     wxJOY_BUTTON_ANY,
 914     wxJOY_BUTTON1,
 915     wxJOY_BUTTON2,
 916     wxJOY_BUTTON3,
 917     wxJOY_BUTTON4,
 918 };
 919
 920
 921 %{
 922 #if !wxUSE_JOYSTICK && !defined(__WXMSW__)
 923 // A C++ stub class for wxJoystick for platforms that don't have it.
 924 class wxJoystick : public wxObject {
 925 public:
 926     wxJoystick(int joystick = wxJOYSTICK1) {
 927         wxPyBeginBlockThreads();
 928         PyErr_SetString(PyExc_NotImplementedError, "wxJoystick is not available on this platform.");
 929         wxPyEndBlockThreads();
 930     }
 931     wxPoint GetPosition() { return wxPoint(-1,-1); }
 932     int GetZPosition() { return -1; }
 933     int GetButtonState() { return -1; }
 934     int GetPOVPosition() { return -1; }
 935     int GetPOVCTSPosition() { return -1; }
 936     int GetRudderPosition() { return -1; }
 937     int GetUPosition() { return -1; }
 938     int GetVPosition() { return -1; }
 939     int GetMovementThreshold() { return -1; }
 940     void SetMovementThreshold(int threshold) {}
 941
 942     bool IsOk(void) { return FALSE; }
 943     int GetNumberJoysticks() { return -1; }
 944     int GetManufacturerId() { return -1; }
 945     int GetProductId() { return -1; }
 946     wxString GetProductName() { return ""; }
 947     int GetXMin() { return -1; }
 948     int GetYMin() { return -1; }
 949     int GetZMin() { return -1; }
 950     int GetXMax() { return -1; }
 951     int GetYMax() { return -1; }
 952     int GetZMax() { return -1; }
 953     int GetNumberButtons() { return -1; }
 954     int GetNumberAxes() { return -1; }
 955     int GetMaxButtons() { return -1; }
 956     int GetMaxAxes() { return -1; }
 957     int GetPollingMin() { return -1; }
 958     int GetPollingMax() { return -1; }
 959     int GetRudderMin() { return -1; }
 960     int GetRudderMax() { return -1; }
 961     int GetUMin() { return -1; }
 962     int GetUMax() { return -1; }
 963     int GetVMin() { return -1; }
 964     int GetVMax() { return -1; }
 965
 966     bool HasRudder() { return FALSE; }
 967     bool HasZ() { return FALSE; }
 968     bool HasU() { return FALSE; }
 969     bool HasV() { return FALSE; }
 970     bool HasPOV() { return FALSE; }
 971     bool HasPOV4Dir() { return FALSE; }
 972     bool HasPOVCTS() { return FALSE; }
 973
 974     bool SetCapture(wxWindow* win, int pollingFreq = 0) { return FALSE; }
 975     bool ReleaseCapture() { return FALSE; }
 976 };
 977 #endif
 978 %}
 979
 980
 981 class wxJoystick : public wxObject {
 982 public:
 983     wxJoystick(int joystick = wxJOYSTICK1);
 984     ~wxJoystick();
 985
 986     wxPoint GetPosition();
 987     int GetZPosition();
 988     int GetButtonState();
 989     int GetPOVPosition();
 990     int GetPOVCTSPosition();
 991     int GetRudderPosition();
 992     int GetUPosition();
 993     int GetVPosition();
 994     int GetMovementThreshold();
 995     void SetMovementThreshold(int threshold) ;
 996
 997     bool IsOk(void);
 998     int GetNumberJoysticks();
 999     int GetManufacturerId();
1000     int GetProductId();
1001     wxString GetProductName();
1002     int GetXMin();
1003     int GetYMin();
1004     int GetZMin();
1005     int GetXMax();
1006     int GetYMax();
1007     int GetZMax();
1008     int GetNumberButtons();
1009     int GetNumberAxes();
1010     int GetMaxButtons();
1011     int GetMaxAxes();
1012     int GetPollingMin();
1013     int GetPollingMax();
1014     int GetRudderMin();
1015     int GetRudderMax();
1016     int GetUMin();
1017     int GetUMax();
1018     int GetVMin();
1019     int GetVMax();
1020
1021     bool HasRudder();
1022     bool HasZ();
1023     bool HasU();
1024     bool HasV();
1025     bool HasPOV();
1026     bool HasPOV4Dir();
1027     bool HasPOVCTS();
1028
1029     bool SetCapture(wxWindow* win, int pollingFreq = 0);
1030     bool ReleaseCapture();
1031 };
1032
1033 //----------------------------------------------------------------------
1034
1035 %{
1036 #if !wxUSE_WAVE
1037 // A C++ stub class for wxWave for platforms that don't have it.
1038 class wxWave : public wxObject
1039 {
1040 public:
1041     wxWave(const wxString& fileName, bool isResource = FALSE) {
1042         wxPyBeginBlockThreads();
1043         PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform.");
1044         wxPyEndBlockThreads();
1045     }
1046     wxWave(int size, const wxByte* data) {
1047         wxPyBeginBlockThreads();
1048         PyErr_SetString(PyExc_NotImplementedError, "wxWave is not available on this platform.");
1049         wxPyEndBlockThreads();
1050     }
1051
1052     ~wxWave() {}
1053
1054     bool  IsOk() const { return FALSE; }
1055     bool  Play(bool async = TRUE, bool looped = FALSE) const { return FALSE; }
1056 };
1057
1058 #endif
1059 %}
1060
1061 class wxWave : public wxObject
1062 {
1063 public:
1064   wxWave(const wxString& fileName, bool isResource = FALSE);
1065   ~wxWave();
1066
1067   bool  IsOk() const;
1068   bool  Play(bool async = TRUE, bool looped = FALSE) const;
1069 };
1070
1071 %new wxWave* wxWaveData(const wxString& data);
1072 %{ // Implementations of some alternate "constructors"
1073     wxWave* wxWaveData(const wxString& data) {
1074         return new wxWave(data.Len(), (wxByte*)data.c_str());
1075     }
1076 %}
1077
1078
1079 //----------------------------------------------------------------------
1080
1081 enum wxMailcapStyle
1082 {
1083     wxMAILCAP_STANDARD = 1,
1084     wxMAILCAP_NETSCAPE = 2,
1085     wxMAILCAP_KDE = 4,
1086     wxMAILCAP_GNOME = 8,
1087
1088     wxMAILCAP_ALL = 15
1089 };
1090
1091
1092
1093 class wxFileTypeInfo
1094 {
1095 public:
1096     // ctors
1097         // a normal item
1098     wxFileTypeInfo(const char* mimeType,
1099                    const char* openCmd,
1100                    const char* printCmd,
1101                    const char* desc);
1102
1103
1104         // the array elements correspond to the parameters of the ctor above in
1105         // the same order
1106     %name(wxFileTypeInfoSequence)wxFileTypeInfo(const wxArrayString& sArray);
1107
1108         // invalid item - use this to terminate the array passed to
1109         // wxMimeTypesManager::AddFallbacks
1110     %name(wxNullFileTypeInfo)wxFileTypeInfo();
1111
1112
1113     // test if this object can be used
1114     bool IsValid() const;
1115
1116     // setters
1117         // set the icon info
1118     void SetIcon(const wxString& iconFile, int iconIndex = 0);
1119
1120         // set the short desc
1121     void SetShortDesc(const wxString& shortDesc);
1122
1123     // accessors
1124         // get the MIME type
1125     const wxString& GetMimeType() const;
1126         // get the open command
1127     const wxString& GetOpenCommand() const;
1128         // get the print command
1129     const wxString& GetPrintCommand() const;
1130         // get the short description (only used under Win32 so far)
1131     const wxString& GetShortDesc() const;
1132         // get the long, user visible description
1133     const wxString& GetDescription() const;
1134
1135
1136         // get the array of all extensions
1137     //const wxArrayString& GetExtensions() const;
1138     %addmethods {
1139         PyObject* GetExtensions() {
1140             wxArrayString& arr = (wxArrayString&)self->GetExtensions();
1141             return wxArrayString2PyList_helper(arr);
1142         }
1143     }
1144
1145     int GetExtensionsCount() const;
1146
1147     // get the icon info
1148     const wxString& GetIconFile() const;
1149     int GetIconIndex() const;
1150 };
1151
1152
1153
1154
1155 class wxFileType
1156 {
1157 public:
1158
1159     // TODO: Make a wxPyMessageParameters with virtual GetParamValue...
1160
1161     // An object of this class must be passed to Get{Open|Print}Command. The
1162     // default implementation is trivial and doesn't know anything at all about
1163     // parameters, only filename and MIME type are used (so it's probably ok for
1164     // Windows where %{param} is not used anyhow)
1165     class MessageParameters
1166     {
1167     public:
1168         // ctors
1169         MessageParameters(const wxString& filename=wxPyEmptyString,
1170                           const wxString& mimetype=wxPyEmptyString);
1171
1172         // accessors (called by GetOpenCommand)
1173             // filename
1174         const wxString& GetFileName() const;
1175             // mime type
1176         const wxString& GetMimeType() const;;
1177
1178         // override this function in derived class
1179         virtual wxString GetParamValue(const wxString& name) const;
1180
1181         // virtual dtor as in any base class
1182         virtual ~MessageParameters();
1183     };
1184
1185
1186     // ctor from static data
1187     wxFileType(const wxFileTypeInfo& ftInfo);
1188
1189     // return the MIME type for this file type
1190     %addmethods {
1191         PyObject* GetMimeType() {
1192             wxString str;
1193             if (self->GetMimeType(&str)) {
1194 #if wxUSE_UNICODE
1195               return PyUnicode_FromUnicode(str.c_str(), str.Len());
1196 #else
1197               return PyString_FromStringAndSize(str.c_str(), str.Len());
1198 #endif
1199             }
1200             else
1201                 RETURN_NONE();
1202         }
1203         PyObject* GetMimeTypes() {
1204             wxArrayString arr;
1205             if (self->GetMimeTypes(arr))
1206                 return wxArrayString2PyList_helper(arr);
1207             else
1208                 RETURN_NONE();
1209         }
1210     }
1211
1212
1213     // Get all extensions associated with this file type
1214     %addmethods {
1215         PyObject* GetExtensions() {
1216             wxArrayString arr;
1217             if (self->GetExtensions(arr))
1218                 return wxArrayString2PyList_helper(arr);
1219             else
1220                 RETURN_NONE();
1221         }
1222     }
1223
1224
1225     %addmethods {
1226         // Get the icon corresponding to this file type
1227         %new wxIcon* GetIcon() {
1228             wxIcon icon;
1229             if (self->GetIcon(&icon))
1230                 return new wxIcon(icon);
1231             else
1232                 return NULL;
1233         }
1234
1235         // Get the icon corresponding to this file type, the name of the file
1236         // where this icon resides, and its index in this file if applicable.
1237         PyObject* GetIconInfo() {
1238             wxIcon icon;
1239             wxString iconFile;
1240             int iconIndex;
1241             if (self->GetIcon(&icon, &iconFile, &iconIndex)) {
1242                 wxPyBeginBlockThreads();
1243                 PyObject* tuple = PyTuple_New(3);
1244                 PyTuple_SetItem(tuple, 0, wxPyConstructObject(new wxIcon(icon),
1245                                                               "wxIcon", TRUE));
1246 #if wxUSE_UNICODE
1247                 PyTuple_SetItem(tuple, 1, PyUnicode_FromUnicode(iconFile.c_str(), iconFile.Len()));
1248 #else
1249                 PyTuple_SetItem(tuple, 1, PyString_FromStringAndSize(iconFile.c_str(), iconFile.Len()));
1250 #endif
1251                 PyTuple_SetItem(tuple, 2, PyInt_FromLong(iconIndex));
1252                 wxPyEndBlockThreads();
1253                 return tuple;
1254             }
1255             else
1256                 RETURN_NONE();
1257         }
1258     }
1259
1260     %addmethods {
1261         // get a brief file type description ("*.txt" => "text document")
1262         PyObject* GetDescription() {
1263             wxString str;
1264             if (self->GetDescription(&str)) {
1265 #if  wxUSE_UNICODE
1266               return PyUnicode_FromUnicode(str.c_str(), str.Len());
1267 #else
1268               return PyString_FromStringAndSize(str.c_str(), str.Len());
1269 #endif
1270             } else
1271                 RETURN_NONE();
1272         }
1273     }
1274
1275
1276     // get the command to open/execute the file of given type
1277     %addmethods {
1278         PyObject* GetOpenCommand(const wxString& filename,
1279                                  const wxString& mimetype=wxPyEmptyString) {
1280             wxString str;
1281             if (self->GetOpenCommand(&str, wxFileType::MessageParameters(filename, mimetype))) {
1282 #if  wxUSE_UNICODE
1283                 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1284 #else
1285                 return PyString_FromStringAndSize(str.c_str(), str.Len());
1286 #endif
1287             } else
1288                 RETURN_NONE();
1289         }
1290     }
1291
1292
1293     // get the command to print the file of given type
1294     %addmethods {
1295         PyObject* GetPrintCommand(const wxString& filename,
1296                                   const wxString& mimetype=wxPyEmptyString) {
1297             wxString str;
1298             if (self->GetPrintCommand(&str, wxFileType::MessageParameters(filename, mimetype))) {
1299 #if wxUSE_UNICODE
1300                 return PyUnicode_FromUnicode(str.c_str(), str.Len());
1301 #else
1302                 return PyString_FromStringAndSize(str.c_str(), str.Len());
1303 #endif
1304             } else
1305                 RETURN_NONE();
1306         }
1307     }
1308
1309
1310     // Get all commands defined for this file type
1311     %addmethods {
1312         PyObject* GetAllCommands(const wxString& filename,
1313                                  const wxString& mimetype=wxPyEmptyString) {
1314             wxArrayString verbs;
1315             wxArrayString commands;
1316             if (self->GetAllCommands(&verbs, &commands,
1317                                      wxFileType::MessageParameters(filename, mimetype))) {
1318                 wxPyBeginBlockThreads();
1319                 PyObject* tuple = PyTuple_New(2);
1320                 PyTuple_SetItem(tuple, 0, wxArrayString2PyList_helper(verbs));
1321                 PyTuple_SetItem(tuple, 1, wxArrayString2PyList_helper(commands));
1322                 wxPyEndBlockThreads();
1323                 return tuple;
1324             }
1325             else
1326                 RETURN_NONE();
1327         }
1328     }
1329
1330
1331     // set an arbitrary command, ask confirmation if it already exists and
1332     // overwriteprompt is TRUE
1333     bool SetCommand(const wxString& cmd, const wxString& verb,
1334                     bool overwriteprompt = TRUE);
1335
1336     bool SetDefaultIcon(const wxString& cmd = wxPyEmptyString, int index = 0);
1337
1338
1339     // remove the association for this filetype from the system MIME database:
1340     // notice that it will only work if the association is defined in the user
1341     // file/registry part, we will never modify the system-wide settings
1342     bool Unassociate();
1343
1344     // operations
1345         // expand a string in the format of GetOpenCommand (which may contain
1346         // '%s' and '%t' format specificators for the file name and mime type
1347         // and %{param} constructions).
1348     static wxString ExpandCommand(const wxString& command,
1349                                   const MessageParameters& params);
1350
1351     // dtor (not virtual, shouldn't be derived from)
1352     ~wxFileType();
1353
1354 };
1355
1356
1357
1358
1359 class wxMimeTypesManager
1360 {
1361 public:
1362     // static helper functions
1363     // -----------------------
1364
1365         // check if the given MIME type is the same as the other one: the
1366         // second argument may contain wildcards ('*'), but not the first. If
1367         // the types are equal or if the mimeType matches wildcard the function
1368         // returns TRUE, otherwise it returns FALSE
1369     static bool IsOfType(const wxString& mimeType, const wxString& wildcard);
1370
1371     // ctor
1372     wxMimeTypesManager();
1373
1374     // loads data from standard files according to the mailcap styles
1375     // specified: this is a bitwise OR of wxMailcapStyle values
1376     //
1377     // use the extraDir parameter if you want to look for files in another
1378     // directory
1379     void Initialize(int mailcapStyle = wxMAILCAP_STANDARD,
1380                     const wxString& extraDir = wxPyEmptyString);
1381
1382     // and this function clears all the data from the manager
1383     void ClearData();
1384
1385     // Database lookup: all functions return a pointer to wxFileType object
1386     // whose methods may be used to query it for the information you're
1387     // interested in. If the return value is !NULL, caller is responsible for
1388     // deleting it.
1389     // get file type from file extension
1390     %new wxFileType *GetFileTypeFromExtension(const wxString& ext);
1391
1392     // get file type from MIME type (in format <category>/<format>)
1393     %new wxFileType *GetFileTypeFromMimeType(const wxString& mimeType);
1394
1395     // other operations: return TRUE if there were no errors or FALSE if there
1396     // were some unreckognized entries (the good entries are always read anyhow)
1397     //
1398
1399         // read in additional file (the standard ones are read automatically)
1400         // in mailcap format (see mimetype.cpp for description)
1401         //
1402         // 'fallback' parameter may be set to TRUE to avoid overriding the
1403         // settings from other, previously parsed, files by this one: normally,
1404         // the files read most recently would override the older files, but with
1405         // fallback == TRUE this won't happen
1406     bool ReadMailcap(const wxString& filename, bool fallback = FALSE);
1407
1408     // read in additional file in mime.types format
1409     bool ReadMimeTypes(const wxString& filename);
1410
1411     // enumerate all known MIME types
1412     %addmethods {
1413         PyObject* EnumAllFileTypes() {
1414             wxArrayString arr;
1415             self->EnumAllFileTypes(arr);
1416             return wxArrayString2PyList_helper(arr);
1417         }
1418     }
1419
1420     // these functions can be used to provide default values for some of the
1421     // MIME types inside the program itself (you may also use
1422     // ReadMailcap(filenameWithDefaultTypes, TRUE /* use as fallback */) to
1423     // achieve the same goal, but this requires having this info in a file).
1424     //
1425     void AddFallback(const wxFileTypeInfo& ft);
1426
1427
1428     // create or remove associations
1429
1430         // create a new association using the fields of wxFileTypeInfo (at least
1431         // the MIME type and the extension should be set)
1432         // if the other fields are empty, the existing values should be left alone
1433     %new wxFileType *Associate(const wxFileTypeInfo& ftInfo);
1434
1435         // undo Associate()
1436     bool Unassociate(wxFileType *ft) ;
1437
1438     // dtor (not virtual, shouldn't be derived from)
1439     ~wxMimeTypesManager();
1440 };
1441
1442
1443 %readonly
1444 %{
1445 #if 0
1446 %}
1447 extern wxMimeTypesManager* wxTheMimeTypesManager;
1448 %{
1449 #endif
1450 %}
1451 %readwrite
1452
1453 //----------------------------------------------------------------------
1454
1455 %{
1456 #include <wx/artprov.h>
1457
1458     DECLARE_DEF_STRING(ART_OTHER);
1459
1460 %}
1461
1462 // Art clients
1463 #define wxART_TOOLBAR                  "toolbar_C"
1464 #define wxART_MENU                     "menu_C"
1465 #define wxART_FRAME_ICON               "frame_icon_C"
1466
1467 #define wxART_CMN_DIALOG               "cmn_dialog_C"
1468 #define wxART_HELP_BROWSER             "help_browser_C"
1469 #define wxART_MESSAGE_BOX              "message_box_C"
1470
1471 #define wxART_OTHER                    "other_C"
1472
1473 // Art IDs
1474 #define wxART_ADD_BOOKMARK             "add_bookmark"
1475 #define wxART_DEL_BOOKMARK             "del_bookmark"
1476 #define wxART_HELP_SIDE_PANEL          "help_side_panel"
1477 #define wxART_HELP_SETTINGS            "help_settings"
1478 #define wxART_HELP_BOOK                "help_book"
1479 #define wxART_HELP_FOLDER              "help_folder"
1480 #define wxART_HELP_PAGE                "help_page"
1481 #define wxART_GO_BACK                  "go_back"
1482 #define wxART_GO_FORWARD               "go_forward"
1483 #define wxART_GO_UP                    "go_up"
1484 #define wxART_GO_DOWN                  "go_down"
1485 #define wxART_GO_TO_PARENT             "go_to_parent"
1486 #define wxART_GO_HOME                  "go_home"
1487 #define wxART_FILE_OPEN                "file_open"
1488 #define wxART_PRINT                    "print"
1489 #define wxART_HELP                     "help"
1490 #define wxART_TIP                      "tip"
1491 #define wxART_REPORT_VIEW              "report_view"
1492 #define wxART_LIST_VIEW                "list_view"
1493 #define wxART_NEW_DIR                  "new_dir"
1494 #define wxART_FOLDER                   "folder"
1495 #define wxART_GO_DIR_UP                "go_dir_up"
1496 #define wxART_EXECUTABLE_FILE          "executable_file"
1497 #define wxART_NORMAL_FILE              "normal_file"
1498 #define wxART_TICK_MARK                "tick"
1499 #define wxART_CROSS_MARK               "cross"
1500 #define wxART_ERROR                    "error"
1501 #define wxART_QUESTION                 "question"
1502 #define wxART_WARNING                  "warning"
1503 #define wxART_INFORMATION              "information"
1504
1505
1506 %{  // Python aware wxArtProvider
1507 class wxPyArtProvider : public wxArtProvider  {
1508 public:
1509
1510     virtual wxBitmap CreateBitmap(const wxArtID& id,
1511                                   const wxArtClient& client,
1512                                   const wxSize& size) {
1513         wxBitmap rval = wxNullBitmap;
1514         wxPyBeginBlockThreads();
1515         if ((wxPyCBH_findCallback(m_myInst, "CreateBitmap"))) {
1516             PyObject* so = wxPyConstructObject((void*)&size, "wxSize", 0);
1517             PyObject* ro;
1518             wxBitmap* ptr;
1519             PyObject* s1, *s2;
1520             s1 = wx2PyString(id);
1521             s2 = wx2PyString(client);
1522             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(OOO)", s1, s2, so));
1523             Py_DECREF(so);
1524             Py_DECREF(s1);
1525             Py_DECREF(s2);
1526             if (ro) {
1527                 if (!SWIG_GetPtrObj(ro, (void**)&ptr, "_wxBitmap_p"))
1528                     rval = *ptr;
1529                 Py_DECREF(ro);
1530             }
1531         }
1532         wxPyEndBlockThreads();
1533         return rval;
1534     }
1535
1536     PYPRIVATE;
1537 };
1538 %}
1539
1540 // The one for SWIG to see
1541 %name(wxArtProvider) class wxPyArtProvider : public wxObject
1542 {
1543 public:
1544     wxPyArtProvider();
1545
1546     void _setCallbackInfo(PyObject* self, PyObject* _class);
1547     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxArtProvider)"
1548
1549     // Add new provider to the top of providers stack.
1550     static void PushProvider(wxPyArtProvider *provider);
1551
1552     // Remove latest added provider and delete it.
1553     static bool PopProvider();
1554
1555     // Remove provider. The provider must have been added previously!
1556     // The provider is _not_ deleted.
1557     static bool RemoveProvider(wxPyArtProvider *provider);
1558
1559     // Query the providers for bitmap with given ID and return it. Return
1560     // wxNullBitmap if no provider provides it.
1561     static wxBitmap GetBitmap(const wxString& id,
1562                               const wxString& client = wxPyART_OTHER,
1563                               const wxSize& size = wxDefaultSize);
1564
1565     // Query the providers for icon with given ID and return it. Return
1566     // wxNullIcon if no provider provides it.
1567     static wxIcon GetIcon(const wxString& id,
1568                           const wxString& client = wxPyART_OTHER,
1569                           const wxSize& size = wxDefaultSize);
1570
1571     // Destroy caches & all providers
1572     static void CleanUpProviders();
1573 };
1574
1575
1576 //----------------------------------------------------------------------
1577
1578 %{
1579 #include <wx/docview.h>
1580 %}
1581
1582 class wxFileHistory : public wxObject
1583 {
1584 public:
1585     wxFileHistory(int maxFiles = 9);
1586     ~wxFileHistory();
1587
1588     // Operations
1589     void AddFileToHistory(const wxString& file);
1590     void RemoveFileFromHistory(int i);
1591     int GetMaxFiles() const;
1592     void UseMenu(wxMenu *menu);
1593
1594     // Remove menu from the list (MDI child may be closing)
1595     void RemoveMenu(wxMenu *menu);
1596
1597     void Load(wxConfigBase& config);
1598     void Save(wxConfigBase& config);
1599
1600     void AddFilesToMenu();
1601     %name(AddFilesToThisMenu)void AddFilesToMenu(wxMenu* menu);
1602
1603     // Accessors
1604     wxString GetHistoryFile(int i) const;
1605
1606     // A synonym for GetNoHistoryFiles
1607     int GetCount() const;
1608     int GetNoHistoryFiles() const;
1609
1610 };
1611
1612 //----------------------------------------------------------------------
1613 //----------------------------------------------------------------------
1614
1615 // %{
1616 // #if wxUSE_UNICODE
1617 // #define ADD_STRING(dict, str) \
1618 //     wxString tmp##str(str); \
1619 //     PyDict_SetItemString(dict, #str, \
1620 //                          PyUnicode_FromUnicode(tmp##str.c_str(), tmp##str.Len()))
1621 // #else
1622 // #define ADD_STRING(dict, str) \
1623 //     PyDict_SetItemString(d, #str, PyString_FromString(str))
1624 // #endif
1625 // %}
1626
1627
1628 %init %{
1629     wxPyPtrTypeMap_Add("wxDragImage", "wxGenericDragImage");
1630     wxPyPtrTypeMap_Add("wxProcess", "wxPyProcess");
1631     wxPyPtrTypeMap_Add("wxArtProvider", "wxPyArtProvider");
1632
1633 %}
1634
1635 //----------------------------------------------------------------------
1636