]> git.saurik.com Git - wxWidgets.git/commitdiff
reSWIGged
authorRobin Dunn <robin@alldunn.com>
Mon, 11 Dec 2006 20:13:21 +0000 (20:13 +0000)
committerRobin Dunn <robin@alldunn.com>
Mon, 11 Dec 2006 20:13:21 +0000 (20:13 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@43938 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

wxPython/src/gtk/_controls.py
wxPython/src/gtk/_controls_wrap.cpp
wxPython/src/gtk/_core.py
wxPython/src/mac/_controls.py
wxPython/src/mac/_controls_wrap.cpp
wxPython/src/mac/_core.py
wxPython/src/msw/_controls.py
wxPython/src/msw/_controls_wrap.cpp
wxPython/src/msw/_core.py

index 2046f1f4fc6d932a2779af5f2bbbea542afd3242..7374f40d1383a1a8130c13aac3c31065d753192c 100644 (file)
@@ -7132,7 +7132,31 @@ _controls_.CollapsiblePaneEvent_swigregister(CollapsiblePaneEvent)
 #---------------------------------------------------------------------------
 
 class SearchCtrl(TextCtrl):
 #---------------------------------------------------------------------------
 
 class SearchCtrl(TextCtrl):
-    """Proxy of C++ SearchCtrl class"""
+    """
+    A search control is a composite of a `wx.TextCtrl` with optional
+    bitmap buttons and a drop-down menu.  Controls like this can typically
+    be found on a toolbar of applications that support some form of search
+    functionality.  On the Mac this control is implemneted using the
+    native HISearchField control, on the other platforms a generic control
+    is used, although that may change in the future as more platforms
+    introduce native search widgets.
+
+    If you wish to use a drop-down menu with your wx.SearchCtrl then you
+    will need to manage its content and handle the menu events yourself,
+    but this is an easy thing to do.  Simply build the menu, pass it to
+    `SetMenu`, and also bind a handler for a range of EVT_MENU events.
+    This gives you the flexibility to use the drop-down menu however you
+    wish, such as for a history of searches, or as a way to select
+    different kinds of searches.  The ToolBar.py sample in the demo shows
+    one way to do this.
+
+    Since the control derives from `wx.TextCtrl` it is convenient to use
+    the styles and events designed for `wx.TextCtrl`.  For example you can
+    use the ``wx.TE_PROCESS_ENTER`` style and catch the
+    ``wx.EVT_TEXT_ENTER`` event to know when the user has pressed the
+    Enter key in the control and wishes to start a search.
+
+    """
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
     __repr__ = _swig_repr
     def __init__(self, *args, **kwargs): 
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
     __repr__ = _swig_repr
     def __init__(self, *args, **kwargs): 
@@ -7141,6 +7165,30 @@ class SearchCtrl(TextCtrl):
             Point pos=DefaultPosition, Size size=DefaultSize, 
             long style=0, Validator validator=DefaultValidator, 
             String name=SearchCtrlNameStr) -> SearchCtrl
             Point pos=DefaultPosition, Size size=DefaultSize, 
             long style=0, Validator validator=DefaultValidator, 
             String name=SearchCtrlNameStr) -> SearchCtrl
+
+        A search control is a composite of a `wx.TextCtrl` with optional
+        bitmap buttons and a drop-down menu.  Controls like this can typically
+        be found on a toolbar of applications that support some form of search
+        functionality.  On the Mac this control is implemneted using the
+        native HISearchField control, on the other platforms a generic control
+        is used, although that may change in the future as more platforms
+        introduce native search widgets.
+
+        If you wish to use a drop-down menu with your wx.SearchCtrl then you
+        will need to manage its content and handle the menu events yourself,
+        but this is an easy thing to do.  Simply build the menu, pass it to
+        `SetMenu`, and also bind a handler for a range of EVT_MENU events.
+        This gives you the flexibility to use the drop-down menu however you
+        wish, such as for a history of searches, or as a way to select
+        different kinds of searches.  The ToolBar.py sample in the demo shows
+        one way to do this.
+
+        Since the control derives from `wx.TextCtrl` it is convenient to use
+        the styles and events designed for `wx.TextCtrl`.  For example you can
+        use the ``wx.TE_PROCESS_ENTER`` style and catch the
+        ``wx.EVT_TEXT_ENTER`` event to know when the user has pressed the
+        Enter key in the control and wishes to start a search.
+
         """
         _controls_.SearchCtrl_swiginit(self,_controls_.new_SearchCtrl(*args, **kwargs))
         self._setOORInfo(self)
         """
         _controls_.SearchCtrl_swiginit(self,_controls_.new_SearchCtrl(*args, **kwargs))
         self._setOORInfo(self)
