From: John L. <jr...@us...> - 2007-06-27 19:56:32
|
Update of /cvsroot/wxlua/wxLua/docs In directory sc8-pr-cvs9.sourceforge.net:/tmp/cvs-serv18874/wxLua/docs Modified Files: wxluaref.html Log Message: Add wxDynamicLibrary and friends to bindings Index: wxluaref.html =================================================================== RCS file: /cvsroot/wxlua/wxLua/docs/wxluaref.html,v retrieving revision 1.35 retrieving revision 1.36 diff -C2 -d -r1.35 -r1.36 *** wxluaref.html 27 Jun 2007 03:11:27 -0000 1.35 --- wxluaref.html 27 Jun 2007 19:56:28 -0000 1.36 *************** *** 832,836 **** <td align="center" bgcolor=AAFFAA>X <td bgcolor=FFAAAA> ! <td> <tr> <td><a href="#wxDocChildFrame">wxDocChildFrame</a> --- 832,836 ---- <td align="center" bgcolor=AAFFAA>X <td bgcolor=FFAAAA> ! <td>Deprecated since version 2.4, see wxDynamicLibrary <tr> <td><a href="#wxDocChildFrame">wxDocChildFrame</a> *************** *** 889,900 **** <td> <tr> ! <td>wxDynamicLibrary <td align="center" bgcolor=AAFFAA>X - <td bgcolor=FFAAAA> <td> <tr> ! <td>wxDynamicLibraryDetails <td align="center" bgcolor=AAFFAA>X <td bgcolor=FFAAAA> <td> <tr> --- 889,905 ---- <td> <tr> ! <td><a href="#wxDynamicLibrary">wxDynamicLibrary</a> ! <td align="center" bgcolor=AAFFAA>X <td align="center" bgcolor=AAFFAA>X <td> <tr> ! <td><a href="#wxDynamicLibraryDetails">wxDynamicLibraryDetails</a> ! <td align="center" bgcolor=AAFFAA>X <td align="center" bgcolor=AAFFAA>X + <td> + <tr> + <td><a href="#wxDynamicLibraryDetailsArray">wxDynamicLibraryDetailsArray</a> <td bgcolor=FFAAAA> + <td align="center" bgcolor=AAFFAA>X <td> <tr> *************** *** 3279,3282 **** --- 3284,3288 ---- <a href="#wxCheckBoxState">wxCheckBoxState</a><br> <a href="#wxConfigBase::EntryType">wxConfigBase::EntryType</a><br> + <a href="#wxDLFlags">wxDLFlags</a><br> <a href="#wxDataFormatId">wxDataFormatId</a><br> <a href="#wxDataObject::Direction">wxDataObject::Direction</a><br> *************** *** 3289,3292 **** --- 3295,3299 ---- <a href="#wxDragResult">wxDragResult</a><br> <a href="#wxDuplexMode">wxDuplexMode</a><br> + <a href="#wxDynamicLibraryCategory">wxDynamicLibraryCategory</a><br> <a href="#wxEOL">wxEOL</a><br> <a href="#wxEdge">wxEdge</a><br> *************** *** 3336,3339 **** --- 3343,3347 ---- <a href="#wxPathFormat">wxPathFormat</a><br> <a href="#wxPathNormalize">wxPathNormalize</a><br> + <a href="#wxPluginCategory">wxPluginCategory</a><br> <a href="#wxPortId">wxPortId</a><br> <a href="#wxPowerType">wxPowerType</a><br> *************** *** 4386,4389 **** --- 4394,4554 ---- <font color=#009900>//bool operator!=(const <a href="#wxPlatformInfo">wxPlatformInfo</a> &t) const</font><br> </blockquote><font color=#DD0000><font color=#DD0000><i>%endclass</i></font></font><br> + <br> + <br> + <font color=#009900>// ---------------------------------------------------------------------------</font><br> + <font color=#009900>// <a href="#wxDynamicLibrary">wxDynamicLibrary</a> - No a lot you can do with this, but it might make</font><br> + <font color=#009900>// testing or debugging a C++ program easier to test thing</font><br> + <font color=#009900>// out in wxLua first.</font><br> + <br> + <i>%if</i> <font color=#009900>// wxLUA_USE_wxDynamicLibrary && wxUSE_DYNLIB_CLASS</font><br> + <br> + <i>%include</i> "wx/dynlib.h"<br> + <br> + <b><font size=+1 color=#0066CC><i>%enum</i> <a name="wxDLFlags">wxDLFlags</a></font></b> + <blockquote><font color=#0066CC> + wxDL_LAZY <font color=#009900>// resolve undefined symbols at first use</font><br> + <font color=#009900>// (only works on some Unix versions)</font><br> + wxDL_NOW <font color=#009900>// resolve undefined symbols on load</font><br> + <font color=#009900>// (default, always the case under Win32)</font><br> + wxDL_GLOBAL <font color=#009900>// export extern symbols to subsequently</font><br> + <font color=#009900>// loaded libs.</font><br> + wxDL_VERBATIM <font color=#009900>// attempt to load the supplied library</font><br> + <font color=#009900>// name without appending the usual dll</font><br> + <font color=#009900>// filename extension.</font><br> + wxDL_NOSHARE <font color=#009900>// load new DLL, don't reuse already loaded</font><br> + <font color=#009900>// (only for wxPluginManager)</font><br> + <br> + wxDL_DEFAULT <font color=#009900>// = wxDL_NOW // default flags correspond to Win32</font><br> + </font> + </blockquote><font color=#0066CC><i>%endenum</i></font><br> + <br> + <b><font size=+1 color=#0066CC><i>%enum</i> <a name="wxDynamicLibraryCategory">wxDynamicLibraryCategory</a></font></b> + <blockquote><font color=#0066CC> + wxDL_LIBRARY, <font color=#009900>// standard library</font><br> + wxDL_MODULE <font color=#009900>// loadable module/plugin</font><br> + </font> + </blockquote><font color=#0066CC><i>%endenum</i></font><br> + <br> + <b><font size=+1 color=#0066CC><i>%enum</i> <a name="wxPluginCategory">wxPluginCategory</a></font></b> + <blockquote><font color=#0066CC> + wxDL_PLUGIN_GUI, <font color=#009900>// plugin that uses GUI classes</font><br> + wxDL_PLUGIN_BASE <font color=#009900>// wxBase-only plugin</font><br> + </font> + </blockquote><font color=#0066CC><i>%endenum</i></font><br> + <br> + <br> + <b><font size=+1 color=#DD0000><i>%class</i> <i>%delete</i> <i>%noclassinfo</i> <i>%encapsulate</i> <a name="wxDynamicLibraryDetails">wxDynamicLibraryDetails</a></font></b> + <blockquote> + <font color=#009900>// ctor, normally never used as these objects are only created by</font><br> + <font color=#009900>// wxDynamicLibrary::ListLoaded()</font><br> + <font color=#009900>//<a href="#wxDynamicLibraryDetails">wxDynamicLibraryDetails</a>() { m_address = NULL; m_length = 0; }</font><br> + <br> + <a href="#wxString">wxString</a> GetName() const <font color=#009900>// get the (base) name</font><br> + <a href="#wxString">wxString</a> GetPath() const <font color=#009900>// get the full path of this object</font><br> + <br> + <font color=#009900>// get the load address and the extent, return true if this information is available</font><br> + <font color=#009900>//bool GetAddress(void **addr, size_t *len) const</font><br> + <br> + <a href="#wxString">wxString</a> GetVersion() const <font color=#009900>// return the version of the DLL (may be empty if no version info)</font><br> + </blockquote><font color=#DD0000><font color=#DD0000><i>%endclass</i></font></font><br> + <br> + <b><font size=+1 color=#DD0000><i>%class</i> <i>%delete</i> <i>%noclassinfo</i> <i>%encapsulate</i> <a name="wxDynamicLibraryDetailsArray">wxDynamicLibraryDetailsArray</a></font></b> + <blockquote> + <font color=#009900>//<a href="#wxDynamicLibraryDetailsArray">wxDynamicLibraryDetailsArray</a>() // Get this from wxDynamicLibrary::ListLoaded</font><br> + <br> + int GetCount() const<br> + <a href="#wxDynamicLibraryDetails">wxDynamicLibraryDetails</a> Item( int n )<br> + </blockquote><font color=#DD0000><font color=#DD0000><i>%endclass</i></font></font><br> + <br> + <br> + <b><font size=+1 color=#DD0000><i>%class</i> <i>%delete</i> <i>%noclassinfo</i> <i>%encapsulate</i> <a name="wxDynamicLibrary">wxDynamicLibrary</a></font></b> + <blockquote> + <a href="#wxDynamicLibrary">wxDynamicLibrary</a>()<br> + <a href="#wxDynamicLibrary">wxDynamicLibrary</a>(const <a href="#wxString">wxString</a>& libname, int flags = wxDL_DEFAULT)<br> + <br> + <font color=#009900>// return a valid handle for the main program itself or NULL if back</font><br> + <font color=#009900>// linking is not supported by the current platform (e.g. Win32)</font><br> + <font color=#009900>//static wxDllType GetProgramHandle();</font><br> + <br> + <font color=#009900>// return the platform standard DLL extension (with leading dot)</font><br> + <font color=#009900>//static const wxChar *GetDllExt()</font><br> + static <a href="#wxString">wxString</a> GetDllExt()<br> + <br> + <font color=#009900>// return true if the library was loaded successfully</font><br> + bool IsLoaded() const<br> + <br> + <font color=#009900>// load the library with the given name (full or not), return true if ok</font><br> + bool Load(const <a href="#wxString">wxString</a>& libname, int flags = wxDL_DEFAULT);<br> + <br> + <font color=#009900>// raw function for loading dynamic libs: always behaves as if</font><br> + <font color=#009900>// wxDL_VERBATIM were specified and doesn't log error message if the</font><br> + <font color=#009900>// library couldn't be loaded but simply returns NULL</font><br> + <font color=#009900>//static wxDllType RawLoad(const <a href="#wxString">wxString</a>& libname, int flags = wxDL_DEFAULT);</font><br> + <br> + <font color=#009900>// detach the library object from its handle, i.e. prevent the object from</font><br> + <font color=#009900>// unloading the library in its dtor -- the caller is now responsible for doing this</font><br> + <font color=#009900>//wxDllType Detach()</font><br> + <br> + <font color=#009900>// unload the given library handle (presumably returned by Detach() before)</font><br> + <font color=#009900>//static void Unload(wxDllType handle);</font><br> + <br> + <font color=#009900>// unload the library, also done automatically in dtor</font><br> + void Unload()<br> + <br> + <font color=#009900>// Return the raw handle from dlopen and friends.</font><br> + <font color=#009900>//wxDllType GetLibHandle() const { return m_handle; }</font><br> + <br> + <font color=#009900>// check if the given symbol is present in the library, useful to verify if</font><br> + <font color=#009900>// a loadable module is our plugin, for example, without provoking error</font><br> + <font color=#009900>// messages from GetSymbol()</font><br> + bool HasSymbol(const <a href="#wxString">wxString</a>& name) const<br> + <br> + <font color=#009900>// resolve a symbol in a loaded DLL, such as a variable or function name.</font><br> + <font color=#009900>// 'name' is the (possibly mangled) name of the symbol. (use extern "C" to</font><br> + <font color=#009900>// export unmangled names)</font><br> + <font color=#009900>// Since it is perfectly valid for the returned symbol to actually be NULL,</font><br> + <font color=#009900>// that is not always indication of an error. Pass and test the parameter</font><br> + <font color=#009900>// 'success' for a true indication of success or failure to load the symbol.</font><br> + <font color=#009900>// Returns a pointer to the symbol on success, or NULL if an error occurred</font><br> + <font color=#009900>// or the symbol wasn't found.</font><br> + <font color=#009900>//void *GetSymbol(const <a href="#wxString">wxString</a>& name, bool *success = NULL) const;</font><br> + <br> + <font color=#009900>// low-level version of GetSymbol()</font><br> + <font color=#009900>//static void *RawGetSymbol(wxDllType handle, const <a href="#wxString">wxString</a>& name);</font><br> + <font color=#009900>//void *RawGetSymbol(const <a href="#wxString">wxString</a>& name) const</font><br> + <br> + <font color=#009900>//#ifdef __WXMSW__</font><br> + <font color=#009900>// this function is useful for loading functions from the standard Windows</font><br> + <font color=#009900>// DLLs: such functions have an 'A' (in ANSI build) or 'W' (in Unicode, or</font><br> + <font color=#009900>// wide character build) suffix if they take string parameters</font><br> + <font color=#009900>//static void *RawGetSymbolAorW(wxDllType handle, const <a href="#wxString">wxString</a>& name)</font><br> + <font color=#009900>//void *GetSymbolAorW(const <a href="#wxString">wxString</a>& name) const</font><br> + <font color=#009900>//#endif // __WXMSW__</font><br> + <br> + <font color=#009900>// return all modules/shared libraries in the address space of this process</font><br> + <font color=#009900>// returns an empty array if not implemented or an error occurred</font><br> + static <a href="#wxDynamicLibraryDetailsArray">wxDynamicLibraryDetailsArray</a> ListLoaded();<br> + <br> + <font color=#009900>// return platform-specific name of dynamic library with proper extension</font><br> + <font color=#009900>// and prefix (e.g. "foo.dll" on Windows or "libfoo.so" on Linux)</font><br> + static <a href="#wxString">wxString</a> CanonicalizeName(const <a href="#wxString">wxString</a>& name, <a href="#wxDynamicLibraryCategory">wxDynamicLibraryCategory</a> cat = wxDL_LIBRARY);<br> + <br> + <font color=#009900>// return name of wxWidgets plugin (adds compiler and version info</font><br> + <font color=#009900>// to the filename):</font><br> + static <a href="#wxString">wxString</a> CanonicalizePluginName(const <a href="#wxString">wxString</a>& name, <a href="#wxPluginCategory">wxPluginCategory</a> cat = wxDL_PLUGIN_GUI);<br> + <br> + <font color=#009900>// return plugin directory on platforms where it makes sense and empty string on others:</font><br> + static <a href="#wxString">wxString</a> GetPluginsDirectory()<br> + </blockquote><font color=#DD0000><font color=#DD0000><i>%endclass</i></font></font><br> + <br> + <br> + <font color=#009900>// ---------------------------------------------------------------------------</font><br> + <font color=#009900>// wxPluginLibrary - You cannot use this within wxLua</font><br> + <br> + <font color=#009900>// ---------------------------------------------------------------------------</font><br> + <font color=#009900>// wxPluginManager - You cannot use this within wxLua</font><br> + <br> + <br> + <i>%endif</i> <font color=#009900>// wxLUA_USE_wxDynamicLibrary && wxUSE_DYNLIB_CLASS</font><br> <br><HR> *************** *** 7826,7832 **** <font color=#009900>// domains are searched in the last to first order, i.e. catalogs</font><br> <font color=#009900>// added later override those added before.</font><br> ! virtual <a href="#wxString">wxString</a> GetString(const <a href="#wxString">wxString</a>& szOrigString, const <a href="#wxString">wxString</a>& szDomain = "") const;<br> <font color=#009900>// plural form version of the same:</font><br> ! virtual <a href="#wxString">wxString</a> GetString(const <a href="#wxString">wxString</a>& szOrigString, const <a href="#wxString">wxString</a>& szOrigString2, size_t n, const <a href="#wxString">wxString</a>& szDomain = "") const;<br> <br> <font color=#009900>// Returns the current short name for the locale</font><br> --- 7991,7997 ---- <font color=#009900>// domains are searched in the last to first order, i.e. catalogs</font><br> <font color=#009900>// added later override those added before.</font><br> ! virtual <a href="#wxString">wxString</a> GetString(const <a href="#wxString">wxString</a>& szOrigString, const wxChar* szDomain = NULL) const;<br> <font color=#009900>// plural form version of the same:</font><br> ! virtual <a href="#wxString">wxString</a> GetString(const <a href="#wxString">wxString</a>& szOrigString, const <a href="#wxString">wxString</a>& szOrigString2, size_t n, const wxChar* szDomain = NULL) const;<br> <br> <font color=#009900>// Returns the current short name for the locale</font><br> *************** *** 8584,8588 **** <font color=#009900>// <i>%function</i> wxTipProvider* wxCreateFileTipProvider(const <a href="#wxString">wxString</a>& filename, size_t currentTip)</font><br> <br> ! <font color=#006666><i>%define_string</i> wxDirSelectorPromptStr</font><br> <font color=#AA0000><i>%function</i> <a href="#wxString">wxString</a> wxDirSelector(const <a href="#wxString">wxString</a>& message = wxDirSelectorPromptStr, const <a href="#wxString">wxString</a>& default_path = "", long style = wxDD_DEFAULT_STYLE, const <a href="#wxPoint">wxPoint</a>& pos = wxDefaultPosition, <a href="#wxWindow">wxWindow</a> *parent = NULL)</font><br> <font color=#AA0000><i>%function</i> <a href="#wxString">wxString</a> wxFileSelector(const <a href="#wxString">wxString</a>& message, const <a href="#wxString">wxString</a>& default_path = "", const <a href="#wxString">wxString</a>& default_filename = "", const <a href="#wxString">wxString</a>& default_extension = "", const <a href="#wxString">wxString</a>& wildcard = "*.*", int flags = 0, <a href="#wxWindow">wxWindow</a> *parent = NULL, int x = -1, int y = -1)</font><br> --- 8749,8753 ---- <font color=#009900>// <i>%function</i> wxTipProvider* wxCreateFileTipProvider(const <a href="#wxString">wxString</a>& filename, size_t currentTip)</font><br> <br> ! <font color=#006666><i>%define_string</i> wxDirSelectorPromptStr wxT("Select a directory")</font><br> <font color=#AA0000><i>%function</i> <a href="#wxString">wxString</a> wxDirSelector(const <a href="#wxString">wxString</a>& message = wxDirSelectorPromptStr, const <a href="#wxString">wxString</a>& default_path = "", long style = wxDD_DEFAULT_STYLE, const <a href="#wxPoint">wxPoint</a>& pos = wxDefaultPosition, <a href="#wxWindow">wxWindow</a> *parent = NULL)</font><br> <font color=#AA0000><i>%function</i> <a href="#wxString">wxString</a> wxFileSelector(const <a href="#wxString">wxString</a>& message, const <a href="#wxString">wxString</a>& default_path = "", const <a href="#wxString">wxString</a>& default_filename = "", const <a href="#wxString">wxString</a>& default_extension = "", const <a href="#wxString">wxString</a>& wildcard = "*.*", int flags = 0, <a href="#wxWindow">wxWindow</a> *parent = NULL, int x = -1, int y = -1)</font><br> *************** *** 8768,8772 **** <i>%include</i> "wx/filedlg.h"<br> <br> ! <font color=#006666><i>%define_string</i> wxFileSelectorPromptStr</font><br> <font color=#006666><i>%define_string</i> wxFileSelectorDefaultWildcardStr</font><br> <br> --- 8933,8937 ---- <i>%include</i> "wx/filedlg.h"<br> <br> ! <font color=#006666><i>%define_string</i> wxFileSelectorPromptStr wxT("Select a file")</font><br> <font color=#006666><i>%define_string</i> wxFileSelectorDefaultWildcardStr</font><br> <br> *************** *** 14337,14341 **** <font color=#009900>//void DisplayContents() - see <a href="#wxHelpControllerBase">wxHelpControllerBase</a></font><br> void DisplayIndex()<br> ! bool KeywordSearch(const <a href="#wxString">wxString</a>& keyword, <a href="#wxHelpSearchMode">wxHelpSearchMode</a> mode = wxHELP_SEARCH_ALL)<br> void ReadCustomization(<a href="#wxConfigBase">wxConfigBase</a>* cfg, <a href="#wxString">wxString</a> path = "")<br> void SetTempDir(const <a href="#wxString">wxString</a>& path)<br> --- 14502,14506 ---- <font color=#009900>//void DisplayContents() - see <a href="#wxHelpControllerBase">wxHelpControllerBase</a></font><br> void DisplayIndex()<br> ! <font color=#009900>// bool KeywordSearch(const <a href="#wxString">wxString</a>& keyword, <a href="#wxHelpSearchMode">wxHelpSearchMode</a> mode = wxHELP_SEARCH_ALL) // see base</font><br> void ReadCustomization(<a href="#wxConfigBase">wxConfigBase</a>* cfg, <a href="#wxString">wxString</a> path = "")<br> void SetTempDir(const <a href="#wxString">wxString</a>& path)<br> |