Added wrappers for wxAUI

[wxWidgets.git] / wxPython / src / _toplvl.i

diff --git a/wxPython/src/_toplvl.i b/wxPython/src/_toplvl.i
index 5d00956845b89e27ebcfe4174aac31a5f32e2d6b..e9e6c60fd153789bedd2cbd5d92e4d7401d8b292 100644 (file)
--- a/wxPython/src/_toplvl.i
+++ b/wxPython/src/_toplvl.i
@@ -50,6 +50,9 @@ enum
     wxFRAME_NO_TASKBAR,
     wxFRAME_SHAPED,
     wxFRAME_DRAWER,
     wxFRAME_NO_TASKBAR,
     wxFRAME_SHAPED,
     wxFRAME_DRAWER,

+
+    wxFRAME_EX_METAL,
+    wxDIALOG_EX_METAL,

     
     // Obsolete
     wxDIALOG_MODAL,
     
     // Obsolete
     wxDIALOG_MODAL,


@@ -97,6 +100,10 @@ public:
     // return True if the frame is maximized
     virtual bool IsMaximized() const;
 
     // return True if the frame is maximized
     virtual bool IsMaximized() const;
 

+    // return true if the frame is always maximized
+    // due to native guidelines or current policy
+    virtual bool IsAlwaysMaximized() const;
+    

     // return True if the frame is iconized
     virtual bool IsIconized() const;
 
     // return True if the frame is iconized
     virtual bool IsIconized() const;
 


@@ -107,7 +114,7 @@ public:
     virtual void SetIcon(const wxIcon& icon);
 
     // set the frame icons
     virtual void SetIcon(const wxIcon& icon);
 
     // set the frame icons

-    virtual void SetIcons(const wxIconBundle& icons );
+    virtual void SetIcons(const wxIconBundle& icons);

 
     // maximize the window to cover entire screen
     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
 
     // maximize the window to cover entire screen
     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);


@@ -119,28 +126,42 @@ public:
     virtual wxString GetTitle() const;
 
     // Set the shape of the window to the given region.
     virtual wxString GetTitle() const;
 
     // Set the shape of the window to the given region.

-    // Returns True if the platform supports this feature (and the operation
-    // is successful.)
+    // Returns True if the platform supports this feature
+    // (and the operation is successful.)

     virtual bool SetShape(const wxRegion& region);
 
     virtual bool SetShape(const wxRegion& region);
 

-
-    // Attracts the users attention to this window if the application is
-    // inactive (should be called when a background event occurs)
+    // Attracts the users attention to this window if the application is inactive
+    // (should be called when a background event occurs)

     virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
 
     // Is this the active frame (highlighted in the taskbar)?
     virtual bool IsActive();
     virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
 
     // Is this the active frame (highlighted in the taskbar)?
     virtual bool IsActive();

-    
+

 #ifdef __WXMAC__
 #ifdef __WXMAC__

-    void MacSetMetalAppearance( bool on ) ;
-    bool MacGetMetalAppearance() const ;
-#else

     %extend {
     %extend {

+        void MacSetMetalAppearance( bool on ) {
+            int style = self->GetExtraStyle();
+            if ( on )
+                style |= wxFRAME_EX_METAL;
+            else
+                style &= ~wxFRAME_EX_METAL;
+            self->SetExtraStyle(style);
+        }
+    }
+    bool MacGetMetalAppearance() const;
+#else
+    %extend
+    {

         // TODO: Should they raise not implemented or just NOP???
         void MacSetMetalAppearance( bool on ) { /*wxPyRaiseNotImplemented();*/ }
         bool MacGetMetalAppearance() const    { /*wxPyRaiseNotImplemented();*/ return false; }
     }
 #endif
         // TODO: Should they raise not implemented or just NOP???
         void MacSetMetalAppearance( bool on ) { /*wxPyRaiseNotImplemented();*/ }
         bool MacGetMetalAppearance() const    { /*wxPyRaiseNotImplemented();*/ return false; }
     }
 #endif