@@ -7155,39 +7203,86 @@ class SearchCtrl(TextCtrl):
         return _controls_.SearchCtrl_Create(*args, **kwargs)
 
     def SetMenu(*args, **kwargs):
         return _controls_.SearchCtrl_Create(*args, **kwargs)
 
     def SetMenu(*args, **kwargs):
-        """SetMenu(self, Menu menu)"""
+        """
+        SetMenu(self, Menu menu)
+
+        Sets the search control's menu object. If there is already a menu
+        associated with the search control it is deleted.
+        """
         return _controls_.SearchCtrl_SetMenu(*args, **kwargs)
 
     def GetMenu(*args, **kwargs):
         return _controls_.SearchCtrl_SetMenu(*args, **kwargs)
 
     def GetMenu(*args, **kwargs):
-        """GetMenu(self) -> Menu"""
+        """
+        GetMenu(self) -> Menu
+
+        Returns a pointer to the search control's menu object or None if there
+        is no menu attached.
+        """
         return _controls_.SearchCtrl_GetMenu(*args, **kwargs)
 
     def ShowSearchButton(*args, **kwargs):
         return _controls_.SearchCtrl_GetMenu(*args, **kwargs)
 
     def ShowSearchButton(*args, **kwargs):
-        """ShowSearchButton(self, bool show)"""
+        """
+        ShowSearchButton(self, bool show)
+
+        Sets the search button visibility value on the search control. If
+        there is a menu attached, the search button will be visible regardless
+        of the search button visibility value.  This has no effect in Mac OS X
+        v10.3
+        """
         return _controls_.SearchCtrl_ShowSearchButton(*args, **kwargs)
 
     def IsSearchButtonVisible(*args, **kwargs):
         return _controls_.SearchCtrl_ShowSearchButton(*args, **kwargs)
 
     def IsSearchButtonVisible(*args, **kwargs):
-        """IsSearchButtonVisible(self) -> bool"""
+        """
+        IsSearchButtonVisible(self) -> bool
+
+        Returns the search button visibility value. If there is a menu
+        attached, the search button will be visible regardless of the search
+        button visibility value.  This always returns false in Mac OS X v10.3
+        """
         return _controls_.SearchCtrl_IsSearchButtonVisible(*args, **kwargs)
 
     def ShowCancelButton(*args, **kwargs):
         return _controls_.SearchCtrl_IsSearchButtonVisible(*args, **kwargs)
 
     def ShowCancelButton(*args, **kwargs):
-        """ShowCancelButton(self, bool show)"""
+        """
+        ShowCancelButton(self, bool show)
+
+        Shows or hides the cancel button.
+        """
         return _controls_.SearchCtrl_ShowCancelButton(*args, **kwargs)
 
     def IsCancelButtonVisible(*args, **kwargs):
         return _controls_.SearchCtrl_ShowCancelButton(*args, **kwargs)
 
     def IsCancelButtonVisible(*args, **kwargs):
-        """IsCancelButtonVisible(self) -> bool"""
+        """
+        IsCancelButtonVisible(self) -> bool
+
+        Indicates whether the cancel button is visible. 
+        """
         return _controls_.SearchCtrl_IsCancelButtonVisible(*args, **kwargs)
 
     def SetSearchBitmap(*args, **kwargs):
         return _controls_.SearchCtrl_IsCancelButtonVisible(*args, **kwargs)
 
     def SetSearchBitmap(*args, **kwargs):
-        """SetSearchBitmap(self, Bitmap bitmap)"""
+        """
+        SetSearchBitmap(self, Bitmap bitmap)
+
+        Sets the bitmap to use for the search button.  This currently does not
+        work on the Mac.
+        """
         return _controls_.SearchCtrl_SetSearchBitmap(*args, **kwargs)
 
     def SetSearchMenuBitmap(*args, **kwargs):
         return _controls_.SearchCtrl_SetSearchBitmap(*args, **kwargs)
 
     def SetSearchMenuBitmap(*args, **kwargs):
-        """SetSearchMenuBitmap(self, Bitmap bitmap)"""
+        """
+        SetSearchMenuBitmap(self, Bitmap bitmap)
+
+        Sets the bitmap to use for the search button when there is a drop-down
+        menu associated with the search control.  This currently does not work
+        on the Mac.
+        """
         return _controls_.SearchCtrl_SetSearchMenuBitmap(*args, **kwargs)
 
     def SetCancelBitmap(*args, **kwargs):
         return _controls_.SearchCtrl_SetSearchMenuBitmap(*args, **kwargs)
 
     def SetCancelBitmap(*args, **kwargs):
