+ Find the display where the given window lies, return wx.NOT_FOUND if
+ it is not shown at all.
+ """
+ return _misc_.Display_GetFromWindow(*args, **kwargs)
+
+#---------------------------------------------------------------------------
+
+class StandardPaths(object):
+ """
+ wx.StandardPaths returns standard locations in the file system and
+ should be used by programs to find their data files in a portable way.
+
+ In the description of the methods below, the example return values are
+ given for the Unix, Windows and Mac OS X systems, however please note
+ that these are just examples and the actual values may differ. For
+ example, under Windows the system administrator may change the
+ standard directories locations, i.e. the Windows directory may be
+ named W:\Win2003 instead of the default C:\Windows.
+
+ The strings appname and username should be replaced with the value
+ returned by `wx.App.GetAppName` and the name of the currently logged
+ in user, respectively. The string prefix is only used under Unix and
+ is /usr/local by default but may be changed using `SetInstallPrefix`.
+
+ The directories returned by the methods of this class may or may not
+ exist. If they don't exist, it's up to the caller to create them,
+ wx.StandardPaths doesn't do it.
+
+ Finally note that these functions only work with standardly packaged
+ applications. I.e. under Unix you should follow the standard
+ installation conventions and under Mac you should create your
+ application bundle according to the Apple guidelines. Again, this
+ class doesn't help you to do it.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ def __init__(self): raise AttributeError, "No constructor defined"
+ __repr__ = _swig_repr
+ ResourceCat_None = _misc_.StandardPaths_ResourceCat_None
+ ResourceCat_Messages = _misc_.StandardPaths_ResourceCat_Messages
+ ResourceCat_Max = _misc_.StandardPaths_ResourceCat_Max
+ def Get(*args, **kwargs):
+ """
+ Get() -> StandardPaths
+
+ Return the global standard paths singleton
+ """
+ return _misc_.StandardPaths_Get(*args, **kwargs)
+
+ Get = staticmethod(Get)
+ def GetConfigDir(*args, **kwargs):
+ """
+ GetConfigDir(self) -> String
+
+ Return the directory with system config files: /etc under Unix,
+ 'c:\Documents and Settings\All Users\Application Data' under Windows,
+ /Library/Preferences for Mac
+ """
+ return _misc_.StandardPaths_GetConfigDir(*args, **kwargs)
+
+ def GetUserConfigDir(*args, **kwargs):
+ """
+ GetUserConfigDir(self) -> String
+
+ Return the directory for the user config files: $HOME under Unix,
+ 'c:\Documents and Settings\username' under Windows, and
+ ~/Library/Preferences under Mac
+
+ Only use this if you have a single file to put there, otherwise
+ `GetUserDataDir` is more appropriate
+ """
+ return _misc_.StandardPaths_GetUserConfigDir(*args, **kwargs)
+
+ def GetDataDir(*args, **kwargs):
+ """
+ GetDataDir(self) -> String
+
+ Return the location of the application's global, (i.e. not
+ user-specific,) data files: prefix/share/appname under Unix,
+ 'c:\Program Files\appname' under Windows,
+ appname.app/Contents/SharedSupport app bundle directory under Mac.
+ """
+ return _misc_.StandardPaths_GetDataDir(*args, **kwargs)
+
+ def GetLocalDataDir(*args, **kwargs):
+ """
+ GetLocalDataDir(self) -> String
+
+ Return the location for application data files which are
+ host-specific. Same as `GetDataDir` except under Unix where it is
+ /etc/appname
+ """
+ return _misc_.StandardPaths_GetLocalDataDir(*args, **kwargs)
+
+ def GetUserDataDir(*args, **kwargs):
+ """
+ GetUserDataDir(self) -> String
+
+ Return the directory for the user-dependent application data files:
+ $HOME/.appname under Unix, c:\Documents and
+ Settings\username\Application Data\appname under Windows and
+ ~/Library/Application Support/appname under Mac
+ """
+ return _misc_.StandardPaths_GetUserDataDir(*args, **kwargs)
+
+ def GetUserLocalDataDir(*args, **kwargs):
+ """
+ GetUserLocalDataDir(self) -> String
+
+ Return the directory for user data files which shouldn't be shared
+ with the other machines
+
+ Same as `GetUserDataDir` for all platforms except Windows where it is
+ the 'Local Settings\Application Data\appname' directory.
+ """
+ return _misc_.StandardPaths_GetUserLocalDataDir(*args, **kwargs)
+
+ def GetPluginsDir(*args, **kwargs):
+ """
+ GetPluginsDir(self) -> String
+
+ Return the directory where the loadable modules (plugins) live:
+ prefix/lib/appname under Unix, program directory under Windows and
+ Contents/Plugins app bundle subdirectory under Mac
+ """
+ return _misc_.StandardPaths_GetPluginsDir(*args, **kwargs)
+
+ def GetResourcesDir(*args, **kwargs):
+ """
+ GetResourcesDir(self) -> String
+
+ Get resources directory. Resources are auxiliary files used by the
+ application and include things like image and sound files.
+
+ Same as `GetDataDir` for all platforms except Mac where it returns
+ Contents/Resources subdirectory of the app bundle.
+ """
+ return _misc_.StandardPaths_GetResourcesDir(*args, **kwargs)
+
+ def GetLocalizedResourcesDir(*args, **kwargs):
+ """
+ GetLocalizedResourcesDir(self, String lang, int category=ResourceCat_None) -> String
+
+ Get localized resources directory containing the resource files of the
+ specified category for the given language.
+
+ In general this is just GetResourcesDir()/lang under Windows and Unix
+ and GetResourcesDir()/lang.lproj under Mac but is something quite
+ different under Unix for the message catalog category (namely the
+ standard prefix/share/locale/lang/LC_MESSAGES.)
+ """
+ return _misc_.StandardPaths_GetLocalizedResourcesDir(*args, **kwargs)
+
+ def GetDocumentsDir(*args, **kwargs):
+ """
+ GetDocumentsDir(self) -> String
+
+ Return the Documents directory for the current user.
+
+ C:\Documents and Settings\username\Documents under Windows,
+ $HOME under Unix and ~/Documents under Mac
+ """
+ return _misc_.StandardPaths_GetDocumentsDir(*args, **kwargs)
+
+ def SetInstallPrefix(*args, **kwargs):
+ """
+ SetInstallPrefix(self, String prefix)
+
+ Set the program installation directory which is /usr/local by default.
+ This value will be used by other methods such as `GetDataDir` and
+ `GetPluginsDir` as the prefix for what they return. (This function
+ only has meaning on Unix systems.)
+ """
+ return _misc_.StandardPaths_SetInstallPrefix(*args, **kwargs)
+
+ def GetInstallPrefix(*args, **kwargs):
+ """
+ GetInstallPrefix(self) -> String
+
+ Get the program installation prefix. The default is the prefix where
+ Python is installed. (This function only has meaning on Unix systems.)
+ """
+ return _misc_.StandardPaths_GetInstallPrefix(*args, **kwargs)
+
+_misc_.StandardPaths_swigregister(StandardPaths)
+
+def StandardPaths_Get(*args):
+ """
+ StandardPaths_Get() -> StandardPaths
+
+ Return the global standard paths singleton
+ """
+ return _misc_.StandardPaths_Get(*args)
+
+#---------------------------------------------------------------------------
+
+POWER_SOCKET = _misc_.POWER_SOCKET
+POWER_BATTERY = _misc_.POWER_BATTERY
+POWER_UNKNOWN = _misc_.POWER_UNKNOWN
+BATTERY_NORMAL_STATE = _misc_.BATTERY_NORMAL_STATE
+BATTERY_LOW_STATE = _misc_.BATTERY_LOW_STATE
+BATTERY_CRITICAL_STATE = _misc_.BATTERY_CRITICAL_STATE
+BATTERY_SHUTDOWN_STATE = _misc_.BATTERY_SHUTDOWN_STATE
+BATTERY_UNKNOWN_STATE = _misc_.BATTERY_UNKNOWN_STATE
+class PowerEvent(_core.Event):
+ """
+ wx.PowerEvent is generated when the system online status changes.
+ Currently this is only implemented for Windows.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, EventType evtType) -> PowerEvent
+
+ wx.PowerEvent is generated when the system online status changes.
+ Currently this is only implemented for Windows.
+ """
+ _misc_.PowerEvent_swiginit(self,_misc_.new_PowerEvent(*args, **kwargs))
+ def Veto(*args, **kwargs):
+ """Veto(self)"""
+ return _misc_.PowerEvent_Veto(*args, **kwargs)
+
+ def IsVetoed(*args, **kwargs):
+ """IsVetoed(self) -> bool"""
+ return _misc_.PowerEvent_IsVetoed(*args, **kwargs)
+
+_misc_.PowerEvent_swigregister(PowerEvent)
+
+wxEVT_POWER_SUSPENDING = _misc_.wxEVT_POWER_SUSPENDING
+wxEVT_POWER_SUSPENDED = _misc_.wxEVT_POWER_SUSPENDED
+wxEVT_POWER_SUSPEND_CANCEL = _misc_.wxEVT_POWER_SUSPEND_CANCEL
+wxEVT_POWER_RESUME = _misc_.wxEVT_POWER_RESUME
+EVT_POWER_SUSPENDING = wx.PyEventBinder( wxEVT_POWER_SUSPENDING , 1 )
+EVT_POWER_SUSPENDED = wx.PyEventBinder( wxEVT_POWER_SUSPENDED , 1 )
+EVT_POWER_SUSPEND_CANCEL = wx.PyEventBinder( wxEVT_POWER_SUSPEND_CANCEL , 1 )
+EVT_POWER_RESUME = wx.PyEventBinder( wxEVT_POWER_RESUME , 1 )
+
+
+def GetPowerType(*args):
+ """
+ GetPowerType() -> int
+
+ return the current system power state: online or offline
+ """
+ return _misc_.GetPowerType(*args)
+
+def GetBatteryState(*args):
+ """
+ GetBatteryState() -> int
+
+ return approximate battery state