wxLua 2.8.12.2 Reference Manual for wxWidgets 2.8.12

Classes

Enums

Colours used to denote types

Interface files

wxwidgets/wxbase_base.i - Lua table = 'wx'

//wxSystemOptions(); // No constructor, all member functions static

static wxString GetOption(const wxString& name) const;
static int GetOptionInt(const wxString& name) const;
static bool HasOption(const wxString& name) const;
static bool IsFalse(const wxString& name) const;

#if wxUSE_SYSTEM_OPTIONS
static void SetOption(const wxString& name, const wxString& value );
static void SetOption(const wxString& name, int value );
#endif //wxUSE_SYSTEM_OPTIONS

wxOS_UNKNOWN, // returned on error

wxOS_MAC_OS, // Apple Mac OS 8/9/X with Mac paths
wxOS_MAC_OSX_DARWIN, // Apple Mac OS X with Unix paths
wxOS_MAC, // wxOS_MAC_OS|wxOS_MAC_OSX_DARWIN,

wxOS_WINDOWS_9X, // Windows 9x family (95/98/ME );
wxOS_WINDOWS_NT, // Windows NT family (NT/2000/XP );
wxOS_WINDOWS_MICRO, // MicroWindows
wxOS_WINDOWS_CE, // Windows CE (Window Mobile );
wxOS_WINDOWS, // wxOS_WINDOWS_9X|wxOS_WINDOWS_NT|wxOS_WINDOWS_MICRO|wxOS_WINDOWS_CE,

wxOS_UNIX_LINUX, // Linux
wxOS_UNIX_FREEBSD, // FreeBSD
wxOS_UNIX_OPENBSD, // OpenBSD
wxOS_UNIX_NETBSD, // NetBSD
wxOS_UNIX_SOLARIS, // SunOS
wxOS_UNIX_AIX, // AIX
wxOS_UNIX_HPUX, // HP/UX
wxOS_UNIX, // wxOS_UNIX_LINUX|wxOS_UNIX_FREEBSD|wxOS_UNIX_OPENBSD|wxOS_UNIX_NETBSD|wxOS_UNIX_SOLARIS|wxOS_UNIX_AIX|wxOS_UNIX_HPUX,

wxOS_DOS, // Microsoft DOS
wxOS_OS2 // OS/2

wxPORT_UNKNOWN, // returned on error

wxPORT_BASE, // wxBase, no native toolkit used

wxPORT_MSW, // wxMSW, native toolkit is Windows API
wxPORT_MOTIF, // wxMotif, using [Open]Motif or Lesstif
wxPORT_GTK, // wxGTK, using GTK+ 1.x, 2.x, GPE or Maemo
!%wxchkver_2_9 wxPORT_MGL, // wxMGL, using wxUniversal
wxPORT_X11, // wxX11, using wxUniversal
wxPORT_PM, // wxOS2, using OS/2 Presentation Manager
wxPORT_OS2, // wxOS2, using OS/2 Presentation Manager
wxPORT_MAC, // wxMac, using Carbon or Classic Mac API
wxPORT_COCOA, // wxCocoa, using Cocoa NextStep/Mac API
wxPORT_WINCE, // wxWinCE, toolkit is WinCE SDK API
!%wxchkver_2_9 wxPORT_PALMOS, // wxPalmOS, toolkit is PalmOS API
wxPORT_DFB // wxDFB, using wxUniversal

wxARCH_INVALID, // returned on error

wxARCH_32, // 32 bit
wxARCH_64,

wxARCH_MAX

wxENDIAN_INVALID, // returned on error

wxENDIAN_BIG, // 4321
wxENDIAN_LITTLE, // 1234
wxENDIAN_PDP, // 3412

wxENDIAN_MAX

// No constructor, use static Get() function
//wxPlatformInfo();
//wxPlatformInfo(wxPortId pid, int tkMajor = -1, int tkMinor = -1, wxOperatingSystemId id = wxOS_UNKNOWN, int osMajor = -1, int osMinor = -1, wxArchitecture arch = wxARCH_INVALID, wxEndianness endian = wxENDIAN_INVALID, bool usingUniversal = false );

// Gets a wxPlatformInfo already initialized with the values for
// the currently running platform.
//static const wxPlatformInfo& Get();
static const wxPlatformInfo& Get( );

static wxOperatingSystemId GetOperatingSystemId(const wxString &name);
static wxPortId GetPortId(const wxString &portname);

static wxArchitecture GetArch(const wxString &arch);
static wxEndianness GetEndianness(const wxString &end);

static wxString GetOperatingSystemFamilyName(wxOperatingSystemId os);
static wxString GetOperatingSystemIdName(wxOperatingSystemId os);
static wxString GetPortIdName(wxPortId port, bool usingUniversal);
static wxString GetPortIdShortName(wxPortId port, bool usingUniversal);

static wxString GetArchName(wxArchitecture arch);
static wxString GetEndiannessName(wxEndianness end);

int GetOSMajorVersion() const;
int GetOSMinorVersion() const;

bool CheckOSVersion(int major, int minor) const;

int GetToolkitMajorVersion() const;
int GetToolkitMinorVersion() const;

bool CheckToolkitVersion(int major, int minor) const;
bool IsUsingUniversalWidgets() const;

wxOperatingSystemId GetOperatingSystemId() const;
wxPortId GetPortId() const;
wxArchitecture GetArchitecture() const;
wxEndianness GetEndianness() const;

wxString GetOperatingSystemFamilyName() const;
wxString GetOperatingSystemIdName() const;
wxString GetPortIdName() const;
wxString GetPortIdShortName() const;
wxString GetArchName() const;
wxString GetEndiannessName() const;

void SetOSVersion(int major, int minor );
void SetToolkitVersion(int major, int minor );
void SetOperatingSystemId(wxOperatingSystemId n );
void SetPortId(wxPortId n );
void SetArchitecture(wxArchitecture n );
void SetEndianness(wxEndianness n );

bool IsOk() const;

//bool operator==(const wxPlatformInfo &t) const; // we only use the wxWidget's wxPlatformInfo
//bool operator!=(const wxPlatformInfo &t) const;

wxSingleInstanceChecker(); // default ctor, use Create() after it
// like Create() but no error checking (dangerous! );
//wxSingleInstanceChecker(const wxString& name, const wxString& path = "" );

