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
 258 // Miscellaneous functions
 259
 260 MustHaveApp(wxBeginBusyCursor);
 261 void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
 262
 263 MustHaveApp(wxGetActiveWindow);
 264 wxWindow * wxGetActiveWindow();
 265
 266 MustHaveApp(wxGenericFindWindowAtPoint);
 267 wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
 268
 269 MustHaveApp(wxFindWindowAtPoint);
 270 wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
 271
 272 MustHaveApp(wxGetTopLevelParent);
 273 wxWindow* wxGetTopLevelParent(wxWindow *win);
 274
 275
 276 DocDeclStr(
 277     bool , wxLaunchDefaultBrowser(const wxString& url),
 278     "Launches the user's default browser and tells it to open the location
 279 at ``url``.  Returns ``True`` if the application was successfully
 280 launched.", "");
 281
 282
 283
 284 MustHaveApp(wxGetKeyState);
 285 DocDeclStr(
 286     bool , wxGetKeyState(wxKeyCode key),
 287     "Get the state of a key (true if pressed or toggled on, false if not.)
 288 This is generally most useful getting the state of the modifier or
 289 toggle keys.  On some platforms those may be the only keys that work.
 290 ", "");
 291
 292
 293
 294 //---------------------------------------------------------------------------
 295
 296 MustHaveApp(wxWakeUpMainThread);
 297
 298 #if defined(__WXMSW__) || defined(__WXMAC__)
 299 void wxWakeUpMainThread();
 300 #else
 301 %inline %{
 302     void wxWakeUpMainThread() {}
 303 %}
 304 #endif
 305
 306
 307 MustHaveApp(wxMutexGuiEnter);
 308 void wxMutexGuiEnter();
 309
 310 MustHaveApp(wxMutexGuiLeave);
 311 void wxMutexGuiLeave();
 312
 313
 314 MustHaveApp(wxMutexGuiLocker);
 315 class wxMutexGuiLocker  {
 316 public:
 317     wxMutexGuiLocker();
 318     ~wxMutexGuiLocker();
 319 };
 320
 321
 322 MustHaveApp(wxThread);
 323 %inline %{
 324     bool wxThread_IsMain() {
 325 #ifdef WXP_WITH_THREAD
 326         return wxThread::IsMain();
 327 #else
 328         return true;
 329 #endif
 330     }
 331 %}
 332
 333 //---------------------------------------------------------------------------
 334
 335 // enum wxPowerType
 336 // {
 337 //     wxPOWER_SOCKET,
 338 //     wxPOWER_BATTERY,
 339 //     wxPOWER_UNKNOWN
 340 // };
 341
 342 // DocDeclStr(
 343 //     wxPowerType , wxGetPowerType(),
 344 //     "Returns the type of power source as one of wx.POWER_SOCKET,
 345 // wx.POWER_BATTERY or wx.POWER_UNKNOWN.  wx.POWER_UNKNOWN is also the
 346 // default on platforms where this feature is not implemented.", "");
 347
 348
 349 // enum wxBatteryState
 350 // {
 351 //     wxBATTERY_NORMAL_STATE,    // system is fully usable
 352 //     wxBATTERY_LOW_STATE,       // start to worry
 353 //     wxBATTERY_CRITICAL_STATE,  // save quickly
 354 //     wxBATTERY_SHUTDOWN_STATE,  // too late
 355 //     wxBATTERY_UNKNOWN_STATE
 356 // };
 357
 358 // DocDeclStr(
 359 //     wxBatteryState , wxGetBatteryState(),
 360 //     "Returns battery state as one of wx.BATTERY_NORMAL_STATE,
 361 // wx.BATTERY_LOW_STATE}, wx.BATTERY_CRITICAL_STATE,
 362 // wx.BATTERY_SHUTDOWN_STATE or wx.BATTERY_UNKNOWN_STATE.
 363 // wx.BATTERY_UNKNOWN_STATE is also the default on platforms where this
 364 // feature is not implemented.", "");
 365
 366
 367
 368 //---------------------------------------------------------------------------
 369 //---------------------------------------------------------------------------