'[1219035] cleanup: miscellaneous' and minor source cleaning.

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

diff --git a/wxPython/src/_panel.i b/wxPython/src/_panel.i
index bee9ca00fd91eb1c2e04588804f2ef45dc6b43e1..881ceefcec622608e58cba80c72f3fef679c118a 100644 (file)
--- a/wxPython/src/_panel.i
+++ b/wxPython/src/_panel.i
@@ -22,11 +22,14 @@
 %newgroup
 
 
+MustHaveApp(wxPanel);
+
 class wxPanel : public wxWindow
 {
 public:
     %pythonAppend wxPanel         "self._setOORInfo(self)"
     %pythonAppend wxPanel()       ""
+    %typemap(out) wxPanel*;    // turn off this typemap
 
     wxPanel(wxWindow* parent,
             const wxWindowID id=-1,
@@ -34,7 +37,10 @@ public:
             const wxSize& size = wxDefaultSize,
             long style = wxTAB_TRAVERSAL | wxNO_BORDER,
             const wxString& name = wxPyPanelNameStr);
-    %name(PrePanel)wxPanel();
+    %RenameCtor(PrePanel, wxPanel());
+
+    // Turn it back on again
+    %typemap(out) wxPanel* { $result = wxPyMake_wxObject($1, $owner); }
 
     bool Create(wxWindow* parent,
                 const wxWindowID id=-1,
@@ -45,6 +51,24 @@ public:
 
     void InitDialog();
 
+
+    DocDeclStr(
+        virtual void , SetFocus(),
+        "Overrides `wx.Window.SetFocus`.  This method uses the (undocumented)
+mix-in class wxControlContainer which manages the focus and TAB logic
+for controls which usually have child controls.  In practice, if you
+call this method and the panel has at least one child window, then the
+focus will be given to the child window.", "
+:see: `wx.FocusEvent`, `wx.Window.SetFocus`, `SetFocusIgnoringChildren`");
+    
+
+    DocDeclStr(
+        virtual void , SetFocusIgnoringChildren(),
+        "In contrast to `SetFocus` (see above) this will set the focus to the
+panel even of there are child windows in the panel. This is only
+rarely needed.", "");
+    
+
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 };
@@ -57,11 +81,14 @@ public:
 //       derive from it and wxPanel.  But what to do about wxGTK where this
 //       is not True?
 
+MustHaveApp(wxScrolledWindow);
+
 class wxScrolledWindow : public wxPanel
 {
 public:
     %pythonAppend wxScrolledWindow         "self._setOORInfo(self)"
     %pythonAppend wxScrolledWindow()       ""
+    %typemap(out) wxScrolledWindow*;    // turn off this typemap
 
     wxScrolledWindow(wxWindow* parent,
                      const wxWindowID id = -1,
@@ -69,7 +96,10 @@ public:
                      const wxSize& size = wxDefaultSize,
                      long style = wxHSCROLL | wxVSCROLL,
                      const wxString& name = wxPyPanelNameStr);
-    %name(PreScrolledWindow)wxScrolledWindow();
+    %RenameCtor(PreScrolledWindow, wxScrolledWindow());
+
+    // Turn it back on again
+    %typemap(out) wxScrolledWindow* { $result = wxPyMake_wxObject($1, $owner); }
 
     bool Create(wxWindow* parent,
                 const wxWindowID id = -1,
@@ -83,7 +113,7 @@ public:
     virtual void SetScrollbars(int pixelsPerUnitX, int pixelsPerUnitY,
                                int noUnitsX, int noUnitsY,
                                int xPos = 0, int yPos = 0,
-                               bool noRefresh = False );
+                               bool noRefresh = false );
 
     // scroll to the given (in logical coords) position
     virtual void Scroll(int x, int y);
@@ -159,6 +189,12 @@ public:
     wxRect GetTargetRect() const;
 #endif
 
+    // TODO: directorize this?
+    DocDeclStr(
+        virtual void , DoPrepareDC( wxDC & dc ),
+        "Normally what is called by `PrepareDC`.", "");
+
+    
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 };