// name must be given and be as unique as possible, it is used as the mutex
// name under Win32 and the lock file name under Unix -
// wxTheApp->GetAppName() may be a good value for this parameter
//
// path is optional and is ignored under Win32 and used as the directory to
// create the lock file in under Unix (default is wxGetHomeDir() );
//
// returns false if initialization failed, it doesn't mean that another
// instance is running - use IsAnotherRunning() to check it
bool Create(const wxString& name, const wxString& path = "" );

bool IsAnotherRunning() const; // is another copy of this program already running?

wxLOG_FatalError, // program can't continue, abort immediately
wxLOG_Error, // a serious error, user must be informed about it
wxLOG_Warning, // user is normally informed about it but may be ignored
wxLOG_Message, // normal message (i.e. normal output of a non GUI app );
wxLOG_Status, // informational: might go to the status line of GUI app
wxLOG_Info, // informational message (a.k.a. 'Verbose' );
wxLOG_Debug, // never shown to the user, disabled in release mode
wxLOG_Trace, // trace messages are also only enabled in debug mode
wxLOG_Progress, // used for progress indicator (not yet );

wxLOG_User, // user defined levels start here
wxLOG_Max

//wxLog() - No constructor, a base class, use one of the derived classes.

static bool IsEnabled( );
static bool EnableLogging(bool doIt = true );
virtual void Flush( );
static void FlushActive( );
// Don't delete the active target until you set a new one or set it to wx.NULL
// Note, a new wxLog is created unless DontCreateOnDemand() is called.
static wxLog *GetActiveTarget( );
// When you create a new wxLog and call "oldLog = SetActiveTarget(MyLog)"
// the returned oldLog will be garbage collected or you can delete() the
// oldLog unless you want to reuse it by calling "myLog = SetActiveTarget(oldLog)"
// which releases myLog to be garbage collected or delete()ed by you.
// Basicly, wxWidgets 'owns' the log you pass to SetActiveTarget() and
// wxLua 'owns' the returned log.
static %gc wxLog *SetActiveTarget(%ungc wxLog *pLogger );
static void Suspend( );
static void Resume( );
static void SetVerbose(bool bVerbose = true );
static void SetLogLevel(wxLogLevel logLevel );
static void DontCreateOnDemand( );
%wxchkver_2_8 static void SetRepetitionCounting(bool bRepetCounting = true );
%wxchkver_2_8 static bool GetRepetitionCounting( );
static void SetTraceMask(wxTraceMask ulMask );
static void AddTraceMask(const wxString& str );
static void RemoveTraceMask(const wxString& str );
static void ClearTraceMasks( );
static wxArrayString GetTraceMasks(); // not const wxArrayString since we copy it anyway

// %override static void wxLog::SetTimestamp(const wxString& ts );
// Allows an input of "nil" or no value to disable time stamping.
// C++ Func: static void wxLog::SetTimestamp(const wxChar* ts );
static void SetTimestamp(const wxString& ts );

static bool GetVerbose( );
static wxTraceMask GetTraceMask( );
static bool IsAllowedTraceMask(const wxString& mask );
static wxLogLevel GetLogLevel( );
static wxString GetTimestamp( );

wxLogBuffer( );

const wxString& GetBuffer() const; // get the string contents with all messages logged

wxLogChain(wxLog *logger );

void SetLog(wxLog *logger); // change the new log target
// this can be used to temporarily disable (and then reenable) passing
// messages to the old logger (by default we do pass them );
void PassMessages(bool bDoPass );
// are we passing the messages to the previous log target?
bool IsPassingMessages() const;
// return the previous log target (may be NULL );
wxLog *GetOldLog() const;

// NOTE: ALWAYS delete() this when done since Lua's gc may not delete it soon enough
wxLogNull( );

wxLogPassThrough( );

wxLogStderr(FILE *fp = (FILE *) NULL); // redirect log output to a FILE

wxLogStream(wxSTD ostream *ostr = NULL); // redirect log output to an ostream

wxDL_LAZY, // resolve undefined symbols at first use
// (only works on some Unix versions );
wxDL_NOW, // resolve undefined symbols on load
// (default, always the case under Win32 );
wxDL_GLOBAL, // export extern symbols to subsequently
// loaded libs.
wxDL_VERBATIM, // attempt to load the supplied library
// name without appending the usual dll
// filename extension.
wxDL_NOSHARE, // load new DLL, don't reuse already loaded
// (only for wxPluginManager );

wxDL_DEFAULT, // = wxDL_NOW // default flags correspond to Win32

wxDL_LIBRARY, // standard library
wxDL_MODULE // loadable module/plugin

wxDL_PLUGIN_GUI, // plugin that uses GUI classes
wxDL_PLUGIN_BASE // wxBase-only plugin

// ctor, normally never used as these objects are only created by wxDynamicLibrary
// wxDynamicLibrary::ListLoaded( );
//wxDynamicLibraryDetails() { m_address = NULL; m_length = 0; }

wxString GetName() const; // get the (base) name
wxString GetPath() const; // get the full path of this object

// get the load address and the extent, return true if this information is available
//bool GetAddress(void **addr, size_t *len) const;

wxString GetVersion() const; // return the version of the DLL (may be empty if no version info );

//wxDynamicLibraryDetailsArray(); // Get this from wxDynamicLibrary::ListLoaded

int GetCount() const;
wxDynamicLibraryDetails Item( int n );

wxDynamicLibrary( );
wxDynamicLibrary(const wxString& libname, int flags = wxDL_DEFAULT );

// return a valid handle for the main program itself or NULL if back
// linking is not supported by the current platform (e.g. Win32 );
//static wxDllType GetProgramHandle();

// return the platform standard DLL extension (with leading dot );
//static const wxChar *GetDllExt( );
static wxString GetDllExt( );

// return true if the library was loaded successfully
bool IsLoaded() const;

// load the library with the given name (full or not), return true if ok
bool Load(const wxString& libname, int flags = wxDL_DEFAULT);

// raw function for loading dynamic libs: always behaves as if
// wxDL_VERBATIM were specified and doesn't log error message if the
// library couldn't be loaded but simply returns NULL
//static wxDllType RawLoad(const wxString& libname, int flags = wxDL_DEFAULT);