-        """SetCancelBitmap(self, Bitmap bitmap)"""
+        """
+        SetCancelBitmap(self, Bitmap bitmap)
+
+        Sets the bitmap to use for the cancel button.  This currently does not
+        work on the Mac.
+        """
         return _controls_.SearchCtrl_SetCancelBitmap(*args, **kwargs)
 
     Menu = property(GetMenu,SetMenu) 
         return _controls_.SearchCtrl_SetCancelBitmap(*args, **kwargs)
 
     Menu = property(GetMenu,SetMenu) 
index 852b4a79ff0b6c79b52bd9f5c0ff25a2321ae856..87bd03385a051ddd6ee5a3b12b805d6fa6778164 100644 (file)
@@ -3379,6 +3379,49 @@ SWIGINTERN wxDateTime wxDatePickerCtrl_GetUpperLimit(wxDatePickerCtrl *self){
  static const wxString wxPyFontPickerCtrlNameStr(wxFontPickerCtrlNameStr); 
  static const wxString wxPyCollapsiblePaneNameStr(wxCollapsiblePaneNameStr); 
  static const wxString wxPySearchCtrlNameStr(wxSearchCtrlNameStr); 
  static const wxString wxPyFontPickerCtrlNameStr(wxFontPickerCtrlNameStr); 
  static const wxString wxPyCollapsiblePaneNameStr(wxCollapsiblePaneNameStr); 
  static const wxString wxPySearchCtrlNameStr(wxSearchCtrlNameStr); 
+
+#if !defined(wxUSE_SEARCHCTRL) || !wxUSE_SEARCHCTRL
+// define a dummy class for builds that don't have wxSearchCtrl
+
+enum {
+    wxEVT_COMMAND_SEARCHCTRL_CANCEL,
+    wxEVT_COMMAND_SEARCHCTRL_SEARCH
+};
+
+class wxSearchCtrl : public wxTextCtrl
+{
+public:
+    wxSearchCtrl() { wxPyRaiseNotImplemented(); }
+    wxSearchCtrl(wxWindow*, wxWindowID,
+                 const wxString&,
+                 const wxPoint&,
+                 const wxSize&,
+                 long style,
+                 const wxValidator&,
+                 const wxString& name)
+    { wxPyRaiseNotImplemented(); }
+
+    bool Create( wxWindow*, wxWindowID,
+                 const wxString&,
+                 const wxPoint&,
+                 const wxSize&,
+                 long style,
+                 const wxValidator&,
+                 const wxString& name) {}
+        
+    virtual void SetMenu( wxMenu* ) {}
+    virtual wxMenu* GetMenu() { return NULL; }
+    
+    // get/set search options
+    // ----------------------
+    virtual void ShowSearchButton( bool ) {}
+    virtual bool IsSearchButtonVisible() const { return false; }
+
+    virtual void ShowCancelButton( bool ) {}
+    virtual bool IsCancelButtonVisible() const { return false; }
+};    
+#endif
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 #ifdef __cplusplus
 extern "C" {
 #endif
index 8cd90f30c7a325fbbfa6cabffa770ba8d2beeed7..fe4aaa4a0d38ef85b827398b491c03499f29258d 100644 (file)
@@ -10354,7 +10354,6 @@ class Window(EvtHandler):
         self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
 
     AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`") 
         self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
 
     AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`") 
-    AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`") 
     AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`") 
     BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`") 
     BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`") 
     AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`") 
     BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`") 
     BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`") 
index eb81e91d6a73fcf2fba92b7e2f2a0aed6feff9a6..988d2161113f8fc6d65171ad13eaeba2b2990819 100644 (file)
@@ -7125,7 +7125,31 @@ _controls_.CollapsiblePaneEvent_swigregister(CollapsiblePaneEvent)
 #---------------------------------------------------------------------------
 
 class SearchCtrl(TextCtrl):
 #---------------------------------------------------------------------------
 
 class SearchCtrl(TextCtrl):
-    """Proxy of C++ SearchCtrl class"""
+    """
+    A search control is a composite of a `wx.TextCtrl` with optional
+    bitmap buttons and a drop-down menu.  Controls like this can typically
+    be found on a toolbar of applications that support some form of search
+    functionality.  On the Mac this control is implemneted using the
+    native HISearchField control, on the other platforms a generic control
+    is used, although that may change in the future as more platforms
+    introduce native search widgets.
+
+    If you wish to use a drop-down menu with your wx.SearchCtrl then you
+    will need to manage its content and handle the menu events yourself,
+    but this is an easy thing to do.  Simply build the menu, pass it to
+    `SetMenu`, and also bind a handler for a range of EVT_MENU events.
+    This gives you the flexibility to use the drop-down menu however you
+    wish, such as for a history of searches, or as a way to select
+    different kinds of searches.  The ToolBar.py sample in the demo shows
+    one way to do this.
+
+    Since the control derives from `wx.TextCtrl` it is convenient to use
+    the styles and events designed for `wx.TextCtrl`.  For example you can
+    use the ``wx.TE_PROCESS_ENTER`` style and catch the
+    ``wx.EVT_TEXT_ENTER`` event to know when the user has pressed the
+    Enter key in the control and wishes to start a search.
+
+    """
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
     __repr__ = _swig_repr
     def __init__(self, *args, **kwargs): 
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
     __repr__ = _swig_repr
     def __init__(self, *args, **kwargs): 
@@ -7134,6 +7158,30 @@ class SearchCtrl(TextCtrl):
             Point pos=DefaultPosition, Size size=DefaultSize, 
             long style=0, Validator validator=DefaultValidator, 
             String name=SearchCtrlNameStr) -> SearchCtrl
             Point pos=DefaultPosition, Size size=DefaultSize, 
             long style=0, Validator validator=DefaultValidator, 
             String name=SearchCtrlNameStr) -> SearchCtrl
+
+        A search control is a composite of a `wx.TextCtrl` with optional
+        bitmap buttons and a drop-down menu.  Controls like this can typically
+        be found on a toolbar of applications that support some form of search
+        functionality.  On the Mac this control is implemneted using the
+        native HISearchField control, on the other platforms a generic control
+        is used, although that may change in the future as more platforms
+        introduce native search widgets.
+
+        If you wish to use a drop-down menu with your wx.SearchCtrl then you
+        will need to manage its content and handle the menu events yourself,
+        but this is an easy thing to do.  Simply build the menu, pass it to
+        `SetMenu`, and also bind a handler for a range of EVT_MENU events.
+        This gives you the flexibility to use the drop-down menu however you
+        wish, such as for a history of searches, or as a way to select
+        different kinds of searches.  The ToolBar.py sample in the demo shows
+        one way to do this.
+
+        Since the control derives from `wx.TextCtrl` it is convenient to use
+        the styles and events designed for `wx.TextCtrl`.  For example you can
+        use the ``wx.TE_PROCESS_ENTER`` style and catch the
+        ``wx.EVT_TEXT_ENTER`` event to know when the user has pressed the
+        Enter key in the control and wishes to start a search.
+
         """
         _controls_.SearchCtrl_swiginit(self,_controls_.new_SearchCtrl(*args, **kwargs))
         self._setOORInfo(self)
         """
         _controls_.SearchCtrl_swiginit(self,_controls_.new_SearchCtrl(*args, **kwargs))
         self._setOORInfo(self)
@@ -7148,39 +7196,86 @@ class SearchCtrl(TextCtrl):
         return _controls_.SearchCtrl_Create(*args, **kwargs)
 
     def SetMenu(*args, **kwargs):
         return _controls_.SearchCtrl_Create(*args, **kwargs)
 
     def SetMenu(*args, **kwargs):
-        """SetMenu(self, Menu menu)"""
+        """
+        SetMenu(self, Menu menu)
+
+        Sets the search control's menu object. If there is already a menu
+        associated with the search control it is deleted.
+        """
         return _controls_.SearchCtrl_SetMenu(*args, **kwargs)
 
     def GetMenu(*args, **kwargs):
         return _controls_.SearchCtrl_SetMenu(*args, **kwargs)
 
     def GetMenu(*args, **kwargs):
-        """GetMenu(self) -> Menu"""
+        """
+        GetMenu(self) -> Menu
+
+        Returns a pointer to the search control's menu object or None if there
+        is no menu attached.
+        """
         return _controls_.SearchCtrl_GetMenu(*args, **kwargs)
 
     def ShowSearchButton(*args, **kwargs):
         return _controls_.SearchCtrl_GetMenu(*args, **kwargs)
 
     def ShowSearchButton(*args, **kwargs):
-        """ShowSearchButton(self, bool show)"""
+        """
+        ShowSearchButton(self, bool show)
+
+        Sets the search button visibility value on the search control. If
+        there is a menu attached, the search button will be visible regardless
+        of the search button visibility value.  This has no effect in Mac OS X
+        v10.3
+        """
         return _controls_.SearchCtrl_ShowSearchButton(*args, **kwargs)
 
     def IsSearchButtonVisible(*args, **kwargs):
         return _controls_.SearchCtrl_ShowSearchButton(*args, **kwargs)
 
     def IsSearchButtonVisible(*args, **kwargs):
-        """IsSearchButtonVisible(self) -> bool"""
+        """
+        IsSearchButtonVisible(self) -> bool
+
+        Returns the search button visibility value. If there is a menu
+        attached, the search button will be visible regardless of the search
+        button visibility value.  This always returns false in Mac OS X v10.3
+        """
         return _controls_.SearchCtrl_IsSearchButtonVisible(*args, **kwargs)
 
     def ShowCancelButton(*args, **kwargs):
         return _controls_.SearchCtrl_IsSearchButtonVisible(*args, **kwargs)
 
     def ShowCancelButton(*args, **kwargs):
-        """ShowCancelButton(self, bool show)"""
+        """
+        ShowCancelButton(self, bool show)
+
+        Shows or hides the cancel button.
+        """
         return _controls_.SearchCtrl_ShowCancelButton(*args, **kwargs)
 
     def IsCancelButtonVisible(*args, **kwargs):
         return _controls_.SearchCtrl_ShowCancelButton(*args, **kwargs)
 
     def IsCancelButtonVisible(*args, **kwargs):
-        """IsCancelButtonVisible(self) -> bool"""
+        """
+        IsCancelButtonVisible(self) -> bool
+
+        Indicates whether the cancel button is visible. 
+        """
         return _controls_.SearchCtrl_IsCancelButtonVisible(*args, **kwargs)
 
     def SetSearchBitmap(*args, **kwargs):
         return _controls_.SearchCtrl_IsCancelButtonVisible(*args, **kwargs)
 
     def SetSearchBitmap(*args, **kwargs):
-        """SetSearchBitmap(self, Bitmap ?)"""
+        """
+        SetSearchBitmap(self, Bitmap ?)
+
+        Sets the bitmap to use for the search button.  This currently does not
+        work on the Mac.
+        """
         return _controls_.SearchCtrl_SetSearchBitmap(*args, **kwargs)
 
     def SetSearchMenuBitmap(*args, **kwargs):
         return _controls_.SearchCtrl_SetSearchBitmap(*args, **kwargs)
 
     def SetSearchMenuBitmap(*args, **kwargs):
-        """SetSearchMenuBitmap(self, Bitmap ?)"""
+        """
+        SetSearchMenuBitmap(self, Bitmap ?)
+
+        Sets the bitmap to use for the search button when there is a drop-down
+        menu associated with the search control.  This currently does not work
+        on the Mac.
+        """
         return _controls_.SearchCtrl_SetSearchMenuBitmap(*args, **kwargs)
 
     def SetCancelBitmap(*args, **kwargs):
         return _controls_.SearchCtrl_SetSearchMenuBitmap(*args, **kwargs)
 
     def SetCancelBitmap(*args, **kwargs):
-        """SetCancelBitmap(self, Bitmap ?)"""
+        """
+        SetCancelBitmap(self, Bitmap ?)
+
+        Sets the bitmap to use for the cancel button.  This currently does not
+        work on the Mac.
+        """
         return _controls_.SearchCtrl_SetCancelBitmap(*args, **kwargs)
 
     Menu = property(GetMenu,SetMenu) 
         return _controls_.SearchCtrl_SetCancelBitmap(*args, **kwargs)
 
     Menu = property(GetMenu,SetMenu) 
index f8d893c9b58e779cfd6560bfc715583884de754e..8e1353ca66cf4533bbd4eb705b5b12ccdb1f1928 100644 (file)
@@ -3378,6 +3378,49 @@ SWIGINTERN wxDateTime wxDatePickerCtrl_GetUpperLimit(wxDatePickerCtrl *self){
  static const wxString wxPyFontPickerCtrlNameStr(wxFontPickerCtrlNameStr); 
  static const wxString wxPyCollapsiblePaneNameStr(wxCollapsiblePaneNameStr); 
  static const wxString wxPySearchCtrlNameStr(wxSearchCtrlNameStr); 
  static const wxString wxPyFontPickerCtrlNameStr(wxFontPickerCtrlNameStr); 
  static const wxString wxPyCollapsiblePaneNameStr(wxCollapsiblePaneNameStr); 
  static const wxString wxPySearchCtrlNameStr(wxSearchCtrlNameStr); 
+
+#if !defined(wxUSE_SEARCHCTRL) || !wxUSE_SEARCHCTRL
+// define a dummy class for builds that don't have wxSearchCtrl
+
+enum {
+    wxEVT_COMMAND_SEARCHCTRL_CANCEL,
+    wxEVT_COMMAND_SEARCHCTRL_SEARCH
+};
+
+class wxSearchCtrl : public wxTextCtrl
+{
+public:
+    wxSearchCtrl() { wxPyRaiseNotImplemented(); }
+    wxSearchCtrl(wxWindow*, wxWindowID,
+                 const wxString&,
+                 const wxPoint&,
+                 const wxSize&,
+                 long style,
+                 const wxValidator&,
+                 const wxString& name)
+    { wxPyRaiseNotImplemented(); }
+
+    bool Create( wxWindow*, wxWindowID,
+                 const wxString&,
+                 const wxPoint&,
+                 const wxSize&,
+                 long style,
+                 const wxValidator&,
+                 const wxString& name) {}
+        
+    virtual void SetMenu( wxMenu* ) {}
+    virtual wxMenu* GetMenu() { return NULL; }
+    
+    // get/set search options
+    // ----------------------
+    virtual void ShowSearchButton( bool ) {}
+    virtual bool IsSearchButtonVisible() const { return false; }
+
+    virtual void ShowCancelButton( bool ) {}
+    virtual bool IsCancelButtonVisible() const { return false; }
+};    
+#endif
+
 SWIGINTERN void wxSearchCtrl_SetSearchBitmap(wxSearchCtrl *self,wxBitmap const &){}
 SWIGINTERN void wxSearchCtrl_SetSearchMenuBitmap(wxSearchCtrl *self,wxBitmap const &){}
 SWIGINTERN void wxSearchCtrl_SetCancelBitmap(wxSearchCtrl *self,wxBitmap const &){}
 SWIGINTERN void wxSearchCtrl_SetSearchBitmap(wxSearchCtrl *self,wxBitmap const &){}
 SWIGINTERN void wxSearchCtrl_SetSearchMenuBitmap(wxSearchCtrl *self,wxBitmap const &){}
 SWIGINTERN void wxSearchCtrl_SetCancelBitmap(wxSearchCtrl *self,wxBitmap const &){}
index 8cd90f30c7a325fbbfa6cabffa770ba8d2beeed7..fe4aaa4a0d38ef85b827398b491c03499f29258d 100644 (file)
@@ -10354,7 +10354,6 @@ class Window(EvtHandler):
         self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
 
     AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`") 
         self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
 
     AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`") 
-    AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`") 
     AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`") 
     BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`") 
     BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`") 
     AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`") 
     BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`") 
     BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`") 
index 347d9728836302880ba4b0fe55ba8fc3b82a0d24..98a522b20f53823e8b906d9b14ae9c0299bdc9f8 100644 (file)
@@ -7151,7 +7151,31 @@ _controls_.CollapsiblePaneEvent_swigregister(CollapsiblePaneEvent)
 #---------------------------------------------------------------------------
 
 class SearchCtrl(TextCtrl):
 #---------------------------------------------------------------------------
 
 class SearchCtrl(TextCtrl):
-    """Proxy of C++ SearchCtrl class"""
+    """
+    A search control is a composite of a `wx.TextCtrl` with optional
+    bitmap buttons and a drop-down menu.  Controls like this can typically
+    be found on a toolbar of applications that support some form of search
+    functionality.  On the Mac this control is implemneted using the
+    native HISearchField control, on the other platforms a generic control
+    is used, although that may change in the future as more platforms
+    introduce native search widgets.
+
+    If you wish to use a drop-down menu with your wx.SearchCtrl then you
+    will need to manage its content and handle the menu events yourself,
+    but this is an easy thing to do.  Simply build the menu, pass it to
+    `SetMenu`, and also bind a handler for a range of EVT_MENU events.
+    This gives you the flexibility to use the drop-down menu however you
+    wish, such as for a history of searches, or as a way to select
+    different kinds of searches.  The ToolBar.py sample in the demo shows
+    one way to do this.
+
+    Since the control derives from `wx.TextCtrl` it is convenient to use
+    the styles and events designed for `wx.TextCtrl`.  For example you can
+    use the ``wx.TE_PROCESS_ENTER`` style and catch the
+    ``wx.EVT_TEXT_ENTER`` event to know when the user has pressed the
+    Enter key in the control and wishes to start a search.
+
+    """
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
     __repr__ = _swig_repr
     def __init__(self, *args, **kwargs): 
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
     __repr__ = _swig_repr
     def __init__(self, *args, **kwargs): 
@@ -7160,6 +7184,30 @@ class SearchCtrl(TextCtrl):
             Point pos=DefaultPosition, Size size=DefaultSize, 
             long style=0, Validator validator=DefaultValidator, 
             String name=SearchCtrlNameStr) -> SearchCtrl
             Point pos=DefaultPosition, Size size=DefaultSize, 
             long style=0, Validator validator=DefaultValidator, 
             String name=SearchCtrlNameStr) -> SearchCtrl
