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 // Returns true if the ID is in the list of recognized stock actions
  35 bool wxIsStockID(wxWindowID id);
  36
  37 // Returns true of the label is empty or label of a stock button with
  38 // given ID
  39 bool wxIsStockLabel(wxWindowID id, const wxString& label);
  40
  41 // Returns label that should be used for given stock UI element (e.g. "&OK"
  42 // for wxID_OK):
  43 wxString wxGetStockLabel(wxWindowID id,
  44                          bool withCodes = true,
  45                          wxString accelerator = wxPyEmptyString);
  46
  47
  48 MustHaveApp(wxBell);
  49 void wxBell();
  50
  51 MustHaveApp(wxEndBusyCursor);
  52 void wxEndBusyCursor();
  53
  54 long wxGetElapsedTime(bool resetTimer = true);
  55
  56 MustHaveApp(wxGetMousePosition);
  57 DocDeclA(
  58     void, wxGetMousePosition(int* OUTPUT, int* OUTPUT),
  59     "GetMousePosition() -> (x,y)");
  60
  61 bool wxIsBusy();
  62 wxString wxNow();
  63 bool wxShell(const wxString& command = wxPyEmptyString);
  64 void wxStartTimer();
  65
  66 DocDeclA(
  67     int, wxGetOsVersion(int *OUTPUT, int *OUTPUT),
  68     "GetOsVersion() -> (platform, major, minor)");
  69
  70 wxString wxGetOsDescription();
  71
  72 // TODO:
  73 // // Parses the wildCard, returning the number of filters.
  74 // // Returns 0 if none or if there's a problem,
  75 // // The arrays will contain an equal number of items found before the error.
  76 // // wildCard is in the form:
  77 // // "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
  78 // int wxParseCommonDialogsFilter(const wxString& wildCard, wxArrayString& descriptions, wxArrayString& filters);
  79
  80 #if defined(__WXMSW__) || defined(__WXMAC__)
  81 long wxGetFreeMemory();
  82 #else
  83 %inline %{
  84     long wxGetFreeMemory()
  85         { wxPyRaiseNotImplemented(); return 0; }
  86 %}
  87 #endif
  88
  89 enum wxShutdownFlags
  90 {
  91     wxSHUTDOWN_POWEROFF,    // power off the computer
  92     wxSHUTDOWN_REBOOT       // shutdown and reboot
  93 };
  94
  95 // Shutdown or reboot the PC
  96 MustHaveApp(wxShutdown);
  97 bool wxShutdown(wxShutdownFlags wFlags);
  98
  99
 100 void wxSleep(int secs);
 101 void wxMilliSleep(unsigned long milliseconds);
 102 void wxMicroSleep(unsigned long microseconds);
 103 %pythoncode { Usleep = MilliSleep }
 104
 105 void wxEnableTopLevelWindows(bool enable);
 106
 107 wxString wxStripMenuCodes(const wxString& in);
 108
 109
 110 wxString wxGetEmailAddress();
 111 wxString wxGetHostName();
 112 wxString wxGetFullHostName();
 113 wxString wxGetUserId();
 114 wxString wxGetUserName();
 115 wxString wxGetHomeDir();
 116 wxString wxGetUserHome(const wxString& user = wxPyEmptyString);
 117
 118 unsigned long wxGetProcessId();
 119
 120 void wxTrap();
 121
 122
 123 // Dialog Functions
 124
 125 MustHaveApp(wxFileSelector);
 126 wxString wxFileSelector(const wxString& message = wxPyFileSelectorPromptStr,
 127                         const wxString& default_path = wxPyEmptyString,
 128                         const wxString& default_filename = wxPyEmptyString,
 129                         const wxString& default_extension = wxPyEmptyString,
 130                         const wxString& wildcard = wxPyFileSelectorDefaultWildcardStr,
 131                         int flags = 0,
 132                         wxWindow *parent = NULL,
 133                         int x = -1, int y = -1);
 134
 135 // TODO: wxFileSelectorEx
 136
 137
 138 // Ask for filename to load
 139 MustHaveApp(wxLoadFileSelector);
 140 wxString wxLoadFileSelector(const wxString& what,
 141                             const wxString& extension,
 142                             const wxString& default_name = wxPyEmptyString,
 143                             wxWindow *parent = NULL);
 144
 145 // Ask for filename to save
 146 MustHaveApp(wxSaveFileSelector);
 147 wxString wxSaveFileSelector(const wxString& what,
 148                             const wxString& extension,
 149                             const wxString& default_name = wxPyEmptyString,
 150                             wxWindow *parent = NULL);
 151
 152
 153 MustHaveApp(wxDirSelector);
 154 wxString wxDirSelector(const wxString& message = wxPyDirSelectorPromptStr,
 155                        const wxString& defaultPath = wxPyEmptyString,
 156                        long style = wxDD_DEFAULT_STYLE,
 157                        const wxPoint& pos = wxDefaultPosition,
 158                        wxWindow *parent = NULL);
 159
 160 MustHaveApp(wxGetTextFromUser);
 161 wxString wxGetTextFromUser(const wxString& message,
 162                            const wxString& caption = wxPyEmptyString,
 163                            const wxString& default_value = wxPyEmptyString,
 164                            wxWindow *parent = NULL,
 165                            int x = -1, int y = -1,
 166                            bool centre = true);
 167
 168 MustHaveApp(wxGetPasswordFromUser);
 169 wxString wxGetPasswordFromUser(const wxString& message,
 170                                const wxString& caption = wxPyEmptyString,
 171                                const wxString& default_value = wxPyEmptyString,
 172                                wxWindow *parent = NULL);
 173
 174
 175 // TODO: Need to custom wrap this one...
 176 // int wxGetMultipleChoice(char* message, char* caption,
 177 //                         int LCOUNT, char** choices,
 178 //                         int nsel, int *selection,
 179 //                         wxWindow *parent = NULL, int x = -1, int y = -1,
 180 //                         bool centre = true, int width=150, int height=200);
 181
 182
 183 MustHaveApp(wxGetSingleChoice);
 184 wxString wxGetSingleChoice(const wxString& message, const wxString& caption,
 185                            int choices, wxString* choices_array,
 186                            wxWindow *parent = NULL,
 187                            int x = -1, int y = -1,
 188                            bool centre = true,
 189                            int width=150, int height=200);
 190
 191 MustHaveApp(wxGetSingleChoiceIndex);
 192 int wxGetSingleChoiceIndex(const wxString& message, const wxString& caption,
 193                            int choices, wxString* choices_array,
 194                            wxWindow *parent = NULL,
 195                            int x = -1, int y = -1,
 196                            bool centre = true,
 197                            int width=150, int height=200);
 198
 199
 200 MustHaveApp(wxMessageBox);
 201 int wxMessageBox(const wxString& message,
 202                  const wxString& caption = wxPyEmptyString,
 203                  int style = wxOK | wxCENTRE,
 204                  wxWindow *parent = NULL,
 205                  int x = -1, int y = -1);
 206
 207 // WXWIN_COMPATIBILITY_2_4
 208 MustHaveApp(wxGetNumberFromUser);
 209 long wxGetNumberFromUser(const wxString& message,
 210                          const wxString& prompt,
 211                          const wxString& caption,
 212                          long value,
 213                          long min = 0, long max = 100,
 214                          wxWindow *parent = NULL,
 215                          const wxPoint& pos = wxDefaultPosition);
 216
 217 // GDI Functions
 218
 219 MustHaveApp(wxColourDisplay);
 220 bool wxColourDisplay();
 221
 222 MustHaveApp(wxDisplayDepth);
 223 int wxDisplayDepth();
 224
 225 MustHaveApp(wxGetDisplayDepth);
 226 int wxGetDisplayDepth();
 227
 228 MustHaveApp(wxDisplaySize);
 229 DocDeclA(
 230     void, wxDisplaySize(int* OUTPUT, int* OUTPUT),
 231     "DisplaySize() -> (width, height)");
 232
 233 MustHaveApp(wxGetDisplaySize);
 234 wxSize wxGetDisplaySize();
 235
 236 MustHaveApp(wxDisplaySizeMM);
 237 DocDeclA(
 238     void, wxDisplaySizeMM(int* OUTPUT, int* OUTPUT),
 239     "DisplaySizeMM() -> (width, height)");
 240
 241 MustHaveApp(wxGetDisplaySizeMM);
 242 wxSize wxGetDisplaySizeMM();
 243
 244 MustHaveApp(wxClientDisplayRect);
 245 DocDeclA(
 246     void, wxClientDisplayRect(int *OUTPUT, int *OUTPUT, int *OUTPUT, int *OUTPUT),
 247     "ClientDisplayRect() -> (x, y, width, height)");
 248
 249 MustHaveApp(wxGetClientDisplayRect);
 250 wxRect wxGetClientDisplayRect();
 251
 252
 253 MustHaveApp(wxSetCursor);
 254 void wxSetCursor(wxCursor& cursor);
 255
 256
 257 MustHaveApp(wxGetXDisplay);
 258 DocStr(wxGetXDisplay,
 259 "Returns a swigified pointer to the X11 display.  Returns None on
 260 other platforms.", "");
 261 %inline %{
 262     void* wxGetXDisplay()
 263     {
 264 #ifdef __WXGTK__
 265         return wxGetDisplay();
 266 #else
 267         return NULL;
 268 #endif
 269     }
 270 %}
 271
 272
 273 // Miscellaneous functions
 274
 275 MustHaveApp(wxBeginBusyCursor);
 276 void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
 277
 278 MustHaveApp(wxGetActiveWindow);
 279 wxWindow * wxGetActiveWindow();
 280
 281 MustHaveApp(wxGenericFindWindowAtPoint);
 282 wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
 283
 284 MustHaveApp(wxFindWindowAtPoint);
 285 wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
 286
 287 MustHaveApp(wxGetTopLevelParent);
 288 wxWindow* wxGetTopLevelParent(wxWindow *win);
 289
 290
 291 DocDeclStr(
 292     bool , wxLaunchDefaultBrowser(const wxString& url),
 293     "Launches the user's default browser and tells it to open the location
 294 at ``url``.  Returns ``True`` if the application was successfully
 295 launched.", "");
 296
 297
 298
 299 MustHaveApp(wxGetKeyState);
 300 DocDeclStr(
 301     bool , wxGetKeyState(wxKeyCode key),
 302     "Get the state of a key (true if pressed or toggled on, false if not.)
 303 This is generally most useful getting the state of the modifier or
 304 toggle keys.  On some platforms those may be the only keys that work.
 305 ", "");
 306
 307
 308
 309 //---------------------------------------------------------------------------
 310
 311 MustHaveApp(wxWakeUpMainThread);
 312
 313 #if defined(__WXMSW__) || defined(__WXMAC__)
 314 void wxWakeUpMainThread();
 315 #else
 316 %inline %{
 317     void wxWakeUpMainThread() {}
 318 %}
 319 #endif
 320
 321
 322 MustHaveApp(wxMutexGuiEnter);
 323 void wxMutexGuiEnter();
 324
 325 MustHaveApp(wxMutexGuiLeave);
 326 void wxMutexGuiLeave();
 327
 328
 329 MustHaveApp(wxMutexGuiLocker);
 330 class wxMutexGuiLocker  {
 331 public:
 332     wxMutexGuiLocker();
 333     ~wxMutexGuiLocker();
 334 };
 335
 336
 337 MustHaveApp(wxThread);
 338 %inline %{
 339     bool wxThread_IsMain() {
 340 #ifdef WXP_WITH_THREAD
 341         return wxThread::IsMain();
 342 #else
 343         return true;
 344 #endif
 345     }
 346 %}
 347
 348 //---------------------------------------------------------------------------
 349
 350 // enum wxPowerType
 351 // {
 352 //     wxPOWER_SOCKET,
 353 //     wxPOWER_BATTERY,
 354 //     wxPOWER_UNKNOWN
 355 // };
 356
 357 // DocDeclStr(
 358 //     wxPowerType , wxGetPowerType(),
 359 //     "Returns the type of power source as one of wx.POWER_SOCKET,
 360 // wx.POWER_BATTERY or wx.POWER_UNKNOWN.  wx.POWER_UNKNOWN is also the
 361 // default on platforms where this feature is not implemented.", "");
 362
 363
 364 // enum wxBatteryState
 365 // {
 366 //     wxBATTERY_NORMAL_STATE,    // system is fully usable
 367 //     wxBATTERY_LOW_STATE,       // start to worry
 368 //     wxBATTERY_CRITICAL_STATE,  // save quickly
 369 //     wxBATTERY_SHUTDOWN_STATE,  // too late
 370 //     wxBATTERY_UNKNOWN_STATE
 371 // };
 372
 373 // DocDeclStr(
 374 //     wxBatteryState , wxGetBatteryState(),
 375 //     "Returns battery state as one of wx.BATTERY_NORMAL_STATE,
 376 // wx.BATTERY_LOW_STATE}, wx.BATTERY_CRITICAL_STATE,
 377 // wx.BATTERY_SHUTDOWN_STATE or wx.BATTERY_UNKNOWN_STATE.
 378 // wx.BATTERY_UNKNOWN_STATE is also the default on platforms where this
 379 // feature is not implemented.", "");
 380
 381
 382
 383 //---------------------------------------------------------------------------
 384 //---------------------------------------------------------------------------