+
+    DocDeclStr(
+        void , CenterOnScreen(int dir = wxBOTH),
+        "Center the window on screen", "");
+    %pythoncode { CentreOnScreen = CenterOnScreen }

 };
 
 
 };
 
 


@@ -156,31 +177,32 @@ public:
 
 MustHaveApp(wxFrame);
 
 
 MustHaveApp(wxFrame);
 

-class wxFrame : public wxTopLevelWindow {
+class wxFrame : public wxTopLevelWindow
+{

 public:
     %pythonAppend wxFrame         "self._setOORInfo(self)"
     %pythonAppend wxFrame()       ""
     %typemap(out) wxFrame*;    // turn off this typemap
 
 public:
     %pythonAppend wxFrame         "self._setOORInfo(self)"
     %pythonAppend wxFrame()       ""
     %typemap(out) wxFrame*;    // turn off this typemap
 

-    wxFrame(wxWindow* parent, const wxWindowID id=-1,
+    wxFrame(wxWindow* parent,
+            const wxWindowID id = -1,

             const wxString& title = wxPyEmptyString,
             const wxPoint& pos = wxDefaultPosition,
             const wxSize& size = wxDefaultSize,
             long style = wxDEFAULT_FRAME_STYLE,
             const wxString& name = wxPyFrameNameStr);
             const wxString& title = wxPyEmptyString,
             const wxPoint& pos = wxDefaultPosition,
             const wxSize& size = wxDefaultSize,
             long style = wxDEFAULT_FRAME_STYLE,
             const wxString& name = wxPyFrameNameStr);

-    %name(PreFrame)wxFrame();
+    %RenameCtor(PreFrame, wxFrame());

 
     // Turn it back on again
     %typemap(out) wxFrame* { $result = wxPyMake_wxObject($1, $owner); }
 
 
     // Turn it back on again
     %typemap(out) wxFrame* { $result = wxPyMake_wxObject($1, $owner); }
 

-    
-    bool Create(wxWindow* parent, const wxWindowID id=-1,
-                const wxString& title = wxPyEmptyString,
-                const wxPoint& pos = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
-                long style = wxDEFAULT_FRAME_STYLE,
-                const wxString& name = wxPyFrameNameStr);
-
+    bool Create(wxWindow* parent,
+            const wxWindowID id = -1,
+            const wxString& title = wxPyEmptyString,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize,
+            long style = wxDEFAULT_FRAME_STYLE,
+            const wxString& name = wxPyFrameNameStr);

 
     // frame state
     // -----------
 
     // frame state
     // -----------


@@ -189,24 +211,20 @@ public:
     // if the frame has a toolbar) in client coordinates
     virtual wxPoint GetClientAreaOrigin() const;
 
     // if the frame has a toolbar) in client coordinates
     virtual wxPoint GetClientAreaOrigin() const;
 

-    // sends a size event to the window using its current size -- this has an
-    // effect of refreshing the window layout
-    //
+    // sends a size event to the window using its current size:
+    //  this has a side effect of refreshing the window layout

     virtual void SendSizeEvent();
 
     virtual void SendSizeEvent();
 

-

     // menu bar functions
     // ------------------
 
     virtual void SetMenuBar(wxMenuBar *menubar);
     virtual wxMenuBar *GetMenuBar() const;
 
     // menu bar functions
     // ------------------
 
     virtual void SetMenuBar(wxMenuBar *menubar);
     virtual wxMenuBar *GetMenuBar() const;
 

-

     // process menu command: returns True if processed
     bool ProcessCommand(int winid);
     %pythoncode { Command = ProcessCommand }
 
     // process menu command: returns True if processed
     bool ProcessCommand(int winid);
     %pythoncode { Command = ProcessCommand }
 

-

     // status bar functions
     // --------------------
 
     // status bar functions
     // --------------------
 


@@ -215,6 +233,7 @@ public:
                                          long style = wxDEFAULT_STATUSBAR_STYLE,
                                          wxWindowID winid = 0,
                                          const wxString& name = wxPyStatusLineNameStr);
                                          long style = wxDEFAULT_STATUSBAR_STYLE,
                                          wxWindowID winid = 0,
                                          const wxString& name = wxPyStatusLineNameStr);