+
+        A search control is a composite of a `wx.TextCtrl` with optional
+        bitmap buttons and a drop-down menu.  Controls like this can typically
+        be found on a toolbar of applications that support some form of search
+        functionality.  On the Mac this control is implemneted using the
+        native HISearchField control, on the other platforms a generic control
+        is used, although that may change in the future as more platforms
+        introduce native search widgets.
+
+        If you wish to use a drop-down menu with your wx.SearchCtrl then you
+        will need to manage its content and handle the menu events yourself,
+        but this is an easy thing to do.  Simply build the menu, pass it to
+        `SetMenu`, and also bind a handler for a range of EVT_MENU events.
+        This gives you the flexibility to use the drop-down menu however you
+        wish, such as for a history of searches, or as a way to select
+        different kinds of searches.  The ToolBar.py sample in the demo shows
+        one way to do this.
+
+        Since the control derives from `wx.TextCtrl` it is convenient to use
+        the styles and events designed for `wx.TextCtrl`.  For example you can
+        use the ``wx.TE_PROCESS_ENTER`` style and catch the
+        ``wx.EVT_TEXT_ENTER`` event to know when the user has pressed the
+        Enter key in the control and wishes to start a search.
+
         """
         _controls_.SearchCtrl_swiginit(self,_controls_.new_SearchCtrl(*args, **kwargs))
         self._setOORInfo(self)
         """
         _controls_.SearchCtrl_swiginit(self,_controls_.new_SearchCtrl(*args, **kwargs))
         self._setOORInfo(self)