// detach the library object from its handle, i.e. prevent the object from
// unloading the library in its dtor -- the caller is now responsible for doing this
//wxDllType Detach( );

// unload the given library handle (presumably returned by Detach() before );
//static void Unload(wxDllType handle);

// unload the library, also done automatically in dtor
void Unload( );

// Return the raw handle from dlopen and friends.
//wxDllType GetLibHandle() const; // { return m_handle; }

// check if the given symbol is present in the library, useful to verify if
// a loadable module is our plugin, for example, without provoking error
// messages from GetSymbol( );
bool HasSymbol(const wxString& name) const;

// resolve a symbol in a loaded DLL, such as a variable or function name.
// 'name' is the (possibly mangled) name of the symbol. (use extern "C" to
// export unmangled names );
// Since it is perfectly valid for the returned symbol to actually be NULL,
// that is not always indication of an error. Pass and test the parameter
// 'success' for a true indication of success or failure to load the symbol.
// Returns a pointer to the symbol on success, or NULL if an error occurred
// or the symbol wasn't found.
//void *GetSymbol(const wxString& name, bool *success = NULL) const;

// low-level version of GetSymbol( );
//static void *RawGetSymbol(wxDllType handle, const wxString& name);
//void *RawGetSymbol(const wxString& name) const;

//#ifdef __WXMSW__
// this function is useful for loading functions from the standard Windows
// DLLs: such functions have an 'A' (in ANSI build) or 'W' (in Unicode, or
// wide character build) suffix if they take string parameters
//static void *RawGetSymbolAorW(wxDllType handle, const wxString& name );
//void *GetSymbolAorW(const wxString& name) const;
//#endif // __WXMSW__

// return all modules/shared libraries in the address space of this process
// returns an empty array if not implemented or an error occurred
static wxDynamicLibraryDetailsArray ListLoaded();

// return platform-specific name of dynamic library with proper extension
// and prefix (e.g. "foo.dll" on Windows or "libfoo.so" on Linux );
static wxString CanonicalizeName(const wxString& name, wxDynamicLibraryCategory cat = wxDL_LIBRARY);

// return name of wxWidgets plugin (adds compiler and version info
// to the filename):
static wxString CanonicalizePluginName(const wxString& name, wxPluginCategory cat = wxDL_PLUGIN_GUI);

// return plugin directory on platforms where it makes sense and empty string on others:
static wxString GetPluginsDirectory( );

wxCriticalSection( );
void Enter( );
void Leave( );

wxCriticalSectionLocker(wxCriticalSection& cs);

wxRegEx( );
wxRegEx(const wxString& expr, int flags = wxRE_DEFAULT );

bool Compile(const wxString& pattern, int flags = wxRE_DEFAULT );
bool IsValid() const;
wxString GetMatch(const wxString& text, size_t index = 0) const;

// %override [bool, size_t start, size_t len] wxRegEx::GetMatch(size_t index = 0) const;
// C++ Func: bool GetMatch(size_t* start, size_t* len, size_t index = 0) const;
%override_name wxLua_wxRegEx_GetMatchIndexes bool GetMatch(size_t index = 0) const;

size_t GetMatchCount() const;
// Note: only need this form of Matches
bool Matches(const wxString &text, int flags = 0) const;

// %override [int, string text] wxRegEx::Replace(const wxString& text, const wxString& replacement, size_t maxMatches = 0) const;
// C++ Func: int Replace(wxString* text, const wxString& replacement, size_t maxMatches = 0) const;
int Replace(const wxString& text, const wxString& replacement, size_t maxMatches = 0) const;

// %override [int, string text] wxRegEx::ReplaceAll(const wxString& text, const wxString& replacement) const;
// C++ Func: int ReplaceAll(wxString* text, const wxString& replacement) const;
int ReplaceAll(const wxString& text, const wxString& replacement) const;

// %override [int, string text] wxRegEx::ReplaceFirst(const wxString& text, const wxString& replacement) const;
// C++ Func: int ReplaceFirst(wxString* text, const wxString& replacement) const;
int ReplaceFirst(const wxString& text, const wxString& replacement) const;

wxEvtHandler( );

void AddPendingEvent(wxEvent& event );

// NOTE: Connect used to be called ConnectEvent in wxLua which is not the name of any C++ function.

// %override wxEvtHandler::Connect(int id, int lastId, wxEventType eventType, Lua function );
// %override wxEvtHandler::Connect(int id, wxEventType eventType, Lua function );
// %override wxEvtHandler::Connect(wxEventType eventType, Lua function );
// The function type above is determined at runtime depending on the inputs.
// C++ Func: void Connect(int id, int lastId, wxEventType eventType, wxObjectEventFunction function, wxObject* userData = NULL, wxEvtHandler* eventSink = NULL );
// Note: wxLua uses the userdata and the event sink and so they're not available
void Connect(int id, int lastId, wxEventType eventType, LuaFunction func );

// %override bool Disconnect(int winid, int lastId, wxEventType eventType );
// %override bool Disconnect(int winid, wxEventType eventType );
// %override bool Disconnect(wxEventType eventType );
// The function type above is determined at runtime depending on the inputs.
// C++ Func: bool Disconnect(int id, int lastId = wxID_ANY, wxEventType eventType = wxEVT_NULL, wxObjectEventFunction function = NULL, wxObject* userData = NULL, wxEvtHandler* eventSink = NULL );
// Note: wxLua uses the userdata and the event sink and so they're not available
bool Disconnect(int id, int lastId, wxEventType eventType );

voidptr_long GetClientData(); // C++ returns (void *) You get a number here
wxClientData* GetClientObject() const;
bool GetEvtHandlerEnabled( );
wxEvtHandler* GetNextHandler( );
wxEvtHandler* GetPreviousHandler( );
virtual bool ProcessEvent(wxEvent& event );
%wxchkver_2_9 virtual void QueueEvent(%ungc wxEvent *event);
//virtual bool SearchEventTable(wxEventTable& table, wxEvent& event );
void SetClientData(voidptr_long number); // C++ is (void *clientData) You can put a number here
void SetClientObject(wxClientData* data );
void SetEvtHandlerEnabled(bool enabled );
void SetNextHandler(wxEvtHandler* handler );
void SetPreviousHandler(wxEvtHandler* handler );