+

 // TODO: with directors?
 //     // return a new status bar
 //     virtual wxStatusBar *OnCreateStatusBar(int number,
 // TODO: with directors?
 //     // return a new status bar
 //     virtual wxStatusBar *OnCreateStatusBar(int number,


@@ -230,7 +249,7 @@ public:
 
     // forward these to status bar
     virtual void SetStatusText(const wxString &text, int number = 0);
 
     // forward these to status bar
     virtual void SetStatusText(const wxString &text, int number = 0);

-    virtual void SetStatusWidths(int widths, const int* widths_field); //uses typemap above
+    virtual void SetStatusWidths(int widths, const int* widths_field); // uses typemap above

     void PushStatusText(const wxString &text, int number = 0);
     void PopStatusText(int number = 0);
 
     void PushStatusText(const wxString &text, int number = 0);
     void PopStatusText(int number = 0);
 


@@ -238,7 +257,6 @@ public:
     void SetStatusBarPane(int n);
     int GetStatusBarPane() const;
 
     void SetStatusBarPane(int n);
     int GetStatusBarPane() const;
 

-

     // toolbar functions
     // -----------------
 
     // toolbar functions
     // -----------------
 


@@ -246,6 +264,7 @@ public:
     virtual wxToolBar* CreateToolBar(long style = -1,
                                      wxWindowID winid = -1,
                                      const wxString& name = wxPyToolBarNameStr);
     virtual wxToolBar* CreateToolBar(long style = -1,
                                      wxWindowID winid = -1,
                                      const wxString& name = wxPyToolBarNameStr);

+

 // TODO: with directors?
 //     // return a new toolbar
 //     virtual wxToolBar *OnCreateToolBar(long style,
 // TODO: with directors?
 //     // return a new toolbar
 //     virtual wxToolBar *OnCreateToolBar(long style,


@@ -256,12 +275,10 @@ public:
     virtual wxToolBar *GetToolBar() const;
     virtual void SetToolBar(wxToolBar *toolbar);
 
     virtual wxToolBar *GetToolBar() const;
     virtual void SetToolBar(wxToolBar *toolbar);
 

-

     // show help text (typically in the statusbar); show is False
     // if you are hiding the help, True otherwise
     virtual void DoGiveHelp(const wxString& text, bool show);
 
     // show help text (typically in the statusbar); show is False
     // if you are hiding the help, True otherwise
     virtual void DoGiveHelp(const wxString& text, bool show);
 

-

     // send wxUpdateUIEvents for all menu items in the menubar,
     // or just for menu if non-NULL
     void DoMenuUpdates(wxMenu* menu = NULL);
     // send wxUpdateUIEvents for all menu items in the menubar,
     // or just for menu if non-NULL
     void DoMenuUpdates(wxMenu* menu = NULL);


@@ -275,47 +292,63 @@ public:
 
 MustHaveApp(wxDialog);
 
 
 MustHaveApp(wxDialog);
 