@@ -7174,39 +7222,86 @@ class SearchCtrl(TextCtrl):
         return _controls_.SearchCtrl_Create(*args, **kwargs)
 
     def SetMenu(*args, **kwargs):
         return _controls_.SearchCtrl_Create(*args, **kwargs)
 
     def SetMenu(*args, **kwargs):
-        """SetMenu(self, Menu menu)"""
+        """
+        SetMenu(self, Menu menu)
+
+        Sets the search control's menu object. If there is already a menu
+        associated with the search control it is deleted.
+        """
         return _controls_.SearchCtrl_SetMenu(*args, **kwargs)
 
     def GetMenu(*args, **kwargs):
         return _controls_.SearchCtrl_SetMenu(*args, **kwargs)
 
     def GetMenu(*args, **kwargs):
-        """GetMenu(self) -> Menu"""
+        """
+        GetMenu(self) -> Menu
+
+        Returns a pointer to the search control's menu object or None if there
+        is no menu attached.
+        """
         return _controls_.SearchCtrl_GetMenu(*args, **kwargs)
 
     def ShowSearchButton(*args, **kwargs):
         return _controls_.SearchCtrl_GetMenu(*args, **kwargs)
 
     def ShowSearchButton(*args, **kwargs):
-        """ShowSearchButton(self, bool show)"""
+        """
+        ShowSearchButton(self, bool show)
+
+        Sets the search button visibility value on the search control. If
+        there is a menu attached, the search button will be visible regardless
+        of the search button visibility value.  This has no effect in Mac OS X
+        v10.3
+        """
         return _controls_.SearchCtrl_ShowSearchButton(*args, **kwargs)
 
     def IsSearchButtonVisible(*args, **kwargs):
         return _controls_.SearchCtrl_ShowSearchButton(*args, **kwargs)
 
     def IsSearchButtonVisible(*args, **kwargs):
