import _core
wx = _core
-__docfilter__ = wx.__docfilter__
#---------------------------------------------------------------------------
SYS_OEM_FIXED_FONT = _misc_.SYS_OEM_FIXED_FONT
def __repr__(self):
return "<%s.%s; proxy of C++ wxSystemSettings instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def GetColour(*args, **kwargs):
- """SystemSettings.GetColour(int index) -> Colour"""
+ """GetColour(int index) -> Colour"""
return _misc_.SystemSettings_GetColour(*args, **kwargs)
GetColour = staticmethod(GetColour)
def GetFont(*args, **kwargs):
- """SystemSettings.GetFont(int index) -> Font"""
+ """GetFont(int index) -> Font"""
return _misc_.SystemSettings_GetFont(*args, **kwargs)
GetFont = staticmethod(GetFont)
def GetMetric(*args, **kwargs):
- """SystemSettings.GetMetric(int index) -> int"""
+ """GetMetric(int index) -> int"""
return _misc_.SystemSettings_GetMetric(*args, **kwargs)
GetMetric = staticmethod(GetMetric)
def HasFeature(*args, **kwargs):
- """SystemSettings.HasFeature(int index) -> bool"""
+ """HasFeature(int index) -> bool"""
return _misc_.SystemSettings_HasFeature(*args, **kwargs)
HasFeature = staticmethod(HasFeature)
def GetScreenType(*args, **kwargs):
- """SystemSettings.GetScreenType() -> int"""
+ """GetScreenType() -> int"""
return _misc_.SystemSettings_GetScreenType(*args, **kwargs)
GetScreenType = staticmethod(GetScreenType)
def SetScreenType(*args, **kwargs):
- """SystemSettings.SetScreenType(int screen)"""
+ """SetScreenType(int screen)"""
return _misc_.SystemSettings_SetScreenType(*args, **kwargs)
SetScreenType = staticmethod(SetScreenType)
self.thisown = 1
del newobj.thisown
def SetOption(*args, **kwargs):
- """SystemOptions.SetOption(String name, String value)"""
+ """SetOption(String name, String value)"""
return _misc_.SystemOptions_SetOption(*args, **kwargs)
SetOption = staticmethod(SetOption)
def SetOptionInt(*args, **kwargs):
- """SystemOptions.SetOptionInt(String name, int value)"""
+ """SetOptionInt(String name, int value)"""
return _misc_.SystemOptions_SetOptionInt(*args, **kwargs)
SetOptionInt = staticmethod(SetOptionInt)
def GetOption(*args, **kwargs):
- """SystemOptions.GetOption(String name) -> String"""
+ """GetOption(String name) -> String"""
return _misc_.SystemOptions_GetOption(*args, **kwargs)
GetOption = staticmethod(GetOption)
def GetOptionInt(*args, **kwargs):
- """SystemOptions.GetOptionInt(String name) -> int"""
+ """GetOptionInt(String name) -> int"""
return _misc_.SystemOptions_GetOptionInt(*args, **kwargs)
GetOptionInt = staticmethod(GetOptionInt)
def HasOption(*args, **kwargs):
- """SystemOptions.HasOption(String name) -> bool"""
+ """HasOption(String name) -> bool"""
return _misc_.SystemOptions_HasOption(*args, **kwargs)
HasOption = staticmethod(HasOption)
return _misc_.GetTopLevelParent(*args, **kwargs)
def GetKeyState(*args, **kwargs):
- """GetKeyState(int key) -> bool"""
+ """
+ GetKeyState(int key) -> bool
+
+ Get the state of a key (true if pressed or toggled on, false if not.)
+ This is generally most useful getting the state of the modifier or
+ toggle keys. On some platforms those may be the only keys that work.
+
+ """
return _misc_.GetKeyState(*args, **kwargs)
def WakeUpMainThread(*args, **kwargs):
return _misc_.ToolTip_GetWindow(*args, **kwargs)
def Enable(*args, **kwargs):
- """ToolTip.Enable(bool flag)"""
+ """Enable(bool flag)"""
return _misc_.ToolTip_Enable(*args, **kwargs)
Enable = staticmethod(Enable)
def SetDelay(*args, **kwargs):
- """ToolTip.SetDelay(long milliseconds)"""
+ """SetDelay(long milliseconds)"""
return _misc_.ToolTip_SetDelay(*args, **kwargs)
SetDelay = staticmethod(SetDelay)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
+ self._setCallbackInfo(self, PyTipProvider)
+
def _setCallbackInfo(*args, **kwargs):
"""_setCallbackInfo(self, PyObject self, PyObject _class)"""
return _misc_.PyTipProvider__setCallbackInfo(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
- self._setCallbackInfo(self, Timer, 0)
+ self._setCallbackInfo(self, Timer, 0); self._setOORInfo(self)
def __del__(self, destroy=_misc_.delete_Timer):
"""__del__(self)"""
"""SetOwner(self, EvtHandler owner, int id=-1)"""
return _misc_.Timer_SetOwner(*args, **kwargs)
+ def GetOwner(*args, **kwargs):
+ """GetOwner(self) -> EvtHandler"""
+ return _misc_.Timer_GetOwner(*args, **kwargs)
+
def Start(*args, **kwargs):
"""Start(self, int milliseconds=-1, bool oneShot=False) -> bool"""
return _misc_.Timer_Start(*args, **kwargs)
self.thisown = 1
del newobj.thisown
def IsEnabled(*args, **kwargs):
- """Log.IsEnabled() -> bool"""
+ """IsEnabled() -> bool"""
return _misc_.Log_IsEnabled(*args, **kwargs)
IsEnabled = staticmethod(IsEnabled)
def EnableLogging(*args, **kwargs):
- """Log.EnableLogging(bool doIt=True) -> bool"""
+ """EnableLogging(bool doIt=True) -> bool"""
return _misc_.Log_EnableLogging(*args, **kwargs)
EnableLogging = staticmethod(EnableLogging)
def OnLog(*args, **kwargs):
- """Log.OnLog(wxLogLevel level, wxChar szString, time_t t)"""
+ """OnLog(wxLogLevel level, wxChar szString, time_t t)"""
return _misc_.Log_OnLog(*args, **kwargs)
OnLog = staticmethod(OnLog)
return _misc_.Log_Flush(*args, **kwargs)
def FlushActive(*args, **kwargs):
- """Log.FlushActive()"""
+ """FlushActive()"""
return _misc_.Log_FlushActive(*args, **kwargs)
FlushActive = staticmethod(FlushActive)
def GetActiveTarget(*args, **kwargs):
- """Log.GetActiveTarget() -> Log"""
+ """GetActiveTarget() -> Log"""
return _misc_.Log_GetActiveTarget(*args, **kwargs)
GetActiveTarget = staticmethod(GetActiveTarget)
def SetActiveTarget(*args, **kwargs):
- """Log.SetActiveTarget(Log pLogger) -> Log"""
+ """SetActiveTarget(Log pLogger) -> Log"""
return _misc_.Log_SetActiveTarget(*args, **kwargs)
SetActiveTarget = staticmethod(SetActiveTarget)
def Suspend(*args, **kwargs):
- """Log.Suspend()"""
+ """Suspend()"""
return _misc_.Log_Suspend(*args, **kwargs)
Suspend = staticmethod(Suspend)
def Resume(*args, **kwargs):
- """Log.Resume()"""
+ """Resume()"""
return _misc_.Log_Resume(*args, **kwargs)
Resume = staticmethod(Resume)
def SetVerbose(*args, **kwargs):
- """Log.SetVerbose(bool bVerbose=True)"""
+ """SetVerbose(bool bVerbose=True)"""
return _misc_.Log_SetVerbose(*args, **kwargs)
SetVerbose = staticmethod(SetVerbose)
def SetLogLevel(*args, **kwargs):
- """Log.SetLogLevel(wxLogLevel logLevel)"""
+ """SetLogLevel(wxLogLevel logLevel)"""
return _misc_.Log_SetLogLevel(*args, **kwargs)
SetLogLevel = staticmethod(SetLogLevel)
def DontCreateOnDemand(*args, **kwargs):
- """Log.DontCreateOnDemand()"""
+ """DontCreateOnDemand()"""
return _misc_.Log_DontCreateOnDemand(*args, **kwargs)
DontCreateOnDemand = staticmethod(DontCreateOnDemand)
def SetTraceMask(*args, **kwargs):
- """Log.SetTraceMask(wxTraceMask ulMask)"""
+ """SetTraceMask(wxTraceMask ulMask)"""
return _misc_.Log_SetTraceMask(*args, **kwargs)
SetTraceMask = staticmethod(SetTraceMask)
def AddTraceMask(*args, **kwargs):
- """Log.AddTraceMask(String str)"""
+ """AddTraceMask(String str)"""
return _misc_.Log_AddTraceMask(*args, **kwargs)
AddTraceMask = staticmethod(AddTraceMask)
def RemoveTraceMask(*args, **kwargs):
- """Log.RemoveTraceMask(String str)"""
+ """RemoveTraceMask(String str)"""
return _misc_.Log_RemoveTraceMask(*args, **kwargs)
RemoveTraceMask = staticmethod(RemoveTraceMask)
def ClearTraceMasks(*args, **kwargs):
- """Log.ClearTraceMasks()"""
+ """ClearTraceMasks()"""
return _misc_.Log_ClearTraceMasks(*args, **kwargs)
ClearTraceMasks = staticmethod(ClearTraceMasks)
def GetTraceMasks(*args, **kwargs):
- """Log.GetTraceMasks() -> wxArrayString"""
+ """GetTraceMasks() -> wxArrayString"""
return _misc_.Log_GetTraceMasks(*args, **kwargs)
GetTraceMasks = staticmethod(GetTraceMasks)
def SetTimestamp(*args, **kwargs):
- """Log.SetTimestamp(wxChar ts)"""
+ """SetTimestamp(wxChar ts)"""
return _misc_.Log_SetTimestamp(*args, **kwargs)
SetTimestamp = staticmethod(SetTimestamp)
def GetVerbose(*args, **kwargs):
- """Log.GetVerbose() -> bool"""
+ """GetVerbose() -> bool"""
return _misc_.Log_GetVerbose(*args, **kwargs)
GetVerbose = staticmethod(GetVerbose)
def GetTraceMask(*args, **kwargs):
- """Log.GetTraceMask() -> wxTraceMask"""
+ """GetTraceMask() -> wxTraceMask"""
return _misc_.Log_GetTraceMask(*args, **kwargs)
GetTraceMask = staticmethod(GetTraceMask)
def IsAllowedTraceMask(*args, **kwargs):
- """Log.IsAllowedTraceMask(wxChar mask) -> bool"""
+ """IsAllowedTraceMask(wxChar mask) -> bool"""
return _misc_.Log_IsAllowedTraceMask(*args, **kwargs)
IsAllowedTraceMask = staticmethod(IsAllowedTraceMask)
def GetLogLevel(*args, **kwargs):
- """Log.GetLogLevel() -> wxLogLevel"""
+ """GetLogLevel() -> wxLogLevel"""
return _misc_.Log_GetLogLevel(*args, **kwargs)
GetLogLevel = staticmethod(GetLogLevel)
def GetTimestamp(*args, **kwargs):
- """Log.GetTimestamp() -> wxChar"""
+ """GetTimestamp() -> wxChar"""
return _misc_.Log_GetTimestamp(*args, **kwargs)
GetTimestamp = staticmethod(GetTimestamp)
def TimeStamp(*args, **kwargs):
- """Log.TimeStamp() -> String"""
+ """TimeStamp() -> String"""
return _misc_.Log_TimeStamp(*args, **kwargs)
TimeStamp = staticmethod(TimeStamp)
def __repr__(self):
return "<%s.%s; proxy of C++ wxPyProcess instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def Kill(*args, **kwargs):
- """Process.Kill(int pid, int sig=SIGTERM) -> int"""
+ """Kill(int pid, int sig=SIGTERM) -> int"""
return _misc_.Process_Kill(*args, **kwargs)
Kill = staticmethod(Kill)
def Exists(*args, **kwargs):
- """Process.Exists(int pid) -> bool"""
+ """Exists(int pid) -> bool"""
return _misc_.Process_Exists(*args, **kwargs)
Exists = staticmethod(Exists)
def Open(*args, **kwargs):
- """Process.Open(String cmd, int flags=EXEC_ASYNC) -> Process"""
+ """Open(String cmd, int flags=EXEC_ASYNC) -> Process"""
return _misc_.Process_Open(*args, **kwargs)
Open = staticmethod(Open)
class Sound(object):
def __repr__(self):
return "<%s.%s; proxy of C++ wxSound instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args):
- """
- __init__(self) -> Sound
- __init__(self, String fileName, bool isResource=false) -> Sound
- __init__(self, int size, wxByte data) -> Sound
- """
- newobj = _misc_.new_Sound(*args)
+ def __init__(self, *args, **kwargs):
+ """__init__(self, String fileName=EmptyString) -> Sound"""
+ newobj = _misc_.new_Sound(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
if self.thisown: destroy(self)
except: pass
- def Create(*args):
- """
- Create(self, String fileName, bool isResource=false) -> bool
- Create(self, int size, wxByte data) -> bool
- """
- return _misc_.Sound_Create(*args)
+ def Create(*args, **kwargs):
+ """Create(self, String fileName) -> bool"""
+ return _misc_.Sound_Create(*args, **kwargs)
+
+ def CreateFromData(*args, **kwargs):
+ """CreateFromData(self, PyObject data) -> bool"""
+ return _misc_.Sound_CreateFromData(*args, **kwargs)
def IsOk(*args, **kwargs):
"""IsOk(self) -> bool"""
return _misc_.Sound_IsOk(*args, **kwargs)
- def Play(*args):
+ def Play(*args, **kwargs):
"""Play(self, unsigned int flags=SOUND_ASYNC) -> bool"""
- return _misc_.Sound_Play(*args)
+ return _misc_.Sound_Play(*args, **kwargs)
- def PlaySound(*args):
- """Sound.PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -> bool"""
- return _misc_.Sound_PlaySound(*args)
+ def PlaySound(*args, **kwargs):
+ """PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -> bool"""
+ return _misc_.Sound_PlaySound(*args, **kwargs)
PlaySound = staticmethod(PlaySound)
def Stop(*args, **kwargs):
- """Sound.Stop()"""
+ """Stop()"""
return _misc_.Sound_Stop(*args, **kwargs)
Stop = staticmethod(Stop)
self.__class__ = Sound
_misc_.Sound_swigregister(SoundPtr)
-def Sound_PlaySound(*args):
+def SoundFromData(*args, **kwargs):
+ """SoundFromData(PyObject data) -> Sound"""
+ val = _misc_.new_SoundFromData(*args, **kwargs)
+ val.thisown = 1
+ return val
+
+def Sound_PlaySound(*args, **kwargs):
"""Sound_PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -> bool"""
- return _misc_.Sound_PlaySound(*args)
+ return _misc_.Sound_PlaySound(*args, **kwargs)
def Sound_Stop(*args, **kwargs):
"""Sound_Stop()"""
return _misc_.FileType_Unassociate(*args, **kwargs)
def ExpandCommand(*args, **kwargs):
- """FileType.ExpandCommand(String command, String filename, String mimetype=EmptyString) -> String"""
+ """ExpandCommand(String command, String filename, String mimetype=EmptyString) -> String"""
return _misc_.FileType_ExpandCommand(*args, **kwargs)
ExpandCommand = staticmethod(ExpandCommand)
def __repr__(self):
return "<%s.%s; proxy of C++ wxMimeTypesManager instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def IsOfType(*args, **kwargs):
- """MimeTypesManager.IsOfType(String mimeType, String wildcard) -> bool"""
+ """IsOfType(String mimeType, String wildcard) -> bool"""
return _misc_.MimeTypesManager_IsOfType(*args, **kwargs)
IsOfType = staticmethod(IsOfType)
#---------------------------------------------------------------------------
class ArtProvider(object):
+ """
+ The wx.ArtProvider class is used to customize the look of wxWidgets
+ application. When wxWidgets needs to display an icon or a bitmap (e.g.
+ in the standard file dialog), it does not use hard-coded resource but
+ asks wx.ArtProvider for it instead. This way the users can plug in
+ their own wx.ArtProvider class and easily replace standard art with
+ his/her own version. It is easy thing to do: all that is needed is
+ to derive a class from wx.ArtProvider, override it's CreateBitmap
+ method and register the provider with wx.ArtProvider.PushProvider::
+
+ class MyArtProvider(wx.ArtProvider):
+ def __init__(self):
+ wx.ArtProvider.__init__(self)
+
+ def CreateBitmap(self, artid, client, size):
+ ...
+ return bmp
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxPyArtProvider instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self) -> ArtProvider"""
+ """
+ __init__(self) -> ArtProvider
+
+ The wx.ArtProvider class is used to customize the look of wxWidgets
+ application. When wxWidgets needs to display an icon or a bitmap (e.g.
+ in the standard file dialog), it does not use hard-coded resource but
+ asks wx.ArtProvider for it instead. This way the users can plug in
+ their own wx.ArtProvider class and easily replace standard art with
+ his/her own version. It is easy thing to do: all that is needed is
+ to derive a class from wx.ArtProvider, override it's CreateBitmap
+ method and register the provider with wx.ArtProvider.PushProvider::
+
+ class MyArtProvider(wx.ArtProvider):
+ def __init__(self):
+ wx.ArtProvider.__init__(self)
+
+ def CreateBitmap(self, artid, client, size):
+ ...
+ return bmp
+
+ """
newobj = _misc_.new_ArtProvider(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
def PushProvider(*args, **kwargs):
"""
- ArtProvider.PushProvider(ArtProvider provider)
+ PushProvider(ArtProvider provider)
Add new provider to the top of providers stack.
"""
PushProvider = staticmethod(PushProvider)
def PopProvider(*args, **kwargs):
"""
- ArtProvider.PopProvider() -> bool
+ PopProvider() -> bool
Remove latest added provider and delete it.
"""
PopProvider = staticmethod(PopProvider)
def RemoveProvider(*args, **kwargs):
"""
- ArtProvider.RemoveProvider(ArtProvider provider) -> bool
+ RemoveProvider(ArtProvider provider) -> bool
- Remove provider. The provider must have been added previously!
- The provider is _not_ deleted.
+ Remove provider. The provider must have been added previously! The
+ provider is _not_ deleted.
"""
return _misc_.ArtProvider_RemoveProvider(*args, **kwargs)
RemoveProvider = staticmethod(RemoveProvider)
def GetBitmap(*args, **kwargs):
"""
- ArtProvider.GetBitmap(String id, String client=ART_OTHER, Size size=DefaultSize) -> Bitmap
+ GetBitmap(String id, String client=ART_OTHER, Size size=DefaultSize) -> Bitmap
Query the providers for bitmap with given ID and return it. Return
wx.NullBitmap if no provider provides it.
GetBitmap = staticmethod(GetBitmap)
def GetIcon(*args, **kwargs):
"""
- ArtProvider.GetIcon(String id, String client=ART_OTHER, Size size=DefaultSize) -> Icon
+ GetIcon(String id, String client=ART_OTHER, Size size=DefaultSize) -> Icon
- Query the providers for icon with given ID and return it. Return
+ Query the providers for icon with given ID and return it. Return
wx.NullIcon if no provider provides it.
"""
return _misc_.ArtProvider_GetIcon(*args, **kwargs)
"""
ArtProvider_RemoveProvider(ArtProvider provider) -> bool
- Remove provider. The provider must have been added previously!
- The provider is _not_ deleted.
+ Remove provider. The provider must have been added previously! The
+ provider is _not_ deleted.
"""
return _misc_.ArtProvider_RemoveProvider(*args, **kwargs)
"""
ArtProvider_GetIcon(String id, String client=ART_OTHER, Size size=DefaultSize) -> Icon
- Query the providers for icon with given ID and return it. Return
+ Query the providers for icon with given ID and return it. Return
wx.NullIcon if no provider provides it.
"""
return _misc_.ArtProvider_GetIcon(*args, **kwargs)
class ConfigBase(object):
"""
wx.ConfigBase class defines the basic interface of all config
- classes. It can not be used by itself (it is an abstract base
- class) and you will always use one of its derivations: wx.Config
- or wx.FileConfig.
-
- wx.ConfigBase organizes the items in a tree-like structure,
- modeled after the Unix/Dos filesystem. There are groups that act
- like directories and entries, key/value pairs that act like
- files. There is always one current group given by the current
- path. As in the file system case, to specify a key in the config
- class you must use a path to it. Config classes also support the
- notion of the current group, which makes it possible to use
- relative paths.
+ classes. It can not be used by itself (it is an abstract base class)
+ and you will always use one of its derivations: wx.Config or
+ wx.FileConfig.
+
+ wx.ConfigBase organizes the items in a tree-like structure, modeled
+ after the Unix/Dos filesystem. There are groups that act like
+ directories and entries, key/value pairs that act like files. There
+ is always one current group given by the current path. As in the file
+ system case, to specify a key in the config class you must use a path
+ to it. Config classes also support the notion of the current group,
+ which makes it possible to use relative paths.
Keys are pairs "key_name = value" where value may be of string,
integer floating point or boolean, you can not store binary data
- without first encoding it as a string. For performance reasons
- items should be kept small, no more than a couple kilobytes.
+ without first encoding it as a string. For performance reasons items
+ should be kept small, no more than a couple kilobytes.
"""
def __init__(self): raise RuntimeError, "No constructor defined"
Type_Float = _misc_.ConfigBase_Type_Float
def Set(*args, **kwargs):
"""
- ConfigBase.Set(ConfigBase config) -> ConfigBase
+ Set(ConfigBase config) -> ConfigBase
- Sets the global config object (the one returned by Get) and
- returns a reference to the previous global config object.
+ Sets the global config object (the one returned by Get) and returns a
+ reference to the previous global config object.
"""
return _misc_.ConfigBase_Set(*args, **kwargs)
Set = staticmethod(Set)
def Get(*args, **kwargs):
"""
- ConfigBase.Get(bool createOnDemand=True) -> ConfigBase
+ Get(bool createOnDemand=True) -> ConfigBase
Returns the current global config object, creating one if neccessary.
"""
Get = staticmethod(Get)
def Create(*args, **kwargs):
"""
- ConfigBase.Create() -> ConfigBase
+ Create() -> ConfigBase
Create and return a new global config object. This function will
create the "best" implementation of wx.Config available for the
Create = staticmethod(Create)
def DontCreateOnDemand(*args, **kwargs):
"""
- ConfigBase.DontCreateOnDemand()
+ DontCreateOnDemand()
- Should Get() try to create a new log object if there isn't a current one?
+ Should Get() try to create a new log object if there isn't a current
+ one?
"""
return _misc_.ConfigBase_DontCreateOnDemand(*args, **kwargs)
"""
SetPath(self, String path)
- Set current path: if the first character is '/', it's the absolute path,
- otherwise it's a relative path. '..' is supported. If the strPath
- doesn't exist it is created.
+ Set current path: if the first character is '/', it's the absolute
+ path, otherwise it's a relative path. '..' is supported. If the
+ strPath doesn't exist it is created.
"""
return _misc_.ConfigBase_SetPath(*args, **kwargs)
"""
GetFirstGroup() -> (more, value, index)
- Allows enumerating the subgroups in a config object. Returns
- a tuple containing a flag indicating there are more items, the
- name of the current item, and an index to pass to GetNextGroup to
- fetch the next item.
+ Allows enumerating the subgroups in a config object. Returns a tuple
+ containing a flag indicating there are more items, the name of the
+ current item, and an index to pass to GetNextGroup to fetch the next
+ item.
"""
return _misc_.ConfigBase_GetFirstGroup(*args, **kwargs)
"""
GetNextGroup(long index) -> (more, value, index)
- Allows enumerating the subgroups in a config object. Returns
- a tuple containing a flag indicating there are more items, the
- name of the current item, and an index to pass to GetNextGroup to
- fetch the next item.
+ Allows enumerating the subgroups in a config object. Returns a tuple
+ containing a flag indicating there are more items, the name of the
+ current item, and an index to pass to GetNextGroup to fetch the next
+ item.
"""
return _misc_.ConfigBase_GetNextGroup(*args, **kwargs)
GetFirstEntry() -> (more, value, index)
Allows enumerating the entries in the current group in a config
- object. Returns a tuple containing a flag indicating there are
- more items, the name of the current item, and an index to pass to
+ object. Returns a tuple containing a flag indicating there are more
+ items, the name of the current item, and an index to pass to
GetNextGroup to fetch the next item.
"""
return _misc_.ConfigBase_GetFirstEntry(*args, **kwargs)
GetNextEntry(long index) -> (more, value, index)
Allows enumerating the entries in the current group in a config
- object. Returns a tuple containing a flag indicating there are
- more items, the name of the current item, and an index to pass to
+ object. Returns a tuple containing a flag indicating there are more
+ items, the name of the current item, and an index to pass to
GetNextGroup to fetch the next item.
"""
return _misc_.ConfigBase_GetNextEntry(*args, **kwargs)
"""
GetNumberOfEntries(self, bool recursive=False) -> size_t
- Get the number of entries in the current group, with or
- without its subgroups.
+ Get the number of entries in the current group, with or without its
+ subgroups.
"""
return _misc_.ConfigBase_GetNumberOfEntries(*args, **kwargs)
"""
GetNumberOfGroups(self, bool recursive=False) -> size_t
- Get the number of subgroups in the current group, with or
- without its subgroups.
+ Get the number of subgroups in the current group, with or without its
+ subgroups.
"""
return _misc_.ConfigBase_GetNumberOfGroups(*args, **kwargs)
"""
RenameGroup(self, String oldName, String newName) -> bool
- Rename aa group. Returns False on failure (probably because the new
+ Rename a group. Returns False on failure (probably because the new
name is already taken by an existing entry)
"""
return _misc_.ConfigBase_RenameGroup(*args, **kwargs)
"""
DeleteEntry(self, String key, bool deleteGroupIfEmpty=True) -> bool
- Deletes the specified entry and the group it belongs to if
- it was the last key in it and the second parameter is True
+ Deletes the specified entry and the group it belongs to if it was the
+ last key in it and the second parameter is True
"""
return _misc_.ConfigBase_DeleteEntry(*args, **kwargs)
DeleteAll(self) -> bool
Delete the whole underlying object (disk file, registry key, ...)
- primarly intended for use by desinstallation routine.
+ primarly intended for use by deinstallation routine.
"""
return _misc_.ConfigBase_DeleteAll(*args, **kwargs)
"""
SetExpandEnvVars(self, bool doIt=True)
- We can automatically expand environment variables in the config entries
- (this option is on by default, you can turn it on/off at any time)
+ We can automatically expand environment variables in the config
+ entries this option is on by default, you can turn it on/off at any
+ time)
"""
return _misc_.ConfigBase_SetExpandEnvVars(*args, **kwargs)
"""
ConfigBase_Set(ConfigBase config) -> ConfigBase
- Sets the global config object (the one returned by Get) and
- returns a reference to the previous global config object.
+ Sets the global config object (the one returned by Get) and returns a
+ reference to the previous global config object.
"""
return _misc_.ConfigBase_Set(*args, **kwargs)
"""
ConfigBase_DontCreateOnDemand()
- Should Get() try to create a new log object if there isn't a current one?
+ Should Get() try to create a new log object if there isn't a current
+ one?
"""
return _misc_.ConfigBase_DontCreateOnDemand(*args, **kwargs)
class ConfigPathChanger(object):
"""
- A handy little class which changes current path to the path of
- given entry and restores it in the destructoir: so if you declare
- a local variable of this type, you work in the entry directory
- and the path is automatically restored when the function returns.
+ A handy little class which changes current path to the path of given
+ entry and restores it in the destructoir: so if you declare a local
+ variable of this type, you work in the entry directory and the path is
+ automatically restored when the function returns.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxConfigPathChanger instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
ExpandEnvVars(String sz) -> String
Replace environment variables ($SOMETHING) with their values. The
- format is $VARNAME or ${VARNAME} where VARNAME contains
- alphanumeric characters and '_' only. '$' must be escaped ('\$')
- in order to be taken literally.
+ format is $VARNAME or ${VARNAME} where VARNAME contains alphanumeric
+ characters and '_' only. '$' must be escaped ('\$') in order to be
+ taken literally.
"""
return _misc_.ExpandEnvVars(*args, **kwargs)
#---------------------------------------------------------------------------
Monday_First = _misc_.DateTime_Monday_First
Sunday_First = _misc_.DateTime_Sunday_First
def SetCountry(*args, **kwargs):
- """DateTime.SetCountry(int country)"""
+ """SetCountry(int country)"""
return _misc_.DateTime_SetCountry(*args, **kwargs)
SetCountry = staticmethod(SetCountry)
def GetCountry(*args, **kwargs):
- """DateTime.GetCountry() -> int"""
+ """GetCountry() -> int"""
return _misc_.DateTime_GetCountry(*args, **kwargs)
GetCountry = staticmethod(GetCountry)
def IsWestEuropeanCountry(*args, **kwargs):
- """DateTime.IsWestEuropeanCountry(int country=Country_Default) -> bool"""
+ """IsWestEuropeanCountry(int country=Country_Default) -> bool"""
return _misc_.DateTime_IsWestEuropeanCountry(*args, **kwargs)
IsWestEuropeanCountry = staticmethod(IsWestEuropeanCountry)
def GetCurrentYear(*args, **kwargs):
- """DateTime.GetCurrentYear(int cal=Gregorian) -> int"""
+ """GetCurrentYear(int cal=Gregorian) -> int"""
return _misc_.DateTime_GetCurrentYear(*args, **kwargs)
GetCurrentYear = staticmethod(GetCurrentYear)
def ConvertYearToBC(*args, **kwargs):
- """DateTime.ConvertYearToBC(int year) -> int"""
+ """ConvertYearToBC(int year) -> int"""
return _misc_.DateTime_ConvertYearToBC(*args, **kwargs)
ConvertYearToBC = staticmethod(ConvertYearToBC)
def GetCurrentMonth(*args, **kwargs):
- """DateTime.GetCurrentMonth(int cal=Gregorian) -> int"""
+ """GetCurrentMonth(int cal=Gregorian) -> int"""
return _misc_.DateTime_GetCurrentMonth(*args, **kwargs)
GetCurrentMonth = staticmethod(GetCurrentMonth)
def IsLeapYear(*args, **kwargs):
- """DateTime.IsLeapYear(int year=Inv_Year, int cal=Gregorian) -> bool"""
+ """IsLeapYear(int year=Inv_Year, int cal=Gregorian) -> bool"""
return _misc_.DateTime_IsLeapYear(*args, **kwargs)
IsLeapYear = staticmethod(IsLeapYear)
def GetCentury(*args, **kwargs):
- """DateTime.GetCentury(int year=Inv_Year) -> int"""
+ """GetCentury(int year=Inv_Year) -> int"""
return _misc_.DateTime_GetCentury(*args, **kwargs)
GetCentury = staticmethod(GetCentury)
def GetNumberOfDaysinYear(*args, **kwargs):
- """DateTime.GetNumberOfDaysinYear(int year, int cal=Gregorian) -> int"""
+ """GetNumberOfDaysinYear(int year, int cal=Gregorian) -> int"""
return _misc_.DateTime_GetNumberOfDaysinYear(*args, **kwargs)
GetNumberOfDaysinYear = staticmethod(GetNumberOfDaysinYear)
def GetNumberOfDaysInMonth(*args, **kwargs):
- """DateTime.GetNumberOfDaysInMonth(int month, int year=Inv_Year, int cal=Gregorian) -> int"""
+ """GetNumberOfDaysInMonth(int month, int year=Inv_Year, int cal=Gregorian) -> int"""
return _misc_.DateTime_GetNumberOfDaysInMonth(*args, **kwargs)
GetNumberOfDaysInMonth = staticmethod(GetNumberOfDaysInMonth)
def GetMonthName(*args, **kwargs):
- """DateTime.GetMonthName(int month, int flags=Name_Full) -> String"""
+ """GetMonthName(int month, int flags=Name_Full) -> String"""
return _misc_.DateTime_GetMonthName(*args, **kwargs)
GetMonthName = staticmethod(GetMonthName)
def GetWeekDayName(*args, **kwargs):
- """DateTime.GetWeekDayName(int weekday, int flags=Name_Full) -> String"""
+ """GetWeekDayName(int weekday, int flags=Name_Full) -> String"""
return _misc_.DateTime_GetWeekDayName(*args, **kwargs)
GetWeekDayName = staticmethod(GetWeekDayName)
GetAmPmStrings = staticmethod(GetAmPmStrings)
def IsDSTApplicable(*args, **kwargs):
- """DateTime.IsDSTApplicable(int year=Inv_Year, int country=Country_Default) -> bool"""
+ """IsDSTApplicable(int year=Inv_Year, int country=Country_Default) -> bool"""
return _misc_.DateTime_IsDSTApplicable(*args, **kwargs)
IsDSTApplicable = staticmethod(IsDSTApplicable)
def GetBeginDST(*args, **kwargs):
- """DateTime.GetBeginDST(int year=Inv_Year, int country=Country_Default) -> DateTime"""
+ """GetBeginDST(int year=Inv_Year, int country=Country_Default) -> DateTime"""
return _misc_.DateTime_GetBeginDST(*args, **kwargs)
GetBeginDST = staticmethod(GetBeginDST)
def GetEndDST(*args, **kwargs):
- """DateTime.GetEndDST(int year=Inv_Year, int country=Country_Default) -> DateTime"""
+ """GetEndDST(int year=Inv_Year, int country=Country_Default) -> DateTime"""
return _misc_.DateTime_GetEndDST(*args, **kwargs)
GetEndDST = staticmethod(GetEndDST)
def Now(*args, **kwargs):
- """DateTime.Now() -> DateTime"""
+ """Now() -> DateTime"""
return _misc_.DateTime_Now(*args, **kwargs)
Now = staticmethod(Now)
def UNow(*args, **kwargs):
- """DateTime.UNow() -> DateTime"""
+ """UNow() -> DateTime"""
return _misc_.DateTime_UNow(*args, **kwargs)
UNow = staticmethod(UNow)
def Today(*args, **kwargs):
- """DateTime.Today() -> DateTime"""
+ """Today() -> DateTime"""
return _misc_.DateTime_Today(*args, **kwargs)
Today = staticmethod(Today)
def __repr__(self):
return "<%s.%s; proxy of C++ wxTimeSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def Seconds(*args, **kwargs):
- """TimeSpan.Seconds(long sec) -> TimeSpan"""
+ """Seconds(long sec) -> TimeSpan"""
return _misc_.TimeSpan_Seconds(*args, **kwargs)
Seconds = staticmethod(Seconds)
def Second(*args, **kwargs):
- """TimeSpan.Second() -> TimeSpan"""
+ """Second() -> TimeSpan"""
return _misc_.TimeSpan_Second(*args, **kwargs)
Second = staticmethod(Second)
def Minutes(*args, **kwargs):
- """TimeSpan.Minutes(long min) -> TimeSpan"""
+ """Minutes(long min) -> TimeSpan"""
return _misc_.TimeSpan_Minutes(*args, **kwargs)
Minutes = staticmethod(Minutes)
def Minute(*args, **kwargs):
- """TimeSpan.Minute() -> TimeSpan"""
+ """Minute() -> TimeSpan"""
return _misc_.TimeSpan_Minute(*args, **kwargs)
Minute = staticmethod(Minute)
def Hours(*args, **kwargs):
- """TimeSpan.Hours(long hours) -> TimeSpan"""
+ """Hours(long hours) -> TimeSpan"""
return _misc_.TimeSpan_Hours(*args, **kwargs)
Hours = staticmethod(Hours)
def Hour(*args, **kwargs):
- """TimeSpan.Hour() -> TimeSpan"""
+ """Hour() -> TimeSpan"""
return _misc_.TimeSpan_Hour(*args, **kwargs)
Hour = staticmethod(Hour)
def Days(*args, **kwargs):
- """TimeSpan.Days(long days) -> TimeSpan"""
+ """Days(long days) -> TimeSpan"""
return _misc_.TimeSpan_Days(*args, **kwargs)
Days = staticmethod(Days)
def Day(*args, **kwargs):
- """TimeSpan.Day() -> TimeSpan"""
+ """Day() -> TimeSpan"""
return _misc_.TimeSpan_Day(*args, **kwargs)
Day = staticmethod(Day)
def Weeks(*args, **kwargs):
- """TimeSpan.Weeks(long days) -> TimeSpan"""
+ """Weeks(long days) -> TimeSpan"""
return _misc_.TimeSpan_Weeks(*args, **kwargs)
Weeks = staticmethod(Weeks)
def Week(*args, **kwargs):
- """TimeSpan.Week() -> TimeSpan"""
+ """Week() -> TimeSpan"""
return _misc_.TimeSpan_Week(*args, **kwargs)
Week = staticmethod(Week)
except: pass
def Days(*args, **kwargs):
- """DateSpan.Days(int days) -> DateSpan"""
+ """Days(int days) -> DateSpan"""
return _misc_.DateSpan_Days(*args, **kwargs)
Days = staticmethod(Days)
def Day(*args, **kwargs):
- """DateSpan.Day() -> DateSpan"""
+ """Day() -> DateSpan"""
return _misc_.DateSpan_Day(*args, **kwargs)
Day = staticmethod(Day)
def Weeks(*args, **kwargs):
- """DateSpan.Weeks(int weeks) -> DateSpan"""
+ """Weeks(int weeks) -> DateSpan"""
return _misc_.DateSpan_Weeks(*args, **kwargs)
Weeks = staticmethod(Weeks)
def Week(*args, **kwargs):
- """DateSpan.Week() -> DateSpan"""
+ """Week() -> DateSpan"""
return _misc_.DateSpan_Week(*args, **kwargs)
Week = staticmethod(Week)
def Months(*args, **kwargs):
- """DateSpan.Months(int mon) -> DateSpan"""
+ """Months(int mon) -> DateSpan"""
return _misc_.DateSpan_Months(*args, **kwargs)
Months = staticmethod(Months)
def Month(*args, **kwargs):
- """DateSpan.Month() -> DateSpan"""
+ """Month() -> DateSpan"""
return _misc_.DateSpan_Month(*args, **kwargs)
Month = staticmethod(Month)
def Years(*args, **kwargs):
- """DateSpan.Years(int years) -> DateSpan"""
+ """Years(int years) -> DateSpan"""
return _misc_.DateSpan_Years(*args, **kwargs)
Years = staticmethod(Years)
def Year(*args, **kwargs):
- """DateSpan.Year() -> DateSpan"""
+ """Year() -> DateSpan"""
return _misc_.DateSpan_Year(*args, **kwargs)
Year = staticmethod(Year)
class DataFormat(object):
"""
A wx.DataFormat is an encapsulation of a platform-specific format
- handle which is used by the system for the clipboard and drag and
- drop operations. The applications are usually only interested in,
- for example, pasting data from the clipboard only if the data is
- in a format the program understands. A data format is is used to
- uniquely identify this format.
-
- On the system level, a data format is usually just a number
- (CLIPFORMAT under Windows or Atom under X11, for example).
+ handle which is used by the system for the clipboard and drag and drop
+ operations. The applications are usually only interested in, for
+ example, pasting data from the clipboard only if the data is in a
+ format the program understands. A data format is is used to uniquely
+ identify this format.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxDataFormat instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""
__init__(self, int type) -> DataFormat
- Constructs a data format object for one of the standard data
- formats or an empty data object (use SetType or SetId later in
- this case)
+ Constructs a data format object for one of the standard data formats
+ or an empty data object (use SetType or SetId later in this case)
"""
newobj = _misc_.new_DataFormat(*args, **kwargs)
self.this = newobj.this
"""
SetType(self, int format)
- Sets the format to the given value, which should be one of wx.DF_XXX constants.
+ Sets the format to the given value, which should be one of wx.DF_XXX
+ constants.
"""
return _misc_.DataFormat_SetType(*args, **kwargs)
"""
GetId(self) -> String
- Returns the name of a custom format (this function will fail for a standard format).
+ Returns the name of a custom format (this function will fail for a
+ standard format).
"""
return _misc_.DataFormat_GetId(*args, **kwargs)
"""
CustomDataFormat(String format) -> DataFormat
- Constructs a data format object for a custom format identified by its name.
+ Constructs a data format object for a custom format identified by its
+ name.
"""
val = _misc_.new_CustomDataFormat(*args, **kwargs)
val.thisown = 1
return val
class DataObject(object):
+ """
+ A wx.DataObject represents data that can be copied to or from the
+ clipboard, or dragged and dropped. The important thing about
+ wx.DataObject is that this is a 'smart' piece of data unlike usual
+ 'dumb' data containers such as memory buffers or files. Being 'smart'
+ here means that the data object itself should know what data formats
+ it supports and how to render itself in each of supported formats.
+
+ **NOTE**: This class is an abstract base class and can not be used
+ directly from Python. If you need a custom type of data object then
+ you should instead derive from `wx.PyDataObjectSimple` or use
+ `wx.CustomDataObject`.
+
+ """
def __init__(self): raise RuntimeError, "No constructor defined"
def __repr__(self):
return "<%s.%s; proxy of C++ wxDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
except: pass
def GetPreferredFormat(*args, **kwargs):
- """GetPreferredFormat(self, int dir=Get) -> DataFormat"""
+ """
+ GetPreferredFormat(self, int dir=Get) -> DataFormat
+
+ Returns the preferred format for either rendering the data (if dir is
+ Get, its default value) or for setting it. Usually this will be the
+ native format of the wx.DataObject.
+ """
return _misc_.DataObject_GetPreferredFormat(*args, **kwargs)
def GetFormatCount(*args, **kwargs):
- """GetFormatCount(self, int dir=Get) -> size_t"""
+ """
+ GetFormatCount(self, int dir=Get) -> size_t
+
+ Returns the number of available formats for rendering or setting the
+ data.
+ """
return _misc_.DataObject_GetFormatCount(*args, **kwargs)
def IsSupported(*args, **kwargs):
- """IsSupported(self, DataFormat format, int dir=Get) -> bool"""
+ """
+ IsSupported(self, DataFormat format, int dir=Get) -> bool
+
+ Returns True if this format is supported.
+ """
return _misc_.DataObject_IsSupported(*args, **kwargs)
def GetDataSize(*args, **kwargs):
- """GetDataSize(self, DataFormat format) -> size_t"""
+ """
+ GetDataSize(self, DataFormat format) -> size_t
+
+ Get the (total) size of data for the given format
+ """
return _misc_.DataObject_GetDataSize(*args, **kwargs)
def GetAllFormats(*args, **kwargs):
- """GetAllFormats(self, DataFormat formats, int dir=Get)"""
+ """
+ GetAllFormats(self, int dir=Get) -> [formats]
+
+ Returns a list of all the wx.DataFormats that this dataobject supports
+ in the given direction.
+ """
return _misc_.DataObject_GetAllFormats(*args, **kwargs)
def GetDataHere(*args, **kwargs):
- """GetDataHere(self, DataFormat format, void buf) -> bool"""
+ """
+ GetDataHere(self, DataFormat format) -> String
+
+ Get the data bytes in the specified format, returns None on failure.
+
+ """
return _misc_.DataObject_GetDataHere(*args, **kwargs)
def SetData(*args, **kwargs):
- """SetData(self, DataFormat format, size_t len, void buf) -> bool"""
+ """
+ SetData(self, DataFormat format, String data) -> bool
+
+ Set the data in the specified format from the bytes in the the data string.
+
+ """
return _misc_.DataObject_SetData(*args, **kwargs)
FormatInvalid = cvar.FormatInvalid
class DataObjectSimple(DataObject):
+ """
+ wx.DataObjectSimple is a `wx.DataObject` which only supports one
+ format. This is the simplest possible `wx.DataObject` implementation.
+
+ This is still an "abstract base class" meaning that you can't use it
+ directly. You either need to use one of the predefined base classes,
+ or derive your own class from `wx.PyDataObjectSimple`.
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxDataObjectSimple instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, DataFormat format=FormatInvalid) -> DataObjectSimple"""
+ """
+ __init__(self, DataFormat format=FormatInvalid) -> DataObjectSimple
+
+ Constructor accepts the supported format (none by default) which may
+ also be set later with `SetFormat`.
+ """
newobj = _misc_.new_DataObjectSimple(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
def GetFormat(*args, **kwargs):
- """GetFormat(self) -> DataFormat"""
+ """
+ GetFormat(self) -> DataFormat
+
+ Returns the (one and only one) format supported by this object. It is
+ assumed that the format is supported in both directions.
+ """
return _misc_.DataObjectSimple_GetFormat(*args, **kwargs)
def SetFormat(*args, **kwargs):
- """SetFormat(self, DataFormat format)"""
+ """
+ SetFormat(self, DataFormat format)
+
+ Sets the supported format.
+ """
return _misc_.DataObjectSimple_SetFormat(*args, **kwargs)
+ def GetDataSize(*args, **kwargs):
+ """
+ GetDataSize(self) -> size_t
+
+ Get the size of our data.
+ """
+ return _misc_.DataObjectSimple_GetDataSize(*args, **kwargs)
+
+ def GetDataHere(*args, **kwargs):
+ """
+ GetDataHere(self) -> String
+
+ Returns the data bytes from the data object as a string, returns None
+ on failure. Must be implemented in the derived class if the object
+ supports rendering its data.
+ """
+ return _misc_.DataObjectSimple_GetDataHere(*args, **kwargs)
+
+ def SetData(*args, **kwargs):
+ """
+ SetData(self, String data) -> bool
+
+ Copy the data value to the data object. Must be implemented in the
+ derived class if the object supports setting its data.
+
+ """
+ return _misc_.DataObjectSimple_SetData(*args, **kwargs)
+
class DataObjectSimplePtr(DataObjectSimple):
def __init__(self, this):
_misc_.DataObjectSimple_swigregister(DataObjectSimplePtr)
class PyDataObjectSimple(DataObjectSimple):
+ """
+ wx.PyDataObjectSimple is a version of `wx.DataObjectSimple` that is
+ Python-aware and knows how to reflect calls to its C++ virtual methods
+ to methods in the Python derived class. You should derive from this
+ class and overload `GetDataSize`, `GetDataHere` and `SetData` when you
+ need to create your own simple single-format type of `wx.DataObject`.
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxPyDataObjectSimple instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, DataFormat format=FormatInvalid) -> PyDataObjectSimple"""
+ """
+ __init__(self, DataFormat format=FormatInvalid) -> PyDataObjectSimple
+
+ wx.PyDataObjectSimple is a version of `wx.DataObjectSimple` that is
+ Python-aware and knows how to reflect calls to its C++ virtual methods
+ to methods in the Python derived class. You should derive from this
+ class and overload `GetDataSize`, `GetDataHere` and `SetData` when you
+ need to create your own simple single-format type of `wx.DataObject`.
+
+ """
newobj = _misc_.new_PyDataObjectSimple(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
_misc_.PyDataObjectSimple_swigregister(PyDataObjectSimplePtr)
class DataObjectComposite(DataObject):
+ """
+ wx.DataObjectComposite is the simplest `wx.DataObject` derivation
+ which may be sued to support multiple formats. It contains several
+ 'wx.DataObjectSimple` objects and supports any format supported by at
+ least one of them. Only one of these data objects is *preferred* (the
+ first one if not explicitly changed by using the second parameter of
+ `Add`) and its format determines the preferred format of the composite
+ data object as well.
+
+ See `wx.DataObject` documentation for the reasons why you might prefer
+ to use wx.DataObject directly instead of wx.DataObjectComposite for
+ efficiency reasons.
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxDataObjectComposite instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self) -> DataObjectComposite"""
+ """
+ __init__(self) -> DataObjectComposite
+
+ wx.DataObjectComposite is the simplest `wx.DataObject` derivation
+ which may be sued to support multiple formats. It contains several
+ 'wx.DataObjectSimple` objects and supports any format supported by at
+ least one of them. Only one of these data objects is *preferred* (the
+ first one if not explicitly changed by using the second parameter of
+ `Add`) and its format determines the preferred format of the composite
+ data object as well.
+
+ See `wx.DataObject` documentation for the reasons why you might prefer
+ to use wx.DataObject directly instead of wx.DataObjectComposite for
+ efficiency reasons.
+
+ """
newobj = _misc_.new_DataObjectComposite(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
def Add(*args, **kwargs):
- """Add(self, DataObjectSimple dataObject, int preferred=False)"""
+ """
+ Add(self, DataObjectSimple dataObject, bool preferred=False)
+
+ Adds the dataObject to the list of supported objects and it becomes
+ the preferred object if preferred is True.
+ """
return _misc_.DataObjectComposite_Add(*args, **kwargs)
_misc_.DataObjectComposite_swigregister(DataObjectCompositePtr)
class TextDataObject(DataObjectSimple):
+ """
+ wx.TextDataObject is a specialization of `wx.DataObject` for text
+ data. It can be used without change to paste data into the `wx.Clipboard`
+ or a `wx.DropSource`.
+
+ Alternativly, you may wish to derive a new class from the
+ `wx.PyTextDataObject` class for providing text on-demand in order to
+ minimize memory consumption when offering data in several formats,
+ such as plain text and RTF, because by default the text is stored in a
+ string in this class, but it might as well be generated on demand when
+ requested. For this, `GetTextLength` and `GetText` will have to be
+ overridden.
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxTextDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, String text=EmptyString) -> TextDataObject"""
+ """
+ __init__(self, String text=EmptyString) -> TextDataObject
+
+ Constructor, may be used to initialise the text (otherwise `SetText`
+ should be used later).
+ """
newobj = _misc_.new_TextDataObject(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
def GetTextLength(*args, **kwargs):
- """GetTextLength(self) -> size_t"""
+ """
+ GetTextLength(self) -> size_t
+
+ Returns the data size. By default, returns the size of the text data
+ set in the constructor or using `SetText`. This can be overridden (via
+ `wx.PyTextDataObject`) to provide text size data on-demand. It is
+ recommended to return the text length plus 1 for a trailing zero, but
+ this is not strictly required.
+ """
return _misc_.TextDataObject_GetTextLength(*args, **kwargs)
def GetText(*args, **kwargs):
- """GetText(self) -> String"""
+ """
+ GetText(self) -> String
+
+ Returns the text associated with the data object.
+ """
return _misc_.TextDataObject_GetText(*args, **kwargs)
def SetText(*args, **kwargs):
- """SetText(self, String text)"""
+ """
+ SetText(self, String text)
+
+ Sets the text associated with the data object. This method is called
+ when the data object receives the data and, by default, copies the
+ text into the member variable. If you want to process the text on the
+ fly you may wish to override this function (via
+ `wx.PyTextDataObject`.)
+ """
return _misc_.TextDataObject_SetText(*args, **kwargs)
_misc_.TextDataObject_swigregister(TextDataObjectPtr)
class PyTextDataObject(TextDataObject):
+ """
+ wx.PyTextDataObject is a version of `wx.TextDataObject` that is
+ Python-aware and knows how to reflect calls to its C++ virtual methods
+ to methods in the Python derived class. You should derive from this
+ class and overload `GetTextLength`, `GetText`, and `SetText` when you
+ want to be able to provide text on demand instead of preloading it
+ into the data object.
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxPyTextDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, String text=EmptyString) -> PyTextDataObject"""
+ """
+ __init__(self, String text=EmptyString) -> PyTextDataObject
+
+ wx.PyTextDataObject is a version of `wx.TextDataObject` that is
+ Python-aware and knows how to reflect calls to its C++ virtual methods
+ to methods in the Python derived class. You should derive from this
+ class and overload `GetTextLength`, `GetText`, and `SetText` when you
+ want to be able to provide text on demand instead of preloading it
+ into the data object.
+ """
newobj = _misc_.new_PyTextDataObject(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
_misc_.PyTextDataObject_swigregister(PyTextDataObjectPtr)
class BitmapDataObject(DataObjectSimple):
+ """
+ wx.BitmapDataObject is a specialization of wxDataObject for bitmap
+ data. It can be used without change to paste data into the `wx.Clipboard`
+ or a `wx.DropSource`.
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxBitmapDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, Bitmap bitmap=wxNullBitmap) -> BitmapDataObject"""
+ """
+ __init__(self, Bitmap bitmap=wxNullBitmap) -> BitmapDataObject
+
+ Constructor, optionally passing a bitmap (otherwise use `SetBitmap`
+ later).
+ """
newobj = _misc_.new_BitmapDataObject(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
def GetBitmap(*args, **kwargs):
- """GetBitmap(self) -> Bitmap"""
+ """
+ GetBitmap(self) -> Bitmap
+
+ Returns the bitmap associated with the data object. You may wish to
+ override this method (by deriving from `wx.PyBitmapDataObject`) when
+ offering data on-demand, but this is not required by wxWidgets'
+ internals. Use this method to get data in bitmap form from the
+ `wx.Clipboard`.
+ """
return _misc_.BitmapDataObject_GetBitmap(*args, **kwargs)
def SetBitmap(*args, **kwargs):
- """SetBitmap(self, Bitmap bitmap)"""
+ """
+ SetBitmap(self, Bitmap bitmap)
+
+ Sets the bitmap associated with the data object. This method is called
+ when the data object receives data. Usually there will be no reason to
+ override this function.
+ """
return _misc_.BitmapDataObject_SetBitmap(*args, **kwargs)
_misc_.BitmapDataObject_swigregister(BitmapDataObjectPtr)
class PyBitmapDataObject(BitmapDataObject):
+ """
+ wx.PyBitmapDataObject is a version of `wx.BitmapDataObject` that is
+ Python-aware and knows how to reflect calls to its C++ virtual methods
+ to methods in the Python derived class. To be able to provide bitmap
+ data on demand derive from this class and overload `GetBitmap`.
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxPyBitmapDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, Bitmap bitmap=wxNullBitmap) -> PyBitmapDataObject"""
+ """
+ __init__(self, Bitmap bitmap=wxNullBitmap) -> PyBitmapDataObject
+
+ wx.PyBitmapDataObject is a version of `wx.BitmapDataObject` that is
+ Python-aware and knows how to reflect calls to its C++ virtual methods
+ to methods in the Python derived class. To be able to provide bitmap
+ data on demand derive from this class and overload `GetBitmap`.
+ """
newobj = _misc_.new_PyBitmapDataObject(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
_misc_.PyBitmapDataObject_swigregister(PyBitmapDataObjectPtr)
class FileDataObject(DataObjectSimple):
+ """
+ wx.FileDataObject is a specialization of `wx.DataObjectSimple` for
+ file names. The program works with it just as if it were a list of
+ absolute file names, but internally it uses the same format as
+ Explorer and other compatible programs under Windows or GNOME/KDE
+ filemanager under Unix which makes it possible to receive files from
+ them using this class.
+
+ :Warning: Under all non-Windows platforms this class is currently
+ "input-only", i.e. you can receive the files from another
+ application, but copying (or dragging) file(s) from a wxWidgets
+ application is not currently supported.
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxFileDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
self.thisown = 1
del newobj.thisown
def GetFilenames(*args, **kwargs):
- """GetFilenames(self) -> wxArrayString"""
+ """
+ GetFilenames(self) -> [names]
+
+ Returns a list of file names.
+ """
return _misc_.FileDataObject_GetFilenames(*args, **kwargs)
def AddFile(*args, **kwargs):
- """AddFile(self, String filename)"""
+ """
+ AddFile(self, String filename)
+
+ Adds a file to the list of files represented by this data object.
+ """
return _misc_.FileDataObject_AddFile(*args, **kwargs)
_misc_.FileDataObject_swigregister(FileDataObjectPtr)
class CustomDataObject(DataObjectSimple):
+ """
+ wx.CustomDataObject is a specialization of `wx.DataObjectSimple` for
+ some application-specific data in arbitrary format. Python strings
+ are used for getting and setting data, but any picklable object can
+ easily be transfered via strings. A copy of the data is stored in the
+ data object.
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxCustomDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self, DataFormat format=FormatInvalid) -> CustomDataObject"""
+ """
+ __init__(self, DataFormat format=FormatInvalid) -> CustomDataObject
+
+ wx.CustomDataObject is a specialization of `wx.DataObjectSimple` for
+ some application-specific data in arbitrary format. Python strings
+ are used for getting and setting data, but any picklable object can
+ easily be transfered via strings. A copy of the data is stored in the
+ data object.
+ """
newobj = _misc_.new_CustomDataObject(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
- def TakeData(*args, **kwargs):
- """TakeData(self, PyObject data)"""
- return _misc_.CustomDataObject_TakeData(*args, **kwargs)
-
def SetData(*args, **kwargs):
- """SetData(self, PyObject data) -> bool"""
+ """
+ SetData(self, String data) -> bool
+
+ Copy the data value to the data object.
+ """
return _misc_.CustomDataObject_SetData(*args, **kwargs)
+ TakeData = SetData
def GetSize(*args, **kwargs):
- """GetSize(self) -> size_t"""
+ """
+ GetSize(self) -> size_t
+
+ Get the size of the data.
+ """
return _misc_.CustomDataObject_GetSize(*args, **kwargs)
def GetData(*args, **kwargs):
- """GetData(self) -> PyObject"""
+ """
+ GetData(self) -> String
+
+ Returns the data bytes from the data object as a string.
+ """
return _misc_.CustomDataObject_GetData(*args, **kwargs)
_misc_.CustomDataObject_swigregister(CustomDataObjectPtr)
class URLDataObject(DataObjectComposite):
+ """
+ This data object holds a URL in a format that is compatible with some
+ browsers such that it is able to be dragged to or from them.
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxURLDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
- """__init__(self) -> URLDataObject"""
+ """
+ __init__(self) -> URLDataObject
+
+ This data object holds a URL in a format that is compatible with some
+ browsers such that it is able to be dragged to or from them.
+ """
newobj = _misc_.new_URLDataObject(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
def GetURL(*args, **kwargs):
- """GetURL(self) -> String"""
+ """
+ GetURL(self) -> String
+
+ Returns a string containing the current URL.
+ """
return _misc_.URLDataObject_GetURL(*args, **kwargs)
def SetURL(*args, **kwargs):
- """SetURL(self, String url)"""
+ """
+ SetURL(self, String url)
+
+ Set the URL.
+ """
return _misc_.URLDataObject_SetURL(*args, **kwargs)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
+ self._setCallbackInfo(self, DropSource, 0)
+
def _setCallbackInfo(*args, **kwargs):
"""_setCallbackInfo(self, PyObject self, PyObject _class, int incref)"""
return _misc_.DropSource__setCallbackInfo(*args, **kwargs)
class Clipboard(_core.Object):
"""
- wx.Clipboard represents the system clipboard and provides methods to copy data
- to or paste data from it. Normally, you should only use wx.TheClipboard which
- is a reference to a global wx.Clipboard instance.
+ wx.Clipboard represents the system clipboard and provides methods to
+ copy data to it or paste data from it. Normally, you should only use
+ ``wx.TheClipboard`` which is a reference to a global wx.Clipboard
+ instance.
+
+ Call ``wx.TheClipboard``'s `Open` method to get ownership of the
+ clipboard. If this operation returns True, you now own the
+ clipboard. Call `SetData` to put data on the clipboard, or `GetData`
+ to retrieve data from the clipboard. Call `Close` to close the
+ clipboard and relinquish ownership. You should keep the clipboard open
+ only momentarily.
- Call wx.TheClipboard.Open to get ownership of the clipboard. If this operation
- returns True, you now own the clipboard. Call wx.TheClipboard.SetData to put
- data on the clipboard, or wx.TheClipboard.GetData to retrieve data from the
- clipboard. Call wx.TheClipboard.Close to close the clipboard and relinquish
- ownership. You should keep the clipboard open only momentarily.
+ :see: `wx.DataObject`
"""
def __repr__(self):
"""
Open(self) -> bool
- Call this function to open the clipboard before calling SetData
- and GetData. Call Close when you have finished with the clipboard.
- You should keep the clipboard open for only a very short time.
- Returns true on success.
+ Call this function to open the clipboard before calling SetData and
+ GetData. Call Close when you have finished with the clipboard. You
+ should keep the clipboard open for only a very short time. Returns
+ True on success.
"""
return _misc_.Clipboard_Open(*args, **kwargs)
"""
AddData(self, DataObject data) -> bool
- Call this function to add the data object to the clipboard. You
- may call this function repeatedly after having cleared the clipboard.
+ Call this function to add the data object to the clipboard. You may
+ call this function repeatedly after having cleared the clipboard.
After this function has been called, the clipboard owns the data, so
do not delete the data explicitly.
+
+ :see: `wx.DataObject`
"""
return _misc_.Clipboard_AddData(*args, **kwargs)
"""
SetData(self, DataObject data) -> bool
- Set the clipboard data, this is the same as Clear followed by AddData.
+ Set the clipboard data, this is the same as `Clear` followed by
+ `AddData`.
+
+ :see: `wx.DataObject`
"""
return _misc_.Clipboard_SetData(*args, **kwargs)
"""
GetData(self, DataObject data) -> bool
- Call this function to fill data with data on the clipboard, if available
- in the required format. Returns true on success.
+ Call this function to fill data with data on the clipboard, if
+ available in the required format. Returns true on success.
"""
return _misc_.Clipboard_GetData(*args, **kwargs)
"""
Clear(self)
- Clears data from the clipboard object and also the system's clipboard
+ Clears data from the clipboard object and also the system's clipboard
if possible.
"""
return _misc_.Clipboard_Clear(*args, **kwargs)
Flush(self) -> bool
Flushes the clipboard: this means that the data which is currently on
- clipboard will stay available even after the application exits (possibly
- eating memory), otherwise the clipboard will be emptied on exit.
- Returns False if the operation is unsuccesful for any reason.
+ clipboard will stay available even after the application exits,
+ possibly eating memory, otherwise the clipboard will be emptied on
+ exit. Returns False if the operation is unsuccesful for any reason.
"""
return _misc_.Clipboard_Flush(*args, **kwargs)
"""
UsePrimarySelection(self, bool primary=True)
- On platforms supporting it (the X11 based platforms), selects the so
- called PRIMARY SELECTION as the clipboard as opposed to the normal
- clipboard, if primary is True.
+ On platforms supporting it (the X11 based platforms), selects the
+ so called PRIMARY SELECTION as the clipboard as opposed to the
+ normal clipboard, if primary is True.
"""
return _misc_.Clipboard_UsePrimarySelection(*args, **kwargs)
+ def Get(*args, **kwargs):
+ """
+ Get() -> Clipboard
+
+ Returns global instance (wxTheClipboard) of the object.
+ """
+ return _misc_.Clipboard_Get(*args, **kwargs)
+
+ Get = staticmethod(Get)
class ClipboardPtr(Clipboard):
def __init__(self, this):
self.__class__ = Clipboard
_misc_.Clipboard_swigregister(ClipboardPtr)
+def Clipboard_Get(*args, **kwargs):
+ """
+ Clipboard_Get() -> Clipboard
+
+ Returns global instance (wxTheClipboard) of the object.
+ """
+ return _misc_.Clipboard_Get(*args, **kwargs)
+
+class _wxPyDelayedInitWrapper(object):
+ def __init__(self, initfunc, *args, **kwargs):
+ self._initfunc = initfunc
+ self._args = args
+ self._kwargs = kwargs
+ self._instance = None
+ def _checkInstance(self):
+ if self._instance is None:
+ self._instance = self._initfunc(*self._args, **self._kwargs)
+ def __getattr__(self, name):
+ self._checkInstance()
+ return getattr(self._instance, name)
+ def __repr__(self):
+ self._checkInstance()
+ return repr(self._instance)
+TheClipboard = _wxPyDelayedInitWrapper(Clipboard.Get)
+
class ClipboardLocker(object):
"""
- A helpful class for opening the clipboard and automatically closing it when
- the locker is destroyed.
+ A helpful class for opening the clipboard and automatically
+ closing it when the locker is destroyed.
"""
def __repr__(self):
return "<%s.%s; proxy of C++ wxClipboardLocker instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
"""
__init__(self, Clipboard clipboard=None) -> ClipboardLocker
- A helpful class for opening the clipboard and automatically closing it when
- the locker is destroyed.
+ A helpful class for opening the clipboard and automatically
+ closing it when the locker is destroyed.
"""
newobj = _misc_.new_ClipboardLocker(*args, **kwargs)
self.this = newobj.this
if not hasattr(self,"thisown"): self.thisown = 0
self.__class__ = ClipboardLocker
_misc_.ClipboardLocker_swigregister(ClipboardLockerPtr)
-TheClipboard = cvar.TheClipboard
#---------------------------------------------------------------------------
"""
Matches(self, VideoMode other) -> bool
- Returns true if this mode matches the other one in the sense that
- all non zero fields of the other mode have the same value in this
+ Returns true if this mode matches the other one in the sense that all
+ non zero fields of the other mode have the same value in this
one (except for refresh which is allowed to have a greater value)
"""
return _misc_.VideoMode_Matches(*args, **kwargs)
"""
GetWidth(self) -> int
- Returns the screen width in pixels (e.g. 640*480), 0 means
- unspecified
+ Returns the screen width in pixels (e.g. 640*480), 0 means unspecified
"""
return _misc_.VideoMode_GetWidth(*args, **kwargs)
"""
GetDepth(self) -> int
- Returns the screen's bits per pixel (e.g. 32), 1 is monochrome
- and 0 means unspecified/known
+ Returns the screen's bits per pixel (e.g. 32), 1 is monochrome and 0
+ means unspecified/known
"""
return _misc_.VideoMode_GetDepth(*args, **kwargs)
"""
__init__(self, size_t index=0) -> Display
- Set up a Display instance with the specified display. The
- displays are numbered from 0 to GetCount() - 1, 0 is always the
- primary display and the only one which is always supported
+ Set up a Display instance with the specified display. The displays
+ are numbered from 0 to GetCount() - 1, 0 is always the primary display
+ and the only one which is always supported
"""
newobj = _misc_.new_Display(*args, **kwargs)
self.this = newobj.this
def GetCount(*args, **kwargs):
"""
- Display.GetCount() -> size_t
+ GetCount() -> size_t
Return the number of available displays.
"""
GetCount = staticmethod(GetCount)
def GetFromPoint(*args, **kwargs):
"""
- Display.GetFromPoint(Point pt) -> int
+ GetFromPoint(Point pt) -> int
- Find the display where the given point lies, return wx.NOT_FOUND
- if it doesn't belong to any display
+ Find the display where the given point lies, return wx.NOT_FOUND if it
+ doesn't belong to any display
"""
return _misc_.Display_GetFromPoint(*args, **kwargs)
GetFromPoint = staticmethod(GetFromPoint)
def GetFromWindow(*args, **kwargs):
"""
- Display.GetFromWindow(Window window) -> int
+ GetFromWindow(Window window) -> int
- Find the display where the given window lies, return wx.NOT_FOUND
- if it is not shown at all.
+ 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)
"""
GetGeometry(self) -> Rect
- Returns the bounding rectangle of the display whose index was
- passed to the constructor.
+ Returns the bounding rectangle of the display whose index was passed
+ to the constructor.
"""
return _misc_.Display_GetGeometry(*args, **kwargs)
"""
GetModes(VideoMode mode=DefaultVideoMode) -> [videoMode...]
- Enumerate all video modes supported by this display matching the
- given one (in the sense of VideoMode.Match()).
+ Enumerate all video modes supported by this display matching the given
+ one (in the sense of VideoMode.Match()).
- As any mode matches the default value of the argument and there
- is always at least one video mode supported by display, the
- returned array is only empty for the default value of the
- argument if this function is not supported at all on this
- platform.
+ As any mode matches the default value of the argument and there is
+ always at least one video mode supported by display, the returned
+ array is only empty for the default value of the argument if this
+ function is not supported at all on this platform.
"""
return _misc_.Display_GetModes(*args, **kwargs)
"""
Display_GetFromPoint(Point pt) -> int
- Find the display where the given point lies, return wx.NOT_FOUND
- if it doesn't belong to any display
+ Find the display where the given point lies, return wx.NOT_FOUND if it
+ doesn't belong to any display
"""
return _misc_.Display_GetFromPoint(*args, **kwargs)
"""
Display_GetFromWindow(Window window) -> int
- Find the display where the given window lies, return wx.NOT_FOUND
- if it is not shown at all.
+ 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)
projects / wxWidgets.git / blobdiff