-class wxDialog : public wxTopLevelWindow {
+class wxDialog : public wxTopLevelWindow
+{

 public:
 public:

+    enum
+    {
+        // all flags allowed in wxDialogBase::CreateButtonSizer()
+        ButtonSizerFlags = wxOK | wxCANCEL | wxYES | wxNO | wxHELP | wxNO_DEFAULT
+    };
+

     %pythonAppend wxDialog   "self._setOORInfo(self)"
     %pythonAppend wxDialog() ""
     %typemap(out) wxDialog*;    // turn off this typemap
 
     wxDialog(wxWindow* parent,
     %pythonAppend wxDialog   "self._setOORInfo(self)"
     %pythonAppend wxDialog() ""
     %typemap(out) wxDialog*;    // turn off this typemap
 
     wxDialog(wxWindow* parent,

-             const wxWindowID id=-1,
+             const wxWindowID id = -1,

              const wxString& title = wxPyEmptyString,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = wxDEFAULT_DIALOG_STYLE,
              const wxString& name = wxPyDialogNameStr);
              const wxString& title = wxPyEmptyString,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = wxDEFAULT_DIALOG_STYLE,
              const wxString& name = wxPyDialogNameStr);

-    %name(PreDialog)wxDialog();
+    %RenameCtor(PreDialog, wxDialog());

 
     // Turn it back on again
     %typemap(out) wxDialog* { $result = wxPyMake_wxObject($1, $owner); }
 
     bool Create(wxWindow* parent,
 
     // Turn it back on again
     %typemap(out) wxDialog* { $result = wxPyMake_wxObject($1, $owner); }
 
     bool Create(wxWindow* parent,

-                const wxWindowID id=-1,
+                const wxWindowID id = -1,

                 const wxString& title = wxPyEmptyString,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxDEFAULT_DIALOG_STYLE,
                 const wxString& name = wxPyDialogNameStr);
 
                 const wxString& title = wxPyEmptyString,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxDEFAULT_DIALOG_STYLE,
                 const wxString& name = wxPyDialogNameStr);
 

-
-    // the modal dialogs have a return code - usually the id of the last
+    // the modal dialogs have a return code - usually the ID of the last

     // pressed button
     void SetReturnCode(int returnCode);
     int GetReturnCode() const;
 
     // pressed button
     void SetReturnCode(int returnCode);
     int GetReturnCode() const;
 

+    // The identifier for the affirmative button
+    void SetAffirmativeId(int affirmativeId);
+    int GetAffirmativeId() const;
+
+    // Identifier for Esc key translation
+    void SetEscapeId(int escapeId);
+    int GetEscapeId() const;
+

     // splits text up at newlines and places the
     // lines into a vertical wxBoxSizer
     // splits text up at newlines and places the
     // lines into a vertical wxBoxSizer

-    wxSizer *CreateTextSizer( const wxString &message );
+    wxSizer* CreateTextSizer( const wxString &message );

 
     // places buttons into a horizontal wxBoxSizer
 
     // places buttons into a horizontal wxBoxSizer

-    wxSizer *CreateButtonSizer( long flags );
+    wxSizer* CreateButtonSizer( long flags,
+                                bool separated = false,
+                                wxCoord distance = 0 );
+    wxStdDialogButtonSizer* CreateStdDialogButtonSizer( long flags );

 
 

-
-    //void SetModal(bool flag);
+    //void SetModal( bool flag );

 
     // is the dialog in modal state right now?
     virtual bool IsModal() const;
 
     // is the dialog in modal state right now?
     virtual bool IsModal() const;


@@ -329,11 +362,6 @@ public:
 
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);

-
-    %pythoncode {
-        def SendSizeEvent(self):
-            self.ProcessEvent(wx.SizeEvent((-1,-1)))
-    }

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------


@@ -342,26 +370,28 @@ public:
 
 MustHaveApp(wxMiniFrame);
 
 
 MustHaveApp(wxMiniFrame);
 

-class wxMiniFrame : public wxFrame {
+class wxMiniFrame : public wxFrame
+{

 public:
     %pythonAppend wxMiniFrame         "self._setOORInfo(self)"
     %pythonAppend wxMiniFrame()       ""
 
 public:
     %pythonAppend wxMiniFrame         "self._setOORInfo(self)"
     %pythonAppend wxMiniFrame()       ""
 

-    wxMiniFrame(wxWindow* parent, const wxWindowID id=-1,
-                const wxString& title = wxPyEmptyString,
-                const wxPoint& pos = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
-                long style = wxDEFAULT_FRAME_STYLE,
-                const wxString& name = wxPyFrameNameStr);
-    %name(PreMiniFrame)wxMiniFrame();
-
-    bool Create(wxWindow* parent, const wxWindowID id=-1,
-                const wxString& title = wxPyEmptyString,
-                const wxPoint& pos = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
-                long style = wxDEFAULT_FRAME_STYLE,
-                const wxString& name = wxPyFrameNameStr);
+    wxMiniFrame(wxWindow* parent,
+            const wxWindowID id = -1,
+            const wxString& title = wxPyEmptyString,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize,
+            long style = wxDEFAULT_FRAME_STYLE,
+            const wxString& name = wxPyFrameNameStr);
+    %RenameCtor(PreMiniFrame, wxMiniFrame());

 
 

+    bool Create(wxWindow* parent,
+            const wxWindowID id = -1,
+            const wxString& title = wxPyEmptyString,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize,
+            long style = wxDEFAULT_FRAME_STYLE,
+            const wxString& name = wxPyFrameNameStr);

 };
 
 
 };
 
 


@@ -369,7 +399,8 @@ public:
 %newgroup
 
 
 %newgroup
 
 

-enum {
+enum
+{

     wxSPLASH_CENTRE_ON_PARENT,
     wxSPLASH_CENTRE_ON_SCREEN,
     wxSPLASH_NO_CENTRE,
     wxSPLASH_CENTRE_ON_PARENT,
     wxSPLASH_CENTRE_ON_SCREEN,
     wxSPLASH_NO_CENTRE,


@@ -386,10 +417,11 @@ public:
     %pythonAppend wxSplashScreenWindow         "self._setOORInfo(self)"
 
     wxSplashScreenWindow(const wxBitmap& bitmap,
     %pythonAppend wxSplashScreenWindow         "self._setOORInfo(self)"
 
     wxSplashScreenWindow(const wxBitmap& bitmap,

-                         wxWindow* parent, wxWindowID id,
-                         const wxPoint& pos = wxDefaultPosition,
-                         const wxSize& size = wxDefaultSize,
-                         long style = wxNO_BORDER);
+             wxWindow* parent,
+             wxWindowID id,
+             const wxPoint& pos = wxDefaultPosition,
+             const wxSize& size = wxDefaultSize,
+             long style = wxNO_BORDER);

 
     void SetBitmap(const wxBitmap& bitmap);
     wxBitmap& GetBitmap();
 
     void SetBitmap(const wxBitmap& bitmap);
     wxBitmap& GetBitmap();


@@ -398,15 +430,18 @@ public:
 
 MustHaveApp(wxSplashScreen);
 
 
 MustHaveApp(wxSplashScreen);
 

-class wxSplashScreen : public wxFrame {
+class wxSplashScreen : public wxFrame
+{

 public:
     %pythonAppend wxSplashScreen         "self._setOORInfo(self)"
 
 public:
     %pythonAppend wxSplashScreen         "self._setOORInfo(self)"
 

-    wxSplashScreen(const wxBitmap& bitmap, long splashStyle, int milliseconds,
-                   wxWindow* parent, wxWindowID id=-1,
-                   const wxPoint& pos = wxDefaultPosition,
-                   const wxSize& size = wxDefaultSize,
-                   long style = wxSIMPLE_BORDER|wxFRAME_NO_TASKBAR|wxSTAY_ON_TOP);
+    wxSplashScreen(const wxBitmap& bitmap,
+            long splashStyle, int milliseconds,
+            wxWindow* parent,
+            wxWindowID id = -1,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize,
+            long style = wxSIMPLE_BORDER | wxFRAME_NO_TASKBAR | wxSTAY_ON_TOP);

 
     long GetSplashStyle() const;
     wxSplashScreenWindow* GetSplashWindow() const;
 
     long GetSplashStyle() const;
     wxSplashScreenWindow* GetSplashWindow() const;