wxPython/src/_functions.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _functions.i
   3 // Purpose:     SWIG interface defs for various functions and such
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     3-July-1997
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 %{
  17 #include <wx/stockitem.h>
  18 %}
  19
  20 //---------------------------------------------------------------------------
  21
  22 MAKE_CONST_WXSTRING(FileSelectorPromptStr);
  23 MAKE_CONST_WXSTRING(FileSelectorDefaultWildcardStr);
  24 MAKE_CONST_WXSTRING(DirSelectorPromptStr);
  25
  26 //---------------------------------------------------------------------------
  27 %newgroup;
  28
  29
  30 long wxNewId();
  31 void wxRegisterId(long id);
  32 long wxGetCurrentId();
  33
  34 MustHaveApp(wxBell);
  35 void wxBell();
  36
  37 MustHaveApp(wxEndBusyCursor);
  38 void wxEndBusyCursor();
  39
  40 long wxGetElapsedTime(bool resetTimer = True);
  41
  42 MustHaveApp(wxGetMousePosition);
  43 DocDeclA(
  44     void, wxGetMousePosition(int* OUTPUT, int* OUTPUT),
  45     "GetMousePosition() -> (x,y)");
  46
  47 bool wxIsBusy();
  48 wxString wxNow();
  49 bool wxShell(const wxString& command = wxPyEmptyString);
  50 void wxStartTimer();
  51
  52 DocDeclA(
  53     int, wxGetOsVersion(int *OUTPUT, int *OUTPUT),
  54     "GetOsVersion() -> (platform, major, minor)");
  55
  56 wxString wxGetOsDescription();
  57
  58 // TODO:
  59 // // Parses the wildCard, returning the number of filters.
  60 // // Returns 0 if none or if there's a problem,
  61 // // The arrays will contain an equal number of items found before the error.
  62 // // wildCard is in the form:
  63 // // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
  64 // int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters);
  65
  66 #if defined(__WXMSW__) || defined(__WXMAC__)
  67 long wxGetFreeMemory();
  68 #else
  69 %inline %{
  70     long wxGetFreeMemory()
  71         { wxPyRaiseNotImplemented(); return 0; }
  72 %}
  73 #endif
  74
  75 enum wxShutdownFlags
  76 {
  77     wxSHUTDOWN_POWEROFF,    // power off the computer
  78     wxSHUTDOWN_REBOOT       // shutdown and reboot
  79 };
  80
  81 // Shutdown or reboot the PC
  82 MustHaveApp(wxShutdown);
  83 bool wxShutdown(wxShutdownFlags wFlags);
  84
  85
  86 void wxSleep(int secs);
  87 void wxMilliSleep(unsigned long milliseconds);
  88 void wxMicroSleep(unsigned long microseconds);
  89 %pythoncode { Usleep = MilliSleep }
  90
  91 void wxEnableTopLevelWindows(bool enable);
  92
  93 wxString wxStripMenuCodes(const wxString& in);
  94
  95
  96 wxString wxGetEmailAddress();
  97 wxString wxGetHostName();
  98 wxString wxGetFullHostName();
  99 wxString wxGetUserId();
 100 wxString wxGetUserName();
 101 wxString wxGetHomeDir();
 102 wxString wxGetUserHome(const wxString& user = wxPyEmptyString);
 103
 104 unsigned long wxGetProcessId();
 105
 106 void wxTrap();
 107
 108
 109 // Dialog Functions
 110
 111 MustHaveApp(wxFileSelector);
 112 wxString wxFileSelector(const wxString& message = wxPyFileSelectorPromptStr,
 113                         const wxString& default_path = wxPyEmptyString,
 114                         const wxString& default_filename = wxPyEmptyString,
 115                         const wxString& default_extension = wxPyEmptyString,
 116                         const wxString& wildcard = wxPyFileSelectorDefaultWildcardStr,
 117                         int flags = 0,
 118                         wxWindow *parent = NULL,
 119                         int x = -1, int y = -1);
 120
 121 // TODO: wxFileSelectorEx
 122
 123
 124 // Ask for filename to load
 125 MustHaveApp(wxLoadFileSelector);
 126 wxString wxLoadFileSelector(const wxString& what,
 127                             const wxString& extension,
 128                             const wxString& default_name = wxPyEmptyString,
 129                             wxWindow *parent = NULL);
 130
 131 // Ask for filename to save
 132 MustHaveApp(wxSaveFileSelector);
 133 wxString wxSaveFileSelector(const wxString& what,
 134                             const wxString& extension,
 135                             const wxString& default_name = wxPyEmptyString,
 136                             wxWindow *parent = NULL);
 137
 138
 139 MustHaveApp(wxDirSelector);
 140 wxString wxDirSelector(const wxString& message = wxPyDirSelectorPromptStr,
 141                        const wxString& defaultPath = wxPyEmptyString,
 142                        long style = wxDD_DEFAULT_STYLE,
 143                        const wxPoint& pos = wxDefaultPosition,
 144                        wxWindow *parent = NULL);
 145
 146 MustHaveApp(wxGetTextFromUser);
 147 wxString wxGetTextFromUser(const wxString& message,
 148                            const wxString& caption = wxPyEmptyString,
 149                            const wxString& default_value = wxPyEmptyString,
 150                            wxWindow *parent = NULL,
 151                            int x = -1, int y = -1,
 152                            bool centre = True);
 153
 154 MustHaveApp(wxGetPasswordFromUser);
 155 wxString wxGetPasswordFromUser(const wxString& message,
 156                                const wxString& caption = wxPyEmptyString,
 157                                const wxString& default_value = wxPyEmptyString,
 158                                wxWindow *parent = NULL);
 159
 160
 161 // TODO: Need to custom wrap this one...
 162 // int wxGetMultipleChoice(char* message, char* caption,
 163 //                         int LCOUNT, char** choices,
 164 //                         int nsel, int *selection,
 165 //                         wxWindow *parent = NULL, int x = -1, int y = -1,
 166 //                         bool centre = True, int width=150, int height=200);
 167
 168
 169 MustHaveApp(wxGetSingleChoice);
 170 wxString wxGetSingleChoice(const wxString& message, const wxString& caption,
 171                            int choices, wxString* choices_array,
 172                            wxWindow *parent = NULL,
 173                            int x = -1, int y = -1,
 174                            bool centre = True,
 175                            int width=150, int height=200);
 176
 177 MustHaveApp(wxGetSingleChoiceIndex);
 178 int wxGetSingleChoiceIndex(const wxString& message, const wxString& caption,
 179                            int choices, wxString* choices_array,
 180                            wxWindow *parent = NULL,
 181                            int x = -1, int y = -1,
 182                            bool centre = True,
 183                            int width=150, int height=200);
 184
 185
 186 MustHaveApp(wxMessageBox);
 187 int wxMessageBox(const wxString& message,
 188                  const wxString& caption = wxPyEmptyString,
 189                  int style = wxOK | wxCENTRE,
 190                  wxWindow *parent = NULL,
 191                  int x = -1, int y = -1);
 192
 193 MustHaveApp(wxGetNumberFromUser);
 194 long wxGetNumberFromUser(const wxString& message,
 195                          const wxString& prompt,
 196                          const wxString& caption,
 197                          long value,
 198                          long min = 0, long max = 100,
 199                          wxWindow *parent = NULL,
 200                          const wxPoint& pos = wxDefaultPosition);
 201
 202 // GDI Functions
 203
 204 MustHaveApp(wxColourDisplay);
 205 bool wxColourDisplay();
 206
 207 MustHaveApp(wxDisplayDepth);
 208 int wxDisplayDepth();
 209
 210 MustHaveApp(wxGetDisplayDepth);
 211 int wxGetDisplayDepth();
 212
 213 MustHaveApp(wxDisplaySize);
 214 DocDeclA(
 215     void, wxDisplaySize(int* OUTPUT, int* OUTPUT),
 216     "DisplaySize() -> (width, height)");
 217
 218 MustHaveApp(wxGetDisplaySize);
 219 wxSize wxGetDisplaySize();
 220
 221 MustHaveApp(wxDisplaySizeMM);
 222 DocDeclA(
 223     void, wxDisplaySizeMM(int* OUTPUT, int* OUTPUT),
 224     "DisplaySizeMM() -> (width, height)");
 225
 226 MustHaveApp(wxGetDisplaySizeMM);
 227 wxSize wxGetDisplaySizeMM();
 228
 229 MustHaveApp(wxClientDisplayRect);
 230 DocDeclA(
 231     void, wxClientDisplayRect(int *OUTPUT, int *OUTPUT, int *OUTPUT, int *OUTPUT),
 232     "ClientDisplayRect() -> (x, y, width, height)");
 233
 234 MustHaveApp(wxGetClientDisplayRect);
 235 wxRect wxGetClientDisplayRect();
 236
 237
 238 MustHaveApp(wxSetCursor);
 239 void wxSetCursor(wxCursor& cursor);
 240
 241
 242
 243 // Miscellaneous functions
 244
 245 MustHaveApp(wxBeginBusyCursor);
 246 void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
 247
 248 MustHaveApp(wxGetActiveWindow);
 249 wxWindow * wxGetActiveWindow();
 250
 251 MustHaveApp(wxGenericFindWindowAtPoint);
 252 wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
 253
 254 MustHaveApp(wxFindWindowAtPoint);
 255 wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
 256
 257 MustHaveApp(wxGetTopLevelParent);
 258 wxWindow* wxGetTopLevelParent(wxWindow *win);
 259
 260 //bool wxSpawnBrowser(wxWindow *parent, wxString href);
 261
 262
 263
 264
 265 MustHaveApp(wxGetKeyState);
 266 DocDeclStr(
 267     bool , wxGetKeyState(wxKeyCode key),
 268     "Get the state of a key (true if pressed or toggled on, false if not.)
 269 This is generally most useful getting the state of the modifier or
 270 toggle keys.  On some platforms those may be the only keys that work.
 271 ", "");
 272
 273
 274
 275 //---------------------------------------------------------------------------
 276
 277 MustHaveApp(wxWakeUpMainThread);
 278
 279 #if defined(__WXMSW__) || defined(__WXMAC__)
 280 void wxWakeUpMainThread();
 281 #else
 282 %inline %{
 283     void wxWakeUpMainThread() {}
 284 %}
 285 #endif
 286
 287
 288 MustHaveApp(wxMutexGuiEnter);
 289 void wxMutexGuiEnter();
 290
 291 MustHaveApp(wxMutexGuiLeave);
 292 void wxMutexGuiLeave();
 293
 294
 295 MustHaveApp(wxMutexGuiLocker);
 296 class wxMutexGuiLocker  {
 297 public:
 298     wxMutexGuiLocker();
 299     ~wxMutexGuiLocker();
 300 };
 301
 302
 303 MustHaveApp(wxThread);
 304 %inline %{
 305     bool wxThread_IsMain() {
 306 #ifdef WXP_WITH_THREAD
 307         return wxThread::IsMain();
 308 #else
 309         return True;
 310 #endif
 311     }
 312 %}
 313
 314 //---------------------------------------------------------------------------
 315 //---------------------------------------------------------------------------