/usr/include/wx-3.0/wx/wxPython/i_files/_srchctrl.i is in python-wxgtk3.0-dev 3.0.2.0+dfsg-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 | /////////////////////////////////////////////////////////////////////////////
// Name: _srchctrl.i
// Purpose: SWIG interface for wxSearchCtrl
//
// Author: Robin Dunn
//
// Created: 9-Dec-2006
// RCS-ID: $Id$
// Copyright: (c) 2006 by Total Control Software
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
// Not a %module
//---------------------------------------------------------------------------
%newgroup
MAKE_CONST_WXSTRING(SearchCtrlNameStr);
%{
#if !defined(wxUSE_SEARCHCTRL) || !wxUSE_SEARCHCTRL
// define a dummy class for builds that don't have wxSearchCtrl
enum {
wxEVT_COMMAND_SEARCHCTRL_CANCEL_BTN,
wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN
};
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; }
virtual void SetDescriptiveText(const wxString& text);
virtual wxString GetDescriptiveText() const;
};
#endif
%}
// Now define the class for SWIG
MustHaveApp(wxSearchCtrl);
DocStr(wxSearchCtrl,
"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 implemented 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.
", "
Events
-------
========================= =========================================
EVT_SEARCHCTRL_SEARCH_BTN Sent when the search icon is clicked
EVT_SEARCHCTRL_CANCEL_BTN Sent when the cancel icon is clicked
EVT_TEXT Sent when the text changes
EVT_TEXT_ENTER Sent when the RETURN/ENTER key is pressed
in the search control and the control has
the wx.TE_PROCESS_ENTER style flag set.
========================= =========================================
");
#ifdef __WXMAC__
class wxSearchCtrlBase : public wxTextCtrl
{
};
#else
class wxSearchCtrlBase : public wxControl,
public wxTextCtrlIface
{
};
#endif
class wxSearchCtrl : public wxSearchCtrlBase
{
public:
%pythonAppend wxSearchCtrl "self._setOORInfo(self)";
%pythonAppend wxSearchCtrl() "";
wxSearchCtrl(wxWindow *parent, wxWindowID id=-1,
const wxString& value = wxEmptyString,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPySearchCtrlNameStr);
DocCtorStrName(
wxSearchCtrl(),
"Precreate a wx.SearchCtrl for 2-phase creation.", "",
PreSearchCtrl);
bool Create(wxWindow *parent, wxWindowID id=-1,
const wxString& value = wxEmptyString,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPySearchCtrlNameStr);
DocDeclStr(
virtual void , SetMenu( wxMenu* menu ),
"Sets the search control's menu object. If there is already a menu
associated with the search control it is deleted.", "");
DocDeclStr(
virtual wxMenu* , GetMenu(),
"Returns a pointer to the search control's menu object or None if there
is no menu attached.", "");
DocDeclStr(
virtual void , ShowSearchButton( 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", "");
DocDeclStr(
virtual bool , IsSearchButtonVisible() const,
"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", "");
DocDeclStr(
virtual void , ShowCancelButton( bool show ),
"Shows or hides the cancel button.", "");
DocDeclStr(
virtual bool , IsCancelButtonVisible() const,
"Indicates whether the cancel button is visible. ", "");
DocDeclStr(
virtual void , SetDescriptiveText(const wxString& text),
"Set the text to be displayed when the user has not yet typed anything
in the control.", "");
DocDeclStr(
virtual wxString , GetDescriptiveText() const,
"Get the text to be displayed when the user has not yet typed anything
in the control.", "");
DocStr(SetSearchBitmap,
"Sets the bitmap to use for the search button. This currently does not
work on the Mac.", "");
DocStr(SetSearchMenuBitmap,
"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.", "");
DocStr(SetCancelBitmap,
"Sets the bitmap to use for the cancel button. This currently does not
work on the Mac.", "");
#ifdef __WXMAC__
%extend {
void SetSearchBitmap( const wxBitmap& ) {}
void SetSearchMenuBitmap( const wxBitmap& ) {}
void SetCancelBitmap( const wxBitmap& ) {}
}
#else
void SetSearchBitmap( const wxBitmap& bitmap );
void SetSearchMenuBitmap( const wxBitmap& bitmap );
void SetCancelBitmap( const wxBitmap& bitmap );
#endif
%property(Menu, GetMenu, SetMenu);
%property(SearchButtonVisible, IsSearchButtonVisible, ShowSearchButton);
%property(CancelButtonVisible, IsCancelButtonVisible, ShowCancelButton);
%property(DescriptiveText, GetDescriptiveText, SetDescriptiveText);
};
%constant wxEventType wxEVT_COMMAND_SEARCHCTRL_CANCEL_BTN;
%constant wxEventType wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN;
%pythoncode {
EVT_SEARCHCTRL_CANCEL_BTN = wx.PyEventBinder( wxEVT_COMMAND_SEARCHCTRL_CANCEL_BTN, 1)
EVT_SEARCHCTRL_SEARCH_BTN = wx.PyEventBinder( wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN, 1)
}
//---------------------------------------------------------------------------
|