wxEVENT_PROPAGATE_NONE, // don't propagate it at all
wxEVENT_PROPAGATE_MAX // propagate it until it is processed

// wxEvent(int id = 0, wxEventType eventType = wxEVT_NULL) virtual base class

wxObject* GetEventObject( );
wxEventType GetEventType( );
int GetId( );
bool GetSkipped( );
long GetTimestamp( );
bool IsCommandEvent() const;
void ResumePropagation(int propagationLevel );
void SetEventObject(wxObject* object );
void SetEventType(wxEventType type );
void SetId(int id );
void SetTimestamp(long timeStamp );
bool ShouldPropagate() const;
void Skip(bool skip = true );
int StopPropagation( );

wxwidgets/wxbase_config.i - Lua table = 'wx'

Type_Unknown,
Type_String,
Type_Boolean,
Type_Integer,
Type_Float

// No constructor since this is a base class

// %override wxConfigBase::delete() - this is a wxLua provided function to
// delete the config (or derived class). Created wxConfigs are NOT tracked
// in memory since you MUST call wxConfigBase::Set(NULL) before
// deleting them. This is because the wxConfig you install using
// wxConfigBase::Set may need to exist outside of the scope it was created
// in and we don't want Lua to garbage collect it.
//void delete( );

// Note: the return wxConfig cannot be deleted.
// You must call "config = Set(wx.NULL); config:delete()"
static wxConfigBase* Create( );
static void DontCreateOnDemand( );

bool DeleteAll( );
bool DeleteEntry(const wxString& key, bool bDeleteGroupIfEmpty = true );
bool DeleteGroup(const wxString& key );
bool Exists(wxString& strName) const;
bool Flush(bool bCurrentOnly = false );
static wxConfigBase* Get(bool CreateOnDemand = true );
wxString GetAppName() const;
wxConfigBase::EntryType GetEntryType(const wxString& name) const;

// %override [bool, string, index] wxConfigBase::GetFirstGroup( );
// C++ Func: bool GetFirstGroup(wxString& str, long& index) const;
bool GetFirstGroup() const;

// %override [bool, string, index] wxConfigBase::GetFirstEntry( );
// C++ Func: bool GetFirstEntry(wxString& str, long& index) const;
bool GetFirstEntry() const;

// %override [bool, string, index] wxConfigBase::GetNextGroup(index );
// C++ Func: bool GetNextGroup(wxString& str, long& index) const;
bool GetNextGroup() const;

// %override [bool, string, index] wxConfigBase::GetNextEntry(index );
// C++ Func: bool GetNextEntry(wxString& str, long& index) const;
bool GetNextEntry(long index) const;

unsigned int GetNumberOfEntries(bool bRecursive = false) const;
unsigned int GetNumberOfGroups(bool bRecursive = false) const;
const wxString& GetPath() const;
wxString GetVendorName() const;
bool HasEntry(wxString& strName) const;
bool HasGroup(const wxString& strName) const;
bool IsExpandingEnvVars() const;
bool IsRecordingDefaults() const;

// %override [bool, string] wxConfigBase::Read(const wxString& key, const wxString& defaultVal = "" );
// C++ Func: bool Read(const wxString& key, wxString* str, const wxString& defaultVal) const;
bool Read(const wxString& key, const wxString& defaultVal = "") const;

// Since Lua uses double as it's number type, we only read/write doubles

// %override [bool, double] wxConfigBase::Read(const wxString& key, double defaultVal = 0 );
// C++ Func: bool Read(const wxString& key, double* d, double defaultVal = 0) const;
%override_name wxLua_wxConfigBase_ReadFloat bool Read(const wxString& key, double defaultVal) const;

// // %override [bool, int] wxConfigBase::ReadInt(const wxString& key, long defaultVal = 0 );
// // C++ Func: bool Read(const wxString& key, long* l, long defaultVal = 0) const;
// %rename ReadInt bool Read(const wxString& key, long defaultVal = 0) const;
// // %override [bool, double] wxConfigBase::ReadFloat(const wxString& key, double defaultVal = 0 );
// // C++ Func: bool Read(const wxString& key, double* d, double defaultVal = 0) const;
// %rename ReadFloat bool Read(const wxString& key, double defaultVal = 0) const;

bool RenameEntry(const wxString& oldName, const wxString& newName );
bool RenameGroup(const wxString& oldName, const wxString& newName );
static %gc wxConfigBase* Set(%ungc wxConfigBase *pConfig = NULL );
void SetExpandEnvVars(bool bDoIt = true );
void SetPath(const wxString& strPath );
void SetRecordDefaults(bool bDoIt = true );


bool Write(const wxString& key, wxString &value );
// Since Lua uses double as it's number type, we only read/write doubles
bool Write(const wxString &key, double value );

// %rename WriteInt bool Write(const wxString &key, long value );
// %rename WriteFloat bool Write(const wxString &key, double value );

wxConfig(const wxString& appName = "", const wxString& vendorName = "", const wxString& localFilename = "", const wxString& globalFilename = "", long style = 0 );

wxFileConfig(const wxString& appName = "", const wxString& vendorName = "", const wxString& localFilename = "", const wxString& globalFilename = "", long style = wxCONFIG_USE_LOCAL_FILE | wxCONFIG_USE_GLOBAL_FILE); //, wxMBConv& conv = wxConvUTF8 );

void SetUmask(int mode );

wxMemoryConfig( );

// NOTE: ALWAYS delete() this when done since Lua's gc may not delete it soon enough
wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry );

wxString Name() const;
%wxchkver_2_8 void UpdateIfDeleted( );

wxwidgets/wxbase_data.i - Lua table = 'wx'

wxString(const wxString& str = "" );

wxString GetData() const;

wxString AfterFirst(wxChar ch) const;
wxString AfterLast(wxChar ch) const;
wxString BeforeFirst(wxChar ch) const;
wxString BeforeLast(wxChar ch) const;

size_t Len() const;

const wxCharBuffer ToUTF8() const;
static wxString FromUTF8(const char* s);

static wxString From8BitData(const char* s);
wxCharBuffer To8BitData();

#if %wxchkver_2_9
//wxString(wxString::const_iterator first, wxString::const_iterator last );
wxString::const_iterator begin() const;
wxString::iterator begin( );
wxString::const_iterator end() const;
wxString::iterator end( );
#endif

