]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/_misc.i
Version
[wxWidgets.git] / wxPython / src / _misc.i
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: _misc.i
3 // Purpose: SWIG interface definitions for lots of little stuff that
4 // don't deserve their own file. ;-)
5 //
6 // Author: Robin Dunn
7 //
8 // Created: 18-June-1999
9 // RCS-ID: $Id$
10 // Copyright: (c) 2003 by Total Control Software
11 // Licence: wxWindows license
12 /////////////////////////////////////////////////////////////////////////////
13
14 // Not a %module
15
16
17 //---------------------------------------------------------------------------
18 %newgroup
19
20
21 #ifndef __WXX11__
22
23 MustHaveApp(wxToolTip);
24
25 class wxToolTip : public wxObject {
26 public:
27 wxToolTip(const wxString &tip);
28
29 void SetTip(const wxString& tip);
30 wxString GetTip();
31 // *** Not in the "public" interface void SetWindow(wxWindow *win);
32 wxWindow *GetWindow();
33
34 static void Enable(bool flag);
35 static void SetDelay(long milliseconds);
36 };
37 #endif
38
39 //---------------------------------------------------------------------------
40
41 MustHaveApp(wxCaret);
42
43 class wxCaret {
44 public:
45 wxCaret(wxWindow* window, const wxSize& size);
46 // ~wxCaret(); Window takes ownership
47
48 %extend {
49 DocStr(Destroy,
50 "Deletes the C++ object this Python object is a proxy for.", "");
51 void Destroy() {
52 delete self;
53 }
54 }
55
56 bool IsOk();
57 bool IsVisible();
58
59 wxPoint GetPosition();
60 DocDeclAName(
61 void, GetPosition(int *OUTPUT, int *OUTPUT),
62 "GetPositionTuple() -> (x,y)",
63 GetPositionTuple);
64
65 wxSize GetSize();
66 DocDeclAName(
67 void, GetSize( int *OUTPUT, int *OUTPUT ),
68 "GetSizeTuple() -> (width, height)",
69 GetSizeTuple);
70
71
72 wxWindow *GetWindow();
73 %Rename(MoveXY, void, Move(int x, int y));
74 void Move(const wxPoint& pt);
75 %Rename(SetSizeWH, void, SetSize(int width, int height));
76 void SetSize(const wxSize& size);
77 void Show(int show = true);
78 void Hide();
79
80 %pythoncode { def __nonzero__(self): return self.IsOk() }
81
82 static int GetBlinkTime();
83 static void SetBlinkTime(int milliseconds);
84 };
85
86
87 //---------------------------------------------------------------------------
88
89 MustHaveApp(wxBusyCursor);
90
91 class wxBusyCursor {
92 public:
93 wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR);
94 ~wxBusyCursor();
95 };
96
97 //---------------------------------------------------------------------------
98
99 MustHaveApp(wxWindowDisabler);
100
101 class wxWindowDisabler {
102 public:
103 wxWindowDisabler(wxWindow *winToSkip = NULL);
104 ~wxWindowDisabler();
105 };
106
107 //---------------------------------------------------------------------------
108
109 MustHaveApp(wxBusyInfo);
110
111 class wxBusyInfo : public wxObject {
112 public:
113 wxBusyInfo(const wxString& message);
114 ~wxBusyInfo();
115 };
116
117
118 //---------------------------------------------------------------------------
119
120
121 // wxStopWatch: measure time intervals with up to 1ms resolution
122 class wxStopWatch
123 {
124 public:
125 // ctor starts the stop watch
126 wxStopWatch();
127
128 // start the stop watch at the moment t0
129 void Start(long t0 = 0);
130
131 // pause the stop watch
132 void Pause();
133
134 // resume it
135 void Resume();
136
137 // get elapsed time since the last Start() in milliseconds
138 long Time() const;
139 };
140
141
142
143 //---------------------------------------------------------------------------
144
145 class wxFileHistory : public wxObject
146 {
147 public:
148 wxFileHistory(int maxFiles = 9, wxWindowID idBase = wxID_FILE1);
149 ~wxFileHistory();
150
151 // Operations
152 void AddFileToHistory(const wxString& file);
153 void RemoveFileFromHistory(int i);
154 int GetMaxFiles() const;
155 void UseMenu(wxMenu *menu);
156
157 // Remove menu from the list (MDI child may be closing)
158 void RemoveMenu(wxMenu *menu);
159
160 void Load(wxConfigBase& config);
161 void Save(wxConfigBase& config);
162
163 void AddFilesToMenu();
164 %Rename(AddFilesToThisMenu, void, AddFilesToMenu(wxMenu* menu));
165
166 // Accessors
167 wxString GetHistoryFile(int i) const;
168
169 int GetCount() const;
170 %pythoncode { GetNoHistoryFiles = GetCount }
171
172 };
173
174
175 //---------------------------------------------------------------------------
176
177 %{
178 #include <wx/snglinst.h>
179 %}
180
181 class wxSingleInstanceChecker
182 {
183 public:
184 // like Create() but no error checking (dangerous!)
185 wxSingleInstanceChecker(const wxString& name,
186 const wxString& path = wxPyEmptyString);
187
188 // default ctor, use Create() after it
189 %RenameCtor(PreSingleInstanceChecker, wxSingleInstanceChecker());
190
191 ~wxSingleInstanceChecker();
192
193
194 // name must be given and be as unique as possible, it is used as the mutex
195 // name under Win32 and the lock file name under Unix -
196 // wxTheApp->GetAppName() may be a good value for this parameter
197 //
198 // path is optional and is ignored under Win32 and used as the directory to
199 // create the lock file in under Unix (default is wxGetHomeDir())
200 //
201 // returns False if initialization failed, it doesn't mean that another
202 // instance is running - use IsAnotherRunning() to check it
203 bool Create(const wxString& name, const wxString& path = wxPyEmptyString);
204
205 // is another copy of this program already running?
206 bool IsAnotherRunning() const;
207 };
208
209 //---------------------------------------------------------------------------
210 // Experimental...
211
212 #if 0
213
214 %{
215 #ifdef __WXMSW__
216 #include <wx/msw/private.h>
217 #include <wx/dynload.h>
218 #endif
219 %}
220
221
222 %inline %{
223
224 void wxDrawWindowOnDC(wxWindow* window, const wxDC& dc, int method)
225 {
226 #ifdef __WXMSW__
227
228 switch (method)
229 {
230 case 1:
231 // This one only partially works. Appears to be an undocumented
232 // "standard" convention that not all widgets adhear to. For
233 // example, for some widgets backgrounds or non-client areas may
234 // not be painted.
235 ::SendMessage(GetHwndOf(window), WM_PAINT, (long)GetHdcOf(dc), 0);
236 break;
237
238 case 2:
239 // This one works much better, except for on XP. On Win2k nearly
240 // all widgets and their children are captured correctly[**]. On
241 // XP with Themes activated most native widgets draw only
242 // partially, if at all. Without themes it works just like on
243 // Win2k.
244 //
245 // ** For example the radio buttons in a wxRadioBox are not its
246 // children by default, but you can capture it via the panel
247 // instead, or change RADIOBTN_PARENT_IS_RADIOBOX in radiobox.cpp.
248 ::SendMessage(GetHwndOf(window), WM_PRINT, (long)GetHdcOf(dc),
249 PRF_CLIENT | PRF_NONCLIENT | PRF_CHILDREN |
250 PRF_ERASEBKGND | PRF_OWNED );
251 break;
252
253 case 3:
254 // This one is only defined in the latest SDK and is only
255 // available on XP. MSDN says it is similar to sending WM_PRINT
256 // so I expect that it will work similar to the above. Since it
257 // is avaialble only on XP, it can't be compiled like this and
258 // will have to be loaded dynamically.
259 // //::PrintWindow(GetHwndOf(window), GetHdcOf(dc), 0); //break;
260
261 // fall through
262
263 case 4:
264 // Use PrintWindow if available, or fallback to WM_PRINT
265 // otherwise. Unfortunately using PrintWindow is even worse than
266 // WM_PRINT. For most native widgets nothing is drawn to the dc
267 // at all, with or without Themes.
268 typedef BOOL (WINAPI *PrintWindow_t)(HWND, HDC, UINT);
269 static bool s_triedToLoad = false;
270 static PrintWindow_t pfnPrintWindow = NULL;
271 if ( !s_triedToLoad )
272 {
273
274 s_triedToLoad = true;
275 wxDynamicLibrary dllUser32(_T("user32.dll"));
276 if ( dllUser32.IsLoaded() )
277 {
278 wxLogNull nolog; // Don't report errors here
279 pfnPrintWindow = (PrintWindow_t)dllUser32.GetSymbol(_T("PrintWindow"));
280 }
281 }
282 if (pfnPrintWindow)
283 {
284 //printf("Using PrintWindow\n");
285 pfnPrintWindow(GetHwndOf(window), GetHdcOf(dc), 0);
286 }
287 else
288 {
289 //printf("Using WM_PRINT\n");
290 ::SendMessage(GetHwndOf(window), WM_PRINT, (long)GetHdcOf(dc),
291 PRF_CLIENT | PRF_NONCLIENT | PRF_CHILDREN |
292 PRF_ERASEBKGND | PRF_OWNED );
293 }
294 }
295 #endif
296 }
297
298 %}
299
300 #endif
301
302 //---------------------------------------------------------------------------
303 //---------------------------------------------------------------------------