-        """IsSearchButtonVisible(self) -> bool"""
+        """
+        IsSearchButtonVisible(self) -> bool
+
+        Returns the search button visibility value. If there is a menu
+        attached, the search button will be visible regardless of the search
+        button visibility value.  This always returns false in Mac OS X v10.3
+        """
         return _controls_.SearchCtrl_IsSearchButtonVisible(*args, **kwargs)
 
     def ShowCancelButton(*args, **kwargs):
         return _controls_.SearchCtrl_IsSearchButtonVisible(*args, **kwargs)
 
     def ShowCancelButton(*args, **kwargs):
-        """ShowCancelButton(self, bool show)"""
+        """
+        ShowCancelButton(self, bool show)
+
+        Shows or hides the cancel button.
+        """
         return _controls_.SearchCtrl_ShowCancelButton(*args, **kwargs)
 
     def IsCancelButtonVisible(*args, **kwargs):
         return _controls_.SearchCtrl_ShowCancelButton(*args, **kwargs)
 
     def IsCancelButtonVisible(*args, **kwargs):
-        """IsCancelButtonVisible(self) -> bool"""
+        """
+        IsCancelButtonVisible(self) -> bool
+
+        Indicates whether the cancel button is visible. 
+        """
         return _controls_.SearchCtrl_IsCancelButtonVisible(*args, **kwargs)
 
     def SetSearchBitmap(*args, **kwargs):
         return _controls_.SearchCtrl_IsCancelButtonVisible(*args, **kwargs)
 
     def SetSearchBitmap(*args, **kwargs):
