return _misc.Joystick_SetMovementThreshold(*args, **kwargs)
def IsOk(*args, **kwargs):
- """IsOk(void ??) -> bool"""
+ """IsOk() -> bool"""
return _misc.Joystick_IsOk(*args, **kwargs)
def GetNumberJoysticks(*args, **kwargs):
#---------------------------------------------------------------------------
-class Wave(object):
+SOUND_SYNC = _misc.SOUND_SYNC
+SOUND_ASYNC = _misc.SOUND_ASYNC
+SOUND_LOOP = _misc.SOUND_LOOP
+class Sound(object):
def __repr__(self):
- return "<%s.%s; proxy of C++ wxWave instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(String fileName, bool isResource=False) -> Wave"""
- newobj = _misc.new_Wave(*args, **kwargs)
+ return "<%s.%s; proxy of C++ wxSound instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+ def __init__(self, *args):
+ """
+ __init__() -> Sound
+ __init__(String fileName, bool isResource=false) -> Sound
+ __init__(int size, wxByte data) -> Sound
+ """
+ newobj = _misc.new_Sound(*args)
self.this = newobj.this
self.thisown = 1
del newobj.thisown
- def __del__(self, destroy=_misc.delete_Wave):
+ def __del__(self, destroy=_misc.delete_Sound):
"""__del__()"""
try:
if self.thisown: destroy(self)
except: pass
+ def Create(*args):
+ """
+ Create(String fileName, bool isResource=false) -> bool
+ Create(int size, wxByte data) -> bool
+ """
+ return _misc.Sound_Create(*args)
+
def IsOk(*args, **kwargs):
"""IsOk() -> bool"""
- return _misc.Wave_IsOk(*args, **kwargs)
+ return _misc.Sound_IsOk(*args, **kwargs)
- def Play(*args, **kwargs):
- """Play(bool async=True, bool looped=False) -> bool"""
- return _misc.Wave_Play(*args, **kwargs)
+ def Play(*args):
+ """Play(unsigned int flags=SOUND_ASYNC) -> bool"""
+ return _misc.Sound_Play(*args)
+ def PlaySound(*args):
+ """PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -> bool"""
+ return _misc.Sound_PlaySound(*args)
+
+ PlaySound = staticmethod(PlaySound)
+ def Stop(*args, **kwargs):
+ """Stop()"""
+ return _misc.Sound_Stop(*args, **kwargs)
+
+ Stop = staticmethod(Stop)
def __nonzero__(self): return self.IsOk()
-class WavePtr(Wave):
+class SoundPtr(Sound):
def __init__(self, this):
self.this = this
if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = Wave
-_misc.Wave_swigregister(WavePtr)
+ self.__class__ = Sound
+_misc.Sound_swigregister(SoundPtr)
-def WaveData(*args, **kwargs):
- """WaveData(String data) -> Wave"""
- val = _misc.new_WaveData(*args, **kwargs)
- val.thisown = 1
- return val
+def Sound_PlaySound(*args):
+ """Sound_PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -> bool"""
+ return _misc.Sound_PlaySound(*args)
+
+def Sound_Stop(*args, **kwargs):
+ """Sound_Stop()"""
+ return _misc.Sound_Stop(*args, **kwargs)
#---------------------------------------------------------------------------
CONFIG_USE_RELATIVE_PATH = _misc.CONFIG_USE_RELATIVE_PATH
CONFIG_USE_NO_ESCAPE_CHARACTERS = _misc.CONFIG_USE_NO_ESCAPE_CHARACTERS
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
+ (directories) and keys (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.
+
+ """
def __init__(self): raise RuntimeError, "No constructor defined"
def __repr__(self):
return "<%s.%s; proxy of C++ wxConfigBase instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
Type_Integer = _misc.ConfigBase_Type_Integer
Type_Float = _misc.ConfigBase_Type_Float
def Set(*args, **kwargs):
- """Set(ConfigBase pConfig) -> 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.
+ """
return _misc.ConfigBase_Set(*args, **kwargs)
Set = staticmethod(Set)
def Get(*args, **kwargs):
- """Get(bool createOnDemand=True) -> ConfigBase"""
+ """
+ Get(bool createOnDemand=True) -> ConfigBase
+
+ Returns the current global config object, creating one if neccessary.
+ """
return _misc.ConfigBase_Get(*args, **kwargs)
Get = staticmethod(Get)
def Create(*args, **kwargs):
- """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
+ current platform.
+ """
return _misc.ConfigBase_Create(*args, **kwargs)
Create = staticmethod(Create)
def DontCreateOnDemand(*args, **kwargs):
- """DontCreateOnDemand()"""
+ """
+ DontCreateOnDemand()
+
+ Should Get() try to create a new log object if there isn't a current one?
+ """
return _misc.ConfigBase_DontCreateOnDemand(*args, **kwargs)
DontCreateOnDemand = staticmethod(DontCreateOnDemand)
def SetPath(*args, **kwargs):
- """SetPath(String strPath)"""
+ """
+ SetPath(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.
+ """
return _misc.ConfigBase_SetPath(*args, **kwargs)
def GetPath(*args, **kwargs):
- """GetPath() -> String"""
+ """
+ GetPath() -> String
+
+ Retrieve the current path (always as absolute path)
+ """
return _misc.ConfigBase_GetPath(*args, **kwargs)
def GetFirstGroup(*args, **kwargs):
- """GetFirstGroup() -> PyObject"""
+ """
+ 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.
+ """
return _misc.ConfigBase_GetFirstGroup(*args, **kwargs)
def GetNextGroup(*args, **kwargs):
- """GetNextGroup(long index) -> PyObject"""
+ """
+ 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.
+ """
return _misc.ConfigBase_GetNextGroup(*args, **kwargs)
def GetFirstEntry(*args, **kwargs):
- """GetFirstEntry() -> PyObject"""
+ """
+ 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
+ GetNextGroup to fetch the next item.
+ """
return _misc.ConfigBase_GetFirstEntry(*args, **kwargs)
def GetNextEntry(*args, **kwargs):
- """GetNextEntry(long index) -> PyObject"""
+ """
+ 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
+ GetNextGroup to fetch the next item.
+ """
return _misc.ConfigBase_GetNextEntry(*args, **kwargs)
def GetNumberOfEntries(*args, **kwargs):
- """GetNumberOfEntries(bool bRecursive=False) -> size_t"""
+ """
+ GetNumberOfEntries(bool recursive=False) -> size_t
+
+ Get the number of entries in the current group, with or
+ without its subgroups.
+ """
return _misc.ConfigBase_GetNumberOfEntries(*args, **kwargs)
def GetNumberOfGroups(*args, **kwargs):
- """GetNumberOfGroups(bool bRecursive=False) -> size_t"""
+ """
+ GetNumberOfGroups(bool recursive=False) -> size_t
+
+ Get the number of subgroups in the current group, with or
+ without its subgroups.
+ """
return _misc.ConfigBase_GetNumberOfGroups(*args, **kwargs)
def HasGroup(*args, **kwargs):
- """HasGroup(String strName) -> bool"""
+ """
+ HasGroup(String name) -> bool
+
+ Returns True if the group by this name exists
+ """
return _misc.ConfigBase_HasGroup(*args, **kwargs)
def HasEntry(*args, **kwargs):
- """HasEntry(String strName) -> bool"""
+ """
+ HasEntry(String name) -> bool
+
+ Returns True if the entry by this name exists
+ """
return _misc.ConfigBase_HasEntry(*args, **kwargs)
def Exists(*args, **kwargs):
- """Exists(String strName) -> bool"""
+ """
+ Exists(String name) -> bool
+
+ Returns True if either a group or an entry with a given name exists
+ """
return _misc.ConfigBase_Exists(*args, **kwargs)
def GetEntryType(*args, **kwargs):
- """GetEntryType(String name) -> int"""
+ """
+ GetEntryType(String name) -> int
+
+ Get the type of the entry. Returns one of the wx.Config.Type_XXX values.
+ """
return _misc.ConfigBase_GetEntryType(*args, **kwargs)
def Read(*args, **kwargs):
- """Read(String key, String defaultVal=EmptyString) -> String"""
+ """
+ Read(String key, String defaultVal=EmptyString) -> String
+
+ Returns the value of key if it exists, defaultVal otherwise.
+ """
return _misc.ConfigBase_Read(*args, **kwargs)
def ReadInt(*args, **kwargs):
- """ReadInt(String key, long defaultVal=0) -> long"""
+ """
+ ReadInt(String key, long defaultVal=0) -> long
+
+ Returns the value of key if it exists, defaultVal otherwise.
+ """
return _misc.ConfigBase_ReadInt(*args, **kwargs)
def ReadFloat(*args, **kwargs):
- """ReadFloat(String key, double defaultVal=0.0) -> double"""
+ """
+ ReadFloat(String key, double defaultVal=0.0) -> double
+
+ Returns the value of key if it exists, defaultVal otherwise.
+ """
return _misc.ConfigBase_ReadFloat(*args, **kwargs)
def ReadBool(*args, **kwargs):
- """ReadBool(String key, bool defaultVal=False) -> bool"""
+ """
+ ReadBool(String key, bool defaultVal=False) -> bool
+
+ Returns the value of key if it exists, defaultVal otherwise.
+ """
return _misc.ConfigBase_ReadBool(*args, **kwargs)
def Write(*args, **kwargs):
- """Write(String key, String value) -> bool"""
+ """
+ Write(String key, String value) -> bool
+
+ write the value (return True on success)
+ """
return _misc.ConfigBase_Write(*args, **kwargs)
def WriteInt(*args, **kwargs):
- """WriteInt(String key, long value) -> bool"""
+ """
+ WriteInt(String key, long value) -> bool
+
+ write the value (return True on success)
+ """
return _misc.ConfigBase_WriteInt(*args, **kwargs)
def WriteFloat(*args, **kwargs):
- """WriteFloat(String key, double value) -> bool"""
+ """
+ WriteFloat(String key, double value) -> bool
+
+ write the value (return True on success)
+ """
return _misc.ConfigBase_WriteFloat(*args, **kwargs)
def WriteBool(*args, **kwargs):
- """WriteBool(String key, bool value) -> bool"""
+ """
+ WriteBool(String key, bool value) -> bool
+
+ write the value (return True on success)
+ """
return _misc.ConfigBase_WriteBool(*args, **kwargs)
def Flush(*args, **kwargs):
- """Flush(bool bCurrentOnly=False) -> bool"""
+ """
+ Flush(bool currentOnly=False) -> bool
+
+ permanently writes all changes
+ """
return _misc.ConfigBase_Flush(*args, **kwargs)
def RenameEntry(*args, **kwargs):
- """RenameEntry(String oldName, String newName) -> bool"""
+ """
+ RenameEntry(String oldName, String newName) -> bool
+
+ Rename an entry. Returns False on failure (probably because the new
+ name is already taken by an existing entry)
+ """
return _misc.ConfigBase_RenameEntry(*args, **kwargs)
def RenameGroup(*args, **kwargs):
- """RenameGroup(String oldName, String newName) -> bool"""
+ """
+ RenameGroup(String oldName, String newName) -> bool
+
+ Rename aa group. Returns False on failure (probably because the new
+ name is already taken by an existing entry)
+ """
return _misc.ConfigBase_RenameGroup(*args, **kwargs)
def DeleteEntry(*args, **kwargs):
- """DeleteEntry(String key, bool bDeleteGroupIfEmpty=True) -> bool"""
+ """
+ DeleteEntry(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
+ """
return _misc.ConfigBase_DeleteEntry(*args, **kwargs)
def DeleteGroup(*args, **kwargs):
- """DeleteGroup(String key) -> bool"""
+ """
+ DeleteGroup(String key) -> bool
+
+ Delete the group (with all subgroups)
+ """
return _misc.ConfigBase_DeleteGroup(*args, **kwargs)
def DeleteAll(*args, **kwargs):
- """DeleteAll() -> bool"""
- return _misc.ConfigBase_DeleteAll(*args, **kwargs)
+ """
+ DeleteAll() -> bool
- def IsExpandingEnvVars(*args, **kwargs):
- """IsExpandingEnvVars() -> bool"""
- return _misc.ConfigBase_IsExpandingEnvVars(*args, **kwargs)
+ Delete the whole underlying object (disk file, registry key, ...)
+ primarly intended for use by desinstallation routine.
+ """
+ return _misc.ConfigBase_DeleteAll(*args, **kwargs)
def SetExpandEnvVars(*args, **kwargs):
- """SetExpandEnvVars(bool bDoIt=True)"""
+ """
+ SetExpandEnvVars(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)
+ """
return _misc.ConfigBase_SetExpandEnvVars(*args, **kwargs)
+ def IsExpandingEnvVars(*args, **kwargs):
+ """
+ IsExpandingEnvVars() -> bool
+
+ Are we currently expanding environment variables?
+ """
+ return _misc.ConfigBase_IsExpandingEnvVars(*args, **kwargs)
+
def SetRecordDefaults(*args, **kwargs):
- """SetRecordDefaults(bool bDoIt=True)"""
+ """
+ SetRecordDefaults(bool doIt=True)
+
+ Set whether the config objec should record default values.
+ """
return _misc.ConfigBase_SetRecordDefaults(*args, **kwargs)
def IsRecordingDefaults(*args, **kwargs):
- """IsRecordingDefaults() -> bool"""
+ """
+ IsRecordingDefaults() -> bool
+
+ Are we currently recording default values?
+ """
return _misc.ConfigBase_IsRecordingDefaults(*args, **kwargs)
def ExpandEnvVars(*args, **kwargs):
- """ExpandEnvVars(String str) -> String"""
+ """
+ ExpandEnvVars(String str) -> String
+
+ Expand any environment variables in str and return the result
+ """
return _misc.ConfigBase_ExpandEnvVars(*args, **kwargs)
def GetAppName(*args, **kwargs):
_misc.ConfigBase_swigregister(ConfigBasePtr)
def ConfigBase_Set(*args, **kwargs):
- """ConfigBase_Set(ConfigBase pConfig) -> ConfigBase"""
+ """
+ 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.
+ """
return _misc.ConfigBase_Set(*args, **kwargs)
def ConfigBase_Get(*args, **kwargs):
- """ConfigBase_Get(bool createOnDemand=True) -> ConfigBase"""
+ """
+ ConfigBase_Get(bool createOnDemand=True) -> ConfigBase
+
+ Returns the current global config object, creating one if neccessary.
+ """
return _misc.ConfigBase_Get(*args, **kwargs)
def ConfigBase_Create(*args, **kwargs):
- """ConfigBase_Create() -> ConfigBase"""
+ """
+ ConfigBase_Create() -> ConfigBase
+
+ Create and return a new global config object. This function will
+ create the "best" implementation of wx.Config available for the
+ current platform.
+ """
return _misc.ConfigBase_Create(*args, **kwargs)
def ConfigBase_DontCreateOnDemand(*args, **kwargs):
- """ConfigBase_DontCreateOnDemand()"""
- return _misc.ConfigBase_DontCreateOnDemand(*args, **kwargs)
-
-class ConfigPathChanger(object):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxConfigPathChanger instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(ConfigBase pContainer, String strEntry) -> ConfigPathChanger"""
- newobj = _misc.new_ConfigPathChanger(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def __del__(self, destroy=_misc.delete_ConfigPathChanger):
- """__del__()"""
- try:
- if self.thisown: destroy(self)
- except: pass
-
- def Name(*args, **kwargs):
- """Name() -> String"""
- return _misc.ConfigPathChanger_Name(*args, **kwargs)
-
+ """
+ ConfigBase_DontCreateOnDemand()
-class ConfigPathChangerPtr(ConfigPathChanger):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ConfigPathChanger
-_misc.ConfigPathChanger_swigregister(ConfigPathChangerPtr)
+ Should Get() try to create a new log object if there isn't a current one?
+ """
+ return _misc.ConfigBase_DontCreateOnDemand(*args, **kwargs)
class Config(ConfigBase):
+ """
+ This ConfigBase-derived class will use the registry on Windows,
+ and will be a wx.FileConfig on other platforms.
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxConfig instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
_misc.Config_swigregister(ConfigPtr)
class FileConfig(ConfigBase):
+ """This config class will use a file for storage on all platforms."""
def __repr__(self):
return "<%s.%s; proxy of C++ wxFileConfig instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
self.__class__ = FileConfig
_misc.FileConfig_swigregister(FileConfigPtr)
+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.
+ """
+ def __repr__(self):
+ return "<%s.%s; proxy of C++ wxConfigPathChanger instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+ def __init__(self, *args, **kwargs):
+ """__init__(ConfigBase config, String entry) -> ConfigPathChanger"""
+ newobj = _misc.new_ConfigPathChanger(*args, **kwargs)
+ self.this = newobj.this
+ self.thisown = 1
+ del newobj.thisown
+ def __del__(self, destroy=_misc.delete_ConfigPathChanger):
+ """__del__()"""
+ try:
+ if self.thisown: destroy(self)
+ except: pass
+
+ def Name(*args, **kwargs):
+ """
+ Name() -> String
+
+ Get the key name
+ """
+ return _misc.ConfigPathChanger_Name(*args, **kwargs)
+
+
+class ConfigPathChangerPtr(ConfigPathChanger):
+ def __init__(self, this):
+ self.this = this
+ if not hasattr(self,"thisown"): self.thisown = 0
+ self.__class__ = ConfigPathChanger
+_misc.ConfigPathChanger_swigregister(ConfigPathChangerPtr)
+
def ExpandEnvVars(*args, **kwargs):
- """ExpandEnvVars(String sz) -> String"""
+ """
+ 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.
+ """
return _misc.ExpandEnvVars(*args, **kwargs)
#---------------------------------------------------------------------------
"""IsValid() -> bool"""
return _misc.DateTime_IsValid(*args, **kwargs)
+ Ok = IsValid
+ def __nonzero__(self): return self.Ok()
def GetTicks(*args, **kwargs):
"""GetTicks() -> time_t"""
return _misc.DateTime_GetTicks(*args, **kwargs)
return _misc.DateTime_ParseRfc822Date(*args, **kwargs)
def ParseFormat(*args, **kwargs):
- """ParseFormat(String date, String format=DateFormatStr, DateTime dateDef=wxDefaultDateTime) -> int"""
+ """ParseFormat(String date, String format=DateFormatStr, DateTime dateDef=DefaultDateTime) -> int"""
return _misc.DateTime_ParseFormat(*args, **kwargs)
def ParseDateTime(*args, **kwargs):
if not hasattr(self,"thisown"): self.thisown = 0
self.__class__ = DataFormat
_misc.DataFormat_swigregister(DataFormatPtr)
+DefaultDateTime = cvar.DefaultDateTime
def CustomDataFormat(*args, **kwargs):
"""CustomDataFormat(String format) -> DataFormat"""
del newobj.thisown
def Add(*args, **kwargs):
"""Add(DataObjectSimple dataObject, int preferred=False)"""
- val = _misc.DataObjectComposite_Add(*args, **kwargs)
- args[1].thisown = 0
- return val
+ return _misc.DataObjectComposite_Add(*args, **kwargs)
class DataObjectCompositePtr(DataObjectComposite):
self.this = newobj.this
self.thisown = 1
del newobj.thisown
- if args: args[0].thisown = 0;
self._setCallbackInfo(self, DropTarget)
def _setCallbackInfo(*args, **kwargs):
def SetDataObject(*args, **kwargs):
"""SetDataObject(DataObject dataObject)"""
- val = _misc.DropTarget_SetDataObject(*args, **kwargs)
- args[1].thisown = 0
- return val
+ return _misc.DropTarget_SetDataObject(*args, **kwargs)
def base_OnEnter(*args, **kwargs):
"""base_OnEnter(int x, int y, int def) -> int"""
#---------------------------------------------------------------------------
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.
+
+ 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.
+
+ """
def __repr__(self):
return "<%s.%s; proxy of C++ wxClipboard instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
def __init__(self, *args, **kwargs):
except: pass
def Open(*args, **kwargs):
- """Open() -> bool"""
+ """
+ Open() -> 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.
+ """
return _misc.Clipboard_Open(*args, **kwargs)
def Close(*args, **kwargs):
- """Close()"""
+ """
+ Close()
+
+ Closes the clipboard.
+ """
return _misc.Clipboard_Close(*args, **kwargs)
def IsOpened(*args, **kwargs):
- """IsOpened() -> bool"""
+ """
+ IsOpened() -> bool
+
+ Query whether the clipboard is opened
+ """
return _misc.Clipboard_IsOpened(*args, **kwargs)
def AddData(*args, **kwargs):
- """AddData(DataObject data) -> bool"""
+ """
+ AddData(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.
+ After this function has been called, the clipboard owns the data, so
+ do not delete the data explicitly.
+ """
return _misc.Clipboard_AddData(*args, **kwargs)
def SetData(*args, **kwargs):
- """SetData(DataObject data) -> bool"""
+ """
+ SetData(DataObject data) -> bool
+
+ Set the clipboard data, this is the same as Clear followed by AddData.
+ """
return _misc.Clipboard_SetData(*args, **kwargs)
def IsSupported(*args, **kwargs):
- """IsSupported(DataFormat format) -> bool"""
+ """
+ IsSupported(DataFormat format) -> bool
+
+ Returns True if the given format is available in the data object(s) on
+ the clipboard.
+ """
return _misc.Clipboard_IsSupported(*args, **kwargs)
def GetData(*args, **kwargs):
- """GetData(DataObject data) -> bool"""
+ """
+ GetData(DataObject data) -> bool
+
+ 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)
def Clear(*args, **kwargs):
- """Clear()"""
+ """
+ Clear()
+
+ Clears data from the clipboard object and also the system's clipboard
+ if possible.
+ """
return _misc.Clipboard_Clear(*args, **kwargs)
def Flush(*args, **kwargs):
- """Flush() -> bool"""
+ """
+ Flush() -> 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.
+ """
return _misc.Clipboard_Flush(*args, **kwargs)
def UsePrimarySelection(*args, **kwargs):
- """UsePrimarySelection(bool primary=False)"""
+ """
+ UsePrimarySelection(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.
+ """
return _misc.Clipboard_UsePrimarySelection(*args, **kwargs)
_misc.Clipboard_swigregister(ClipboardPtr)
class ClipboardLocker(object):
+ """
+ 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,)
def __init__(self, *args, **kwargs):
- """__init__(Clipboard clipboard=None) -> ClipboardLocker"""
+ """
+ __init__(Clipboard clipboard=None) -> ClipboardLocker
+
+ 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
self.thisown = 1
except: pass
def __nonzero__(*args, **kwargs):
- """__nonzero__() -> bool"""
+ """
+ __nonzero__() -> bool
+
+ A ClipboardLocker instance evaluates to True if the clipboard was
+ successfully opened.
+ """
return _misc.ClipboardLocker___nonzero__(*args, **kwargs)
projects / wxWidgets.git / blobdiff