include/wx/osx/srchctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/osx/srchctrl.h
   3 // Purpose:     mac carbon wxSearchCtrl class
   4 // Author:      Vince Harron
   5 // Created:     2006-02-19
   6 // RCS-ID:      $Id$
   7 // Copyright:   Vince Harron
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_SEARCHCTRL_H_
  12 #define _WX_SEARCHCTRL_H_
  13
  14 #if wxUSE_SEARCHCTRL
  15
  16 class wxSearchWidgetImpl;
  17
  18 class WXDLLIMPEXP_CORE wxSearchCtrl : public wxSearchCtrlBase
  19 {
  20 public:
  21     // creation
  22     // --------
  23
  24     wxSearchCtrl();
  25     wxSearchCtrl(wxWindow *parent, wxWindowID id,
  26                const wxString& value = wxEmptyString,
  27                const wxPoint& pos = wxDefaultPosition,
  28                const wxSize& size = wxDefaultSize,
  29                long style = 0,
  30                const wxValidator& validator = wxDefaultValidator,
  31                const wxString& name = wxSearchCtrlNameStr);
  32
  33     virtual ~wxSearchCtrl();
  34
  35     bool Create(wxWindow *parent, wxWindowID id,
  36                 const wxString& value = wxEmptyString,
  37                 const wxPoint& pos = wxDefaultPosition,
  38                 const wxSize& size = wxDefaultSize,
  39                 long style = 0,
  40                 const wxValidator& validator = wxDefaultValidator,
  41                 const wxString& name = wxSearchCtrlNameStr);
  42
  43     // get/set search button menu
  44     // --------------------------
  45     virtual void SetMenu( wxMenu* menu );
  46     virtual wxMenu* GetMenu();
  47
  48     // get/set search options
  49     // ----------------------
  50     virtual void ShowSearchButton( bool show );
  51     virtual bool IsSearchButtonVisible() const;
  52
  53     virtual void ShowCancelButton( bool show );
  54     virtual bool IsCancelButtonVisible() const;
  55
  56     // TODO: In 2.9 these should probably be virtual, and declared in the base class...
  57     void        SetDescriptiveText(const wxString& text);
  58     wxString    GetDescriptiveText() const;
  59
  60     virtual bool    HandleSearchFieldSearchHit() ;
  61     virtual bool    HandleSearchFieldCancelHit() ;
  62
  63     wxSearchWidgetImpl * GetSearchPeer() const;
  64
  65 protected:
  66
  67     wxSize DoGetBestSize() const;
  68
  69     void Init();
  70
  71     wxMenu *m_menu;
  72
  73     wxString m_descriptiveText;
  74
  75 private:
  76     DECLARE_DYNAMIC_CLASS(wxSearchCtrl)
  77
  78     DECLARE_EVENT_TABLE()
  79 };
  80
  81 #endif // wxUSE_SEARCHCTRL
  82
  83 #endif // _WX_SEARCHCTRL_H_
  84