wxPython/src/_toplvl.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _toplvl.i
   3 // Purpose:     SWIG definitions for wxTopLevelWindow, wxFrame, wxDialog and etc.
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     27-Aug-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
  18 MAKE_CONST_WXSTRING(FrameNameStr);
  19 MAKE_CONST_WXSTRING(DialogNameStr);
  20 MAKE_CONST_WXSTRING(StatusLineNameStr);
  21 MAKE_CONST_WXSTRING(ToolBarNameStr);
  22
  23 //---------------------------------------------------------------------------
  24 %newgroup
  25
  26 enum
  27 {
  28     wxSTAY_ON_TOP,
  29     wxICONIZE,
  30     wxMINIMIZE,
  31     wxMAXIMIZE,
  32     wxCLOSE_BOX,
  33     wxTHICK_FRAME,
  34     wxSYSTEM_MENU,
  35     wxMINIMIZE_BOX,
  36     wxMAXIMIZE_BOX,
  37     wxTINY_CAPTION_HORIZ,
  38     wxTINY_CAPTION_VERT,
  39     wxRESIZE_BOX,
  40     wxRESIZE_BORDER,
  41
  42     wxDIALOG_NO_PARENT,
  43
  44     wxDEFAULT_FRAME_STYLE,
  45     wxDEFAULT_DIALOG_STYLE,
  46
  47     wxFRAME_TOOL_WINDOW,
  48     wxFRAME_FLOAT_ON_PARENT,
  49     wxFRAME_NO_WINDOW_MENU,
  50     wxFRAME_NO_TASKBAR,
  51     wxFRAME_SHAPED,
  52     wxFRAME_DRAWER,
  53
  54     // Obsolete
  55     wxDIALOG_MODAL,
  56     wxDIALOG_MODELESS,
  57     wxUSER_COLOURS,
  58     wxNO_3D,
  59 };
  60
  61 enum
  62 {
  63     wxFULLSCREEN_NOMENUBAR,
  64     wxFULLSCREEN_NOTOOLBAR,
  65     wxFULLSCREEN_NOSTATUSBAR,
  66     wxFULLSCREEN_NOBORDER,
  67     wxFULLSCREEN_NOCAPTION,
  68     wxFULLSCREEN_ALL,
  69
  70     wxTOPLEVEL_EX_DIALOG,
  71 };
  72
  73 // Styles for RequestUserAttention
  74 enum
  75 {
  76     wxUSER_ATTENTION_INFO = 1,
  77     wxUSER_ATTENTION_ERROR = 2
  78 };
  79
  80 //---------------------------------------------------------------------------
  81
  82 class  wxTopLevelWindow : public wxWindow
  83 {
  84 public:
  85
  86     // No constructor as it can not be used directly from Python
  87
  88     // maximize = True => maximize, otherwise - restore
  89     virtual void Maximize(bool maximize = true);
  90
  91     // undo Maximize() or Iconize()
  92     virtual void Restore();
  93
  94     // iconize = True => iconize, otherwise - restore
  95     virtual void Iconize(bool iconize = true);
  96
  97     // return True if the frame is maximized
  98     virtual bool IsMaximized() const;
  99
 100     // return True if the frame is iconized
 101     virtual bool IsIconized() const;
 102
 103     // get the frame icon
 104     wxIcon GetIcon() const;
 105
 106     // set the frame icon
 107     virtual void SetIcon(const wxIcon& icon);
 108
 109     // set the frame icons
 110     virtual void SetIcons(const wxIconBundle& icons );
 111
 112     // maximize the window to cover entire screen
 113     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
 114
 115     // return True if the frame is in fullscreen mode
 116     virtual bool IsFullScreen() const;
 117
 118     virtual void SetTitle(const wxString& title);
 119     virtual wxString GetTitle() const;
 120
 121     // Set the shape of the window to the given region.
 122     // Returns True if the platform supports this feature (and the operation
 123     // is successful.)
 124     virtual bool SetShape(const wxRegion& region);
 125
 126
 127     // Attracts the users attention to this window if the application is
 128     // inactive (should be called when a background event occurs)
 129     virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
 130
 131     // Is this the active frame (highlighted in the taskbar)?
 132     virtual bool IsActive();
 133
 134 #ifdef __WXMAC__
 135     void MacSetMetalAppearance( bool on ) ;
 136     bool MacGetMetalAppearance() const ;
 137 #endif
 138 };
 139
 140
 141 //---------------------------------------------------------------------------
 142 %newgroup
 143
 144 // wxFrame is a top-level window with optional menubar, statusbar and toolbar
 145 //
 146 // For each of *bars, a frame may have several of them, but only one is
 147 // managed by the frame, i.e. resized/moved when the frame is and whose size
 148 // is accounted for in client size calculations - all others should be taken
 149 // care of manually.
 150
 151 MustHaveApp(wxFrame);
 152
 153 class wxFrame : public wxTopLevelWindow {
 154 public:
 155     %pythonAppend wxFrame         "self._setOORInfo(self)"
 156     %pythonAppend wxFrame()       ""
 157     %typemap(out) wxFrame*;    // turn off this typemap
 158
 159     wxFrame(wxWindow* parent, const wxWindowID id=-1,
 160             const wxString& title = wxPyEmptyString,
 161             const wxPoint& pos = wxDefaultPosition,
 162             const wxSize& size = wxDefaultSize,
 163             long style = wxDEFAULT_FRAME_STYLE,
 164             const wxString& name = wxPyFrameNameStr);
 165     %name(PreFrame)wxFrame();
 166
 167     // Turn it back on again
 168     %typemap(out) wxFrame* { $result = wxPyMake_wxObject($1, $owner); }
 169
 170
 171     bool Create(wxWindow* parent, const wxWindowID id=-1,
 172                 const wxString& title = wxPyEmptyString,
 173                 const wxPoint& pos = wxDefaultPosition,
 174                 const wxSize& size = wxDefaultSize,
 175                 long style = wxDEFAULT_FRAME_STYLE,
 176                 const wxString& name = wxPyFrameNameStr);
 177
 178
 179     // frame state
 180     // -----------
 181
 182     // get the origin of the client area (which may be different from (0, 0)
 183     // if the frame has a toolbar) in client coordinates
 184     virtual wxPoint GetClientAreaOrigin() const;
 185
 186     // sends a size event to the window using its current size -- this has an
 187     // effect of refreshing the window layout
 188     //
 189     virtual void SendSizeEvent();
 190
 191
 192     // menu bar functions
 193     // ------------------
 194
 195     virtual void SetMenuBar(wxMenuBar *menubar);
 196     virtual wxMenuBar *GetMenuBar() const;
 197
 198
 199     // process menu command: returns True if processed
 200     bool ProcessCommand(int winid);
 201     %pythoncode { Command = ProcessCommand }
 202
 203
 204     // status bar functions
 205     // --------------------
 206
 207     // create the main status bar by calling OnCreateStatusBar()
 208     virtual wxStatusBar* CreateStatusBar(int number = 1,
 209                                          long style = wxDEFAULT_STATUSBAR_STYLE,
 210                                          wxWindowID winid = 0,
 211                                          const wxString& name = wxPyStatusLineNameStr);
 212 // TODO: with directors?
 213 //     // return a new status bar
 214 //     virtual wxStatusBar *OnCreateStatusBar(int number,
 215 //                                            long style,
 216 //                                            wxWindowID winid,
 217 //                                            const wxString& name);
 218
 219     // get the main status bar
 220     virtual wxStatusBar *GetStatusBar() const;
 221
 222     // sets the main status bar
 223     void SetStatusBar(wxStatusBar *statBar);
 224
 225     // forward these to status bar
 226     virtual void SetStatusText(const wxString &text, int number = 0);
 227     virtual void SetStatusWidths(int widths, const int* widths_field); //uses typemap above
 228     void PushStatusText(const wxString &text, int number = 0);
 229     void PopStatusText(int number = 0);
 230
 231     // set the status bar pane the help will be shown in
 232     void SetStatusBarPane(int n);
 233     int GetStatusBarPane() const;
 234
 235
 236     // toolbar functions
 237     // -----------------
 238
 239     // create main toolbar bycalling OnCreateToolBar()
 240     virtual wxToolBar* CreateToolBar(long style = -1,
 241                                      wxWindowID winid = -1,
 242                                      const wxString& name = wxPyToolBarNameStr);
 243 // TODO: with directors?
 244 //     // return a new toolbar
 245 //     virtual wxToolBar *OnCreateToolBar(long style,
 246 //                                        wxWindowID winid,
 247 //                                        const wxString& name );
 248
 249     // get/set the main toolbar
 250     virtual wxToolBar *GetToolBar() const;
 251     virtual void SetToolBar(wxToolBar *toolbar);
 252
 253
 254     // show help text (typically in the statusbar); show is False
 255     // if you are hiding the help, True otherwise
 256     virtual void DoGiveHelp(const wxString& text, bool show);
 257
 258
 259     // send wxUpdateUIEvents for all menu items in the menubar,
 260     // or just for menu if non-NULL
 261     void DoMenuUpdates(wxMenu* menu = NULL);
 262
 263     static wxVisualAttributes
 264     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 265 };
 266
 267 //---------------------------------------------------------------------------
 268 %newgroup
 269
 270 MustHaveApp(wxDialog);
 271
 272 class wxDialog : public wxTopLevelWindow {
 273 public:
 274     %pythonAppend wxDialog   "self._setOORInfo(self)"
 275     %pythonAppend wxDialog() ""
 276     %typemap(out) wxDialog*;    // turn off this typemap
 277
 278     wxDialog(wxWindow* parent,
 279              const wxWindowID id=-1,
 280              const wxString& title = wxPyEmptyString,
 281              const wxPoint& pos = wxDefaultPosition,
 282              const wxSize& size = wxDefaultSize,
 283              long style = wxDEFAULT_DIALOG_STYLE,
 284              const wxString& name = wxPyDialogNameStr);
 285     %name(PreDialog)wxDialog();
 286
 287     // Turn it back on again
 288     %typemap(out) wxDialog* { $result = wxPyMake_wxObject($1, $owner); }
 289
 290     bool Create(wxWindow* parent,
 291                 const wxWindowID id=-1,
 292                 const wxString& title = wxPyEmptyString,
 293                 const wxPoint& pos = wxDefaultPosition,
 294                 const wxSize& size = wxDefaultSize,
 295                 long style = wxDEFAULT_DIALOG_STYLE,
 296                 const wxString& name = wxPyDialogNameStr);
 297
 298
 299     // the modal dialogs have a return code - usually the id of the last
 300     // pressed button
 301     void SetReturnCode(int returnCode);
 302     int GetReturnCode() const;
 303
 304     // splits text up at newlines and places the
 305     // lines into a vertical wxBoxSizer
 306     wxSizer *CreateTextSizer( const wxString &message );
 307
 308     // places buttons into a horizontal wxBoxSizer
 309     wxSizer *CreateButtonSizer( long flags );
 310
 311
 312     //void SetModal(bool flag);
 313
 314     // is the dialog in modal state right now?
 315     virtual bool IsModal() const;
 316
 317     // Shows the dialog and starts a nested event loop that returns when
 318     // EndModal is called.
 319     virtual int ShowModal();
 320
 321     // may be called to terminate the dialog with the given return code
 322     virtual void EndModal(int retCode);
 323
 324     static wxVisualAttributes
 325     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 326
 327     %pythoncode {
 328         def SendSizeEvent(self):
 329             self.ProcessEvent(wx.SizeEvent((-1,-1)))
 330     }
 331 };
 332
 333 //---------------------------------------------------------------------------
 334 %newgroup
 335
 336
 337 MustHaveApp(wxMiniFrame);
 338
 339 class wxMiniFrame : public wxFrame {
 340 public:
 341     %pythonAppend wxMiniFrame         "self._setOORInfo(self)"
 342     %pythonAppend wxMiniFrame()       ""
 343
 344     wxMiniFrame(wxWindow* parent, const wxWindowID id=-1,
 345                 const wxString& title = wxPyEmptyString,
 346                 const wxPoint& pos = wxDefaultPosition,
 347                 const wxSize& size = wxDefaultSize,
 348                 long style = wxDEFAULT_FRAME_STYLE,
 349                 const wxString& name = wxPyFrameNameStr);
 350     %name(PreMiniFrame)wxMiniFrame();
 351
 352     bool Create(wxWindow* parent, const wxWindowID id=-1,
 353                 const wxString& title = wxPyEmptyString,
 354                 const wxPoint& pos = wxDefaultPosition,
 355                 const wxSize& size = wxDefaultSize,
 356                 long style = wxDEFAULT_FRAME_STYLE,
 357                 const wxString& name = wxPyFrameNameStr);
 358
 359 };
 360
 361
 362 //---------------------------------------------------------------------------
 363 %newgroup
 364
 365
 366 enum {
 367     wxSPLASH_CENTRE_ON_PARENT,
 368     wxSPLASH_CENTRE_ON_SCREEN,
 369     wxSPLASH_NO_CENTRE,
 370     wxSPLASH_TIMEOUT,
 371     wxSPLASH_NO_TIMEOUT,
 372 };
 373
 374
 375 MustHaveApp(wxSplashScreenWindow);
 376
 377 class wxSplashScreenWindow: public wxWindow
 378 {
 379 public:
 380     %pythonAppend wxSplashScreenWindow         "self._setOORInfo(self)"
 381
 382     wxSplashScreenWindow(const wxBitmap& bitmap,
 383                          wxWindow* parent, wxWindowID id,
 384                          const wxPoint& pos = wxDefaultPosition,
 385                          const wxSize& size = wxDefaultSize,
 386                          long style = wxNO_BORDER);
 387
 388     void SetBitmap(const wxBitmap& bitmap);
 389     wxBitmap& GetBitmap();
 390 };
 391
 392
 393 MustHaveApp(wxSplashScreen);
 394
 395 class wxSplashScreen : public wxFrame {
 396 public:
 397     %pythonAppend wxSplashScreen         "self._setOORInfo(self)"
 398
 399     wxSplashScreen(const wxBitmap& bitmap, long splashStyle, int milliseconds,
 400                    wxWindow* parent, wxWindowID id=-1,
 401                    const wxPoint& pos = wxDefaultPosition,
 402                    const wxSize& size = wxDefaultSize,
 403                    long style = wxSIMPLE_BORDER|wxFRAME_NO_TASKBAR|wxSTAY_ON_TOP);
 404
 405     long GetSplashStyle() const;
 406     wxSplashScreenWindow* GetSplashWindow() const;
 407     int GetTimeout() const;
 408 };
 409
 410
 411 //---------------------------------------------------------------------------