wxString::const_iterator( );
wxString::const_iterator(const wxString::const_iterator& i );
wxString::const_iterator(const wxString::iterator& i );

//wxUniChar operator*() const;
char operator*() const;

wxString::const_iterator& operator=(const wxString::const_iterator& i );
wxString::const_iterator operator+(ptrdiff_t n) const;
wxString::const_iterator operator-(ptrdiff_t n) const;

wxString::iterator( );
wxString::iterator(const wxString::iterator& i );

//wxUniChar operator*() const;
char operator*() const;

wxString::iterator& operator=(const wxString::iterator& i );
wxString::iterator operator+(ptrdiff_t n) const;
wxString::iterator operator-(ptrdiff_t n) const;

wxTOKEN_INVALID, // set by def ctor until SetString() is called
wxTOKEN_DEFAULT, // strtok() for whitespace delims, RET_EMPTY else
wxTOKEN_RET_EMPTY, // return empty token in the middle of the string
wxTOKEN_RET_EMPTY_ALL, // return trailing empty tokens too
wxTOKEN_RET_DELIMS, // return the delim with token (implies RET_EMPTY );
wxTOKEN_STRTOK // behave exactly like strtok(3 );

wxStringTokenizer( );
wxStringTokenizer(const wxString& str, const wxString& delims = wxDEFAULT_DELIMITERS, wxStringTokenizerMode mode = wxTOKEN_DEFAULT);

void SetString(const wxString& str, const wxString& delims = wxDEFAULT_DELIMITERS, wxStringTokenizerMode mode = wxTOKEN_DEFAULT);

void Reinit(const wxString& str);
size_t CountTokens() const;
bool HasMoreTokens() const;
wxString GetNextToken();
//wxChar GetLastDelimiter() const;

wxString GetString() const;
size_t GetPosition() const;

wxStringTokenizerMode GetMode() const;
bool AllowEmpty() const;

// declare this as a datatype, but there is nothing we can do with this as
// it must be derived, see wxStringClientData

wxStringClientData(const wxString& data = "" );

wxString GetData() const;
void SetData(const wxString& data );

wxClientDataContainer( );

void SetClientObject( wxClientData *data );
wxClientData *GetClientObject() const;

void SetClientData( voidptr_long data ); // C++ is (void *clientData) You can put a number here
// C++ Func: void *GetClientData() const;
voidptr_long GetClientData() const; // C++ returns (void *) You get a number here

wxObject( );

//void Dump(ostream& stream );

// %override [new class type] wxObject::DynamicCast() converts the wxObject
// to an object of type classname
void *DynamicCast(const wxString &classname );

wxClassInfo* GetClassInfo( );
wxObjectRefData* GetRefData() const;
bool IsKindOf(wxClassInfo *info );
bool IsSameAs(const wxObject& o) const;
void Ref(const wxObject& clone );
void SetRefData(wxObjectRefData* data );
void UnRef( );

//wxObject& operator=(const wxObject& other );

int GetRefCount() const;

// %override wxClassInfo() constructor creates an instance using wxClassInfo::FindClass
wxClassInfo(const wxString &name );

wxObject* CreateObject( );
static wxClassInfo* FindClass(const wxString &name );
wxString GetBaseClassName1() const;
wxString GetBaseClassName2() const;
const wxClassInfo *GetBaseClass1() const;
const wxClassInfo *GetBaseClass2() const;
wxString GetClassName() const;
int GetSize() const;
bool IsDynamic( );
bool IsKindOf(wxClassInfo* info );

static const wxClassInfo *GetFirst( );
const wxClassInfo *GetNext() const;

wxKEY_NONE,
wxKEY_INTEGER,
wxKEY_STRING

wxList( );

wxNode *Append(wxObject *object );
wxNode *Append(long key, wxObject *object );
wxNode *Append(const wxString& key, wxObject *object );
void Clear( );
void DeleteContents(bool destroy );
bool DeleteNode(wxNode *pNode );
bool DeleteObject(wxObject *pObject );
wxNode* Find(wxObject* pObject );
wxNode *Find(long key );
wxNode *Find(const wxString &key );
int GetCount() const;
wxNode *GetFirst( );
wxNode *GetLast( );
int IndexOf(wxObject* pObject );
wxNode *Insert(wxObject *pObject );
wxNode *Insert(size_t position, wxObject *pObject );
wxNode *Insert(wxNode *pNode, wxObject *pObject );
bool IsEmpty() const;
wxNode *Item(int iIndex) const;
wxNode *Member(wxObject *pObject );

// no constructor, just use this from a wxList

wxObject *GetData( );
wxNode *GetNext( );
wxNode *GetPrevious( );
void SetData(wxObject *data );
//int IndexOf() - unfortunately a protected member of wxNodeBase

// To convert wxObject* GetData() to another type use wxObject::DynamicCast
// See wxMenuItemList, wxWindowList

// Example: How to use a wxWindowList
// frame = wx.wxFrame(wx.NULL, wx.wxID_ANY, "Test");
// win = wx.wxWindow(frame, wx.wxID_ANY );
// frame:Show(true );
// wlist = frame:GetChildren( );
// wlist:Item(0):GetData():DynamicCast("wxWindow"):SetBackgroundColour(wx.wxRED );

// Example: How to use a wxMenuItemList
// local fileMenu = wx.wxMenu( );
// fileMenu:Append(wx.wxID_EXIT, "E&xit", "Quit the program" );
// mList = fileMenu:GetMenuItems( );
// print(mList:GetCount(), mList:GetFirst():GetData():DynamicCast("wxMenuItem"):GetLabel() );

wxArrayInt( );
wxArrayInt(const wxArrayInt& array );

// %override [Lua table] wxArrayInt::ToLuaTable() const;
// returns a table array of the integers
int ToLuaTable() const;

void Add( int num );
void Alloc(size_t count );
void Clear( );
void Empty( );
int GetCount() const;
bool IsEmpty() const;
int Index(int n, bool searchFromEnd = false );
void Insert( int num, int n, int copies = 1 );
int Item( int n );
void Remove(int n );
void RemoveAt(size_t index );
void Shrink( );

int operator[](size_t nIndex );

wxArrayString( );
wxArrayString(const wxArrayString& array );

