wxLua 2.8.7.0 Reference Manual for wxWidgets 2.8.7

Classes

Enums

Colours used to denote types

Interface files

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

wxUNKNOWN_PLATFORM
wxCURSES
wxXVIEW_X
wxMOTIF_X
wxCOSE_X
wxNEXTSTEP
wxMAC
wxMAC_DARWIN
wxBEOS
wxGTK
wxGTK_WIN32
wxGTK_OS2
wxGTK_BEOS
wxGEOS
wxOS2_PM
wxWINDOWS
wxMICROWINDOWS
wxPENWINDOWS
wxWINDOWS_NT
wxWIN32S
wxWIN95
wxWIN386
wxWINDOWS_CE
wxWINDOWS_POCKETPC
wxWINDOWS_SMARTPHONE
wxMGL_UNIX
wxMGL_X
wxMGL_WIN32
wxMGL_OS2
wxMGL_DOS
wxWINDOWS_OS2
wxUNIX
wxX11
wxPALMOS
wxDOS

//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
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
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 const wxArrayString GetTraceMasks()

// %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 li