-        """SetSearchBitmap(self, Bitmap bitmap)"""
+        """
+        SetSearchBitmap(self, Bitmap bitmap)
+
+        Sets the bitmap to use for the search button.  This currently does not
+        work on the Mac.
+        """
         return _controls_.SearchCtrl_SetSearchBitmap(*args, **kwargs)
 
     def SetSearchMenuBitmap(*args, **kwargs):
         return _controls_.SearchCtrl_SetSearchBitmap(*args, **kwargs)
 
     def SetSearchMenuBitmap(*args, **kwargs):
-        """SetSearchMenuBitmap(self, Bitmap bitmap)"""
+        """
+        SetSearchMenuBitmap(self, Bitmap bitmap)
+
+        Sets the bitmap to use for the search button when there is a drop-down
+        menu associated with the search control.  This currently does not work
+        on the Mac.
+        """
         return _controls_.SearchCtrl_SetSearchMenuBitmap(*args, **kwargs)
 
     def SetCancelBitmap(*args, **kwargs):
         return _controls_.SearchCtrl_SetSearchMenuBitmap(*args, **kwargs)
 
     def SetCancelBitmap(*args, **kwargs):
-        """SetCancelBitmap(self, Bitmap bitmap)"""
+        """
+        SetCancelBitmap(self, Bitmap bitmap)
+
+        Sets the bitmap to use for the cancel button.  This currently does not
+        work on the Mac.
+        """
         return _controls_.SearchCtrl_SetCancelBitmap(*args, **kwargs)
 
     Menu = property(GetMenu,SetMenu) 
         return _controls_.SearchCtrl_SetCancelBitmap(*args, **kwargs)
 
     Menu = property(GetMenu,SetMenu) 