// %override [Lua table] wxArrayString::ToLuaTable() const;
// returns a table array of the strings
int ToLuaTable() const;

size_t Add(const wxString& str, size_t copies = 1 );
void Alloc(size_t nCount );
void Clear( );
void Empty( );
int GetCount() const;
int Index(const wxString &sz, bool bCase = true, bool bFromEnd = false );
void Insert(const wxString& str, int nIndex, size_t copies = 1 );
bool IsEmpty( );
wxString Item(size_t nIndex) const;
wxString Last( );
void Remove(const wxString &sz );
void RemoveAt(size_t nIndex, size_t count = 1 );
void Shrink( );
void Sort(bool reverseOrder = false );

wxString& operator[](size_t nIndex );

wxSortedArrayString( );
wxSortedArrayString(const wxArrayString& src); // have to have this constructor since they're not actually derived
wxSortedArrayString(const wxSortedArrayString& src );

wxLongLong(long hi = 0, unsigned long lo = 0 );

wxLongLong Abs() const;
wxLongLong& Assign(double d );
long GetHi() const;
unsigned long GetLo() const;
double ToDouble() const;
long ToLong() const;
wxString ToString() const;

//wxLongLong operator+(const wxLongLong& ll) const;
//wxLongLong& operator+(const wxLongLong& ll );
//wxLongLong& operator++( );
//wxLongLong operator-() const;
//wxLongLong operator-(const wxLongLong& ll) const;

wxULongLong(unsigned long hi = 0, unsigned long lo = 0 );

unsigned long GetHi() const;
unsigned long GetLo() const;
long ToULong() const;
wxString ToString() const;

wxwidgets/wxbase_datetime.i - Lua table = 'wx'

Local,
GMT_12,
GMT_11,
GMT_10,
GMT_9,
GMT_8,
GMT_7,
GMT_6,
GMT_5,
GMT_4,
GMT_3,
GMT_2,
GMT_1,
GMT0,
GMT1,
GMT2,
GMT3,
GMT4,
GMT5,
GMT6,
GMT7,
GMT8,
GMT9,
GMT10,
GMT11,
GMT12,
%wxchkver_2_8 GMT13,
WET,
WEST,
CET,
CEST,
EET,
EEST,
MSK,
MSD,
AST,
ADT,
EST,
EDT,
CST,
CDT,
MST,
MDT,
PST,
PDT,
HST,
AKST,
AKDT,
A_WST,
A_CST,
A_EST,
A_ESST,
%wxchkver_2_8 NZST,
%wxchkver_2_8 NZDT,
UTC

Gregorian,
Julian

Country_Unknown,
Country_Default,
Country_WesternEurope_Start,
Country_EEC,
France,
Germany,
UK,
Country_WesternEurope_End,
Russia,
USA

Jan,
Feb,
Mar,
Apr,
May,
Jun,
Jul,
Aug,
Sep,
Oct,
Nov,
Dec,
Inv_Month

Sun,
Mon,
Tue,
Wed,
Thu,
Fri,
Sat,
Inv_WeekDay

Inv_Year

Name_Full,
Name_Abbr

Default_First,
Monday_First,
Sunday_First

wxDateTime::TimeZone(wxDateTime::TZ tz );

static wxDateTime::TimeZone Make(long offset );
long GetOffset() const;

#define_object wxDefaultDateTime

static void SetCountry(wxDateTime::Country country );
static wxDateTime::Country GetCountry( );
static bool IsWestEuropeanCountry(wxDateTime::Country country = wxDateTime::Country_Default );

static int GetCurrentYear(wxDateTime::Calendar cal = wxDateTime::Gregorian );
static int ConvertYearToBC(int year );
static wxDateTime::Month GetCurrentMonth(wxDateTime::Calendar cal = wxDateTime::Gregorian );
static bool IsLeapYear(int year = wxDateTime::Inv_Year, wxDateTime::Calendar cal = wxDateTime::Gregorian );
static int GetCentury(int year );
static wxDateTime::wxDateTime_t GetNumberOfDays(int year, wxDateTime::Calendar cal = wxDateTime::Gregorian );
static wxDateTime::wxDateTime_t GetNumberOfDays(wxDateTime::Month month, int year = wxDateTime::Inv_Year, wxDateTime::Calendar cal = wxDateTime::Gregorian );
static wxString GetMonthName(wxDateTime::Month month, wxDateTime::NameFlags flags = wxDateTime::Name_Full );
static wxString GetWeekDayName(wxDateTime::WeekDay weekday, wxDateTime::NameFlags flags = wxDateTime::Name_Full );
//static void GetAmPmStrings(wxString *am, wxString *pm );
static bool IsDSTApplicable(int year = wxDateTime::Inv_Year, wxDateTime::Country country = wxDateTime::Country_Default );
static wxDateTime GetBeginDST(int year = wxDateTime::Inv_Year, wxDateTime::Country country = wxDateTime::Country_Default );
static wxDateTime GetEndDST(int year = wxDateTime::Inv_Year, wxDateTime::Country country = wxDateTime::Country_Default );
static wxDateTime Now( );
static wxDateTime UNow( );
static wxDateTime Today( );


wxDateTime( );
wxDateTime(const wxDateTime& dateTime );
wxDateTime(time_t dateTime); // use with Lua's os.time() on MSW, Linux, others?
%rename wxDateTimeFromJDN wxDateTime(double dateTime );
%rename wxDateTimeFromHMS wxDateTime(int hour, int minute, int second, int millisec );
%rename wxDateTimeFromDMY wxDateTime(int day, wxDateTime::Month month = wxDateTime::Inv_Month, int year = wxDateTime::Inv_Year, int hour = 0, int minute = 0, int second = 0, int millisec = 0 );

wxDateTime& SetToCurrent( );
wxDateTime& Set(time_t time); // use with Lua's os.time() on MSW, Linux, others?
%rename SetToJDN wxDateTime& Set(double dateTime );
%rename SetToHMS wxDateTime& Set(int hour, int minute, int second, int millisec );
%rename SetToDMY wxDateTime& Set(int day, wxDateTime::Month month = wxDateTime::Inv_Month, int year = wxDateTime::Inv_Year, int hour = 0, int minute = 0, int second = 0, int millisec = 0 );
wxDateTime& ResetTime( );
wxDateTime GetDateOnly() const;
wxDateTime& SetYear(int year );
wxDateTime& SetMonth(wxDateTime::Month month );
wxDateTime& SetDay(int day );
wxDateTime& SetHour(int hour );
wxDateTime& SetMinute(int minute );
wxDateTime& SetSecond(int second );
wxDateTime& SetMillisecond(int millisecond );

bool IsWorkDay(wxDateTime::Country country = wxDateTime::Country_Default) const;
bool IsEqualTo(const wxDateTime& datetime) const;
bool IsEarlierThan(const wxDateTime& datetime) const;
bool IsLaterThan(const wxDateTime& datetime) const;
bool IsStrictlyBetween(const wxDateTime& t1, const wxDateTime& t2) const;
bool IsBetween(const wxDateTime& t1, const wxDateTime& t2) const;
bool IsSameDate(const wxDateTime& dt) const;
bool IsSameTime(const wxDateTime& dt) const;
bool IsEqualUpTo(const wxDateTime& dt, const wxTimeSpan& ts) const;
bool IsValid( );
long GetTicks( );

wxDateTime& SetToWeekDayInSameWeek(wxDateTime::WeekDay weekday );
wxDateTime GetWeekDayInSameWeek(wxDateTime::WeekDay weekday) const;
wxDateTime& SetToNextWeekDay(wxDateTime::WeekDay weekday );
wxDateTime GetNextWeekDay(wxDateTime::WeekDay weekday) const;
wxDateTime& SetToPrevWeekDay(wxDateTime::WeekDay weekday );
wxDateTime GetPrevWeekDay(wxDateTime::WeekDay weekday) const;
bool SetToWeekDay(wxDateTime::WeekDay weekday, int n = 1, wxDateTime::Month month = wxDateTime::Inv_Month, int year = wxDateTime::Inv_Year );
wxDateTime GetWeekDay(wxDateTime::WeekDay weekday, int n = 1, wxDateTime::Month month = wxDateTime::Inv_Month, int year = wxDateTime::Inv_Year) const;
bool SetToLastWeekDay(wxDateTime::WeekDay weekday, wxDateTime::Month month = wxDateTime::Inv_Month, int year = wxDateTime::Inv_Year );
wxDateTime GetLastWeekDay(wxDateTime::WeekDay weekday, wxDateTime::Month month = wxDateTime::Inv_Month, int year = wxDateTime::Inv_Year );

!%wxchkver_2_6 bool SetToTheWeek(wxDateTime::wxDateTime_t numWeek, wxDateTime::WeekDay weekday = wxDateTime::Mon );
!%wxchkver_2_6 wxDateTime GetWeek(wxDateTime::wxDateTime_t numWeek, wxDateTime::WeekDay weekday = wxDateTime::Mon) const;

%wxchkver_2_6 static wxDateTime SetToWeekOfYear(int year, wxDateTime::wxDateTime_t numWeek, wxDateTime::WeekDay weekday = wxDateTime::Mon );
wxDateTime& SetToLastMonthDay(wxDateTime::Month month = wxDateTime::Inv_Month, int year = wxDateTime::Inv_Year );
wxDateTime GetLastMonthDay(wxDateTime::Month month = wxDateTime::Inv_Month, int year = wxDateTime::Inv_Year) const;
wxDateTime& SetToYearDay(wxDateTime::wxDateTime_t yday );
wxDateTime GetYearDay(wxDateTime::wxDateTime_t yday) const;
double GetJulianDayNumber() const;
double GetJDN() const;
double GetModifiedJulianDayNumber() const;
double GetMJD() const;
double GetRataDie() const;

wxDateTime ToTimezone(const wxDateTime::TimeZone& tz, bool noDST = false) const;
wxDateTime& MakeTimezone(const wxDateTime::TimeZone& tz, bool noDST = false );
wxDateTime FromTimezone(const wxDateTime::TimeZone& tz, bool noDST = false) const;
wxDateTime& MakeFromTimezone(const wxDateTime::TimeZone& tz, bool noDST = false );

wxDateTime ToUTC(bool noDST = false) const;
wxDateTime& MakeUTC(bool noDST = false );
wxDateTime ToGMT(bool noDST = false) const;
wxDateTime& MakeGMT(bool noDST = false );
wxDateTime FromUTC(bool noDST = false) const;
wxDateTime& MakeFromUTC(bool noDST = false );
int IsDST(wxDateTime::Country country = wxDateTime::Country_Default) const;

bool IsValid() const;
//Tm GetTm(const wxDateTime::TimeZone& tz = wxDateTime::Local) const;
time_t GetTicks() const;
int GetCentury(const wxDateTime::TimeZone& tz = wxLua_wxDateTime_TimeZone_Local) const;
int GetYear(const wxDateTime::TimeZone& tz = wxLua_wxDateTime_TimeZone_Local) const;
wxDateTime::Month GetMonth(const wxDateTime::TimeZone& tz = wxLua_wxDateTime_TimeZone_Local) const;
wxDateTime::wxDateTime_t GetDay(const wxDateTime::TimeZone& tz = wxLua_wxDateTime_TimeZone_Local) const;
wxDateTime::WeekDay GetWeekDay(const wxDateTime::TimeZone& tz = wxLua_wxDateTime_TimeZone_Local) const;
wxDateTime::wxDateTime_t GetHour(const wxDateTime::TimeZone& tz = wxLua_wxDateTime_TimeZone_Local) const;
wxDateTime::wxDateTime_t GetMinute(const wxDateTime::TimeZone& tz = wxLua_wxDateTime_TimeZone_Local) const;
wxDateTime::wxDateTime_t GetSecond(const wxDateTime::TimeZone& tz = wxLua_wxDateTime_TimeZone_Local) const;
wxDateTime::wxDateTime_t GetMillisecond(const wxDateTime::TimeZone& tz = wxLua_wxDateTime_TimeZone_Local) const;