index 6383baa408c33282fd8f1c4ea62a177b0e556668..45e78605ff9e679ddeb5e752da074af0e89678d6 100644 (file)
@@ -3379,6 +3379,49 @@ SWIGINTERN wxDateTime wxDatePickerCtrl_GetUpperLimit(wxDatePickerCtrl *self){
  static const wxString wxPyFontPickerCtrlNameStr(wxFontPickerCtrlNameStr); 
  static const wxString wxPyCollapsiblePaneNameStr(wxCollapsiblePaneNameStr); 
  static const wxString wxPySearchCtrlNameStr(wxSearchCtrlNameStr); 
  static const wxString wxPyFontPickerCtrlNameStr(wxFontPickerCtrlNameStr); 
  static const wxString wxPyCollapsiblePaneNameStr(wxCollapsiblePaneNameStr); 
  static const wxString wxPySearchCtrlNameStr(wxSearchCtrlNameStr); 
+
+#if !defined(wxUSE_SEARCHCTRL) || !wxUSE_SEARCHCTRL
+// define a dummy class for builds that don't have wxSearchCtrl
+
+enum {
+    wxEVT_COMMAND_SEARCHCTRL_CANCEL,
+    wxEVT_COMMAND_SEARCHCTRL_SEARCH
+};
+
+class wxSearchCtrl : public wxTextCtrl
+{
+public:
+    wxSearchCtrl() { wxPyRaiseNotImplemented(); }
+    wxSearchCtrl(wxWindow*, wxWindowID,
+                 const wxString&,
+                 const wxPoint&,
+                 const wxSize&,
+                 long style,
+                 const wxValidator&,
+                 const wxString& name)
+    { wxPyRaiseNotImplemented(); }
+
+    bool Create( wxWindow*, wxWindowID,
+                 const wxString&,
+                 const wxPoint&,
+                 const wxSize&,
+                 long style,
+                 const wxValidator&,
+                 const wxString& name) {}
+        
+    virtual void SetMenu( wxMenu* ) {}
+    virtual wxMenu* GetMenu() { return NULL; }
+    
+    // get/set search options
+    // ----------------------
+    virtual void ShowSearchButton( bool ) {}
+    virtual bool IsSearchButtonVisible() const { return false; }
+
+    virtual void ShowCancelButton( bool ) {}
+    virtual bool IsCancelButtonVisible() const { return false; }
+};    
+#endif
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 #ifdef __cplusplus
 extern "C" {
 #endif
index cc39b63f7ce8944b70a5fd2ee03bd2c2582ebea3..982503e9390988a836a32146633ff94f123b26ad 100644 (file)
@@ -10358,7 +10358,6 @@ class Window(EvtHandler):
         self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
 
     AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`") 
         self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
 
     AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`") 
-    AdjustedBestSize = property(GetAdjustedBestSize,doc="See `GetAdjustedBestSize`") 
     AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`") 
     BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`") 
     BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`") 
     AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`") 
     BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`") 
     BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`")