wxDateTime::wxDateTime_t GetDayOfYear(const wxDateTime::TimeZone& tz = wxLua_wxDateTime_TimeZone_Local) const;
wxDateTime::wxDateTime_t GetWeekOfYear(wxDateTime::WeekFlags flags = wxDateTime::Monday_First, const wxDateTime::TimeZone& tz = wxLua_wxDateTime_TimeZone_Local) const;
wxDateTime::wxDateTime_t GetWeekOfMonth(wxDateTime::WeekFlags flags = wxDateTime::Monday_First, const wxDateTime::TimeZone& tz = wxLua_wxDateTime_TimeZone_Local) const;
bool IsWorkDay(wxDateTime::Country country = wxDateTime::Country_Default) const;
//bool IsGregorianDate(GregorianAdoption country = Gr_Standard) const;

wxDateTime& SetFromDOS(unsigned long ddt);
unsigned long GetAsDOS() const;

bool IsEqualTo(const wxDateTime& datetime) const;
bool IsEarlierThan(const wxDateTime& datetime) const;
bool IsLaterThan(const wxDateTime& datetime) const;
bool IsStrictlyBetween(const wxDateTime& t1, const wxDateTime& t2) const;
bool IsBetween(const wxDateTime& t1, const wxDateTime& t2) const;
bool IsSameDate(const wxDateTime& dt) const;
bool IsSameTime(const wxDateTime& dt) const;
bool IsEqualUpTo(const wxDateTime& dt, const wxTimeSpan& ts) const;

bool operator<(const wxDateTime& dt) const;
bool operator<=(const wxDateTime& dt) const;
bool operator>(const wxDateTime& dt) const;
bool operator>=(const wxDateTime& dt) const;
bool operator==(const wxDateTime& dt) const;
bool operator!=(const wxDateTime& dt) const;

wxDateTime& Add(const wxTimeSpan& diff );
wxDateTime& Add(const wxDateSpan& diff );
wxDateTime& Subtract(const wxTimeSpan& diff );
wxDateTime& Subtract(const wxDateSpan& diff );

// ALL of the ParseXXX() functions in wx29 that take a 'wxString::const_iterator *end'
// return the remainder of the input string after the error occurred if possible or
// the whole string. Only a bool value of true is returned on success.

// %override [bool, lua String remainder on error] ParseRfc822Date(const wxString& date );
// C++ Func: bool ParseRfc822Date(const wxString& date, wxString::const_iterator *end );
%wxchkver_2_9 bool ParseRfc822Date(const wxString& date );
// %override [bool, lua String remainder on error] ParseFormat(const wxString& date, wxString format, const wxDateTime& dateDef );
// C++ Func: bool ParseFormat(const wxString& date, wxString format, const wxDateTime& dateDef, wxString::const_iterator *end );
%wxchkver_2_9 bool ParseFormat(const wxString& date, wxString format, const wxDateTime& dateDef );
// %override [bool, lua String remainder on error] ParseFormat(const wxString& date, wxString format );
// C++ Func: bool ParseFormat(const wxString& date, wxString format, wxString::const_iterator *end );
%wxchkver_2_9 bool ParseFormat(const wxString& date, wxString format );
// %override [bool, lua String remainder on error] ParseFormat(const wxString& date );
// C++ Func: bool ParseFormat(const wxString& date, wxString::const_iterator *end );
%wxchkver_2_9 bool ParseFormat(const wxString& date );
// %override [bool, lua String remainder on error] ParseDateTime(const wxString& date );
// C++ Func: bool ParseDateTime(const wxString& date, wxString::const_iterator *end );
%wxchkver_2_9 bool ParseDateTime(const wxString& datetime );
// %override [bool, lua String remainder on error] ParseDate(const wxString& date );
// C++ Func: bool ParseDate(const wxString& date, wxString::const_iterator *end );
%wxchkver_2_9 bool ParseDate(const wxString& date );
// %override [bool, lua String remainder on error] ParseTime(const wxString& date );
// C++ Func: bool ParseTime(const wxString& date, wxString::const_iterator *end );
%wxchkver_2_9 bool ParseTime(const wxString& time );

!%wxchkver_2_9 wxString ParseRfc822Date(wxString date );
!%wxchkver_2_9 wxString ParseFormat(wxString date, wxString format = "%c", const wxDateTime& dateDef = wxDefaultDateTime );
!%wxchkver_2_9 wxString ParseDateTime(wxString datetime );
!%wxchkver_2_9 wxString ParseDate(wxString date );
!%wxchkver_2_9 wxString ParseTime(wxString time );

wxString FormatDate() const;
wxString FormatTime() const;
wxString FormatISODate() const;
wxString FormatISOTime() const;
wxString Format(wxString format = "%c", wxDateTime::TZ tz = wxDateTime::Local) const;

wxDateTimeArray( );
wxDateTimeArray(const wxDateTimeArray& array );

void Add(const wxDateTime& dateTime, size_t copies = 1 );
void Alloc(size_t nCount );
void Clear( );
void Empty( );
int GetCount() const;
void Insert(const wxDateTime& dt, int nIndex, size_t copies = 1 );
bool IsEmpty( );
wxDateTime Item(size_t nIndex) const;
wxDateTime Last( );
void RemoveAt(size_t nIndex, size_t count = 1 );
void Shrink( );

wxTimeSpan( );
wxTimeSpan(long hours, long minutes = 0, long seconds = 0, long milliseconds = 0 );

wxTimeSpan Abs( );
wxTimeSpan Add(const wxTimeSpan& diff) const;
static wxTimeSpan Days(long days );
static wxTimeSpan Day( );
wxString Format(wxString format = "%H:%M:%S") const;
int GetDays() const;
int GetHours() const;
wxLongLong GetMilliseconds() const;
int GetMinutes() const;
wxLongLong GetSeconds() const;
wxLongLong GetValue() const;
int GetWeeks() const;
static wxTimeSpan Hours(long hours );
static wxTimeSpan Hour( );
bool IsEqualTo(const wxTimeSpan& ts) const;
bool IsLongerThan(const wxTimeSpan& ts) const;
bool IsNegative() const;
bool IsNull() const;
bool IsPositive() const;
bool IsShorterThan(const wxTimeSpan& ts) const;
static wxTimeSpan Minutes(long min );
static wxTimeSpan Minute( );
wxTimeSpan Multiply(int n) const;
wxTimeSpan Negate() const;
wxTimeSpan& Neg( );
static wxTimeSpan Seconds(long sec );
static wxTimeSpan Second( );
wxTimeSpan Subtract(const wxTimeSpan& diff) const;
static wxTimeSpan Weeks(long weeks );
static wxTimeSpan Week( );