Menu
▾
▴
[Wxlua-commit] wxLua/docs binding.html, 1.12, 1.13 wxluaref.html, 1.12, 1.13
|
From: John L. <jr...@us...> - 2007-02-06 04:18:18
|
Update of /cvsroot/wxlua/wxLua/docs In directory sc8-pr-cvs9.sourceforge.net:/tmp/cvs-serv24793/wxLua/docs Modified Files: binding.html wxluaref.html Log Message: cleanup in genwxbind.lua remove whitespace in generated files Index: wxluaref.html =================================================================== RCS file: /cvsroot/wxlua/wxLua/docs/wxluaref.html,v retrieving revision 1.12 retrieving revision 1.13 diff -C2 -d -r1.12 -r1.13 *** wxluaref.html 19 Dec 2006 06:18:02 -0000 1.12 --- wxluaref.html 6 Feb 2007 04:17:41 -0000 1.13 *************** *** 1723,1726 **** --- 1723,1729 ---- //void* GetClientData(int n) const<br> <a href="#wxClientData">wxClientData</a>* GetClientObject(int n) const<br> + // Get the <a href="#wxStringClientData">wxStringClientData</a> if and only if you have called SetClientObject with a <a href="#wxStringClientData">wxStringClientData</a><br> + <font color=#CC3300> // <i>%override</i> <i>%rename</i> GetStringClientObject <a href="#wxStringClientData">wxStringClientData</a>* GetClientObject(int n) const</font><br> + <font color=#CC0033> <i>%rename</i> GetStringClientObject <a href="#wxStringClientData">wxStringClientData</a>* GetClientObject(int n) const</font><br> int GetCount() const<br> int GetSelection() const<br> *************** *** 3335,3339 **** // <a href="#wxDateTime">wxDateTime</a><br> <br> ! <i>%if</i> wxLUA_USE_wxDateTime<br> <br> <i>%include</i> "wx/datetime.h"<br> --- 3338,3342 ---- // <a href="#wxDateTime">wxDateTime</a><br> <br> ! <i>%if</i> wxLUA_USE_wxDateTime & wxUSE_DATETIME<br> <br> <i>%include</i> "wx/datetime.h"<br> *************** *** 3535,3544 **** </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxDateTime<br> <br> //-----------------------------------------------------------------------------<br> // <a href="#wxTimeSpan">wxTimeSpan</a><br> <br> ! <i>%if</i> wxLUA_USE_wxTimeSpan<br> <br> <i>%include</i> "wx/datetime.h"<br> --- 3538,3547 ---- </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxDateTime & wxUSE_DATETIME<br> <br> //-----------------------------------------------------------------------------<br> // <a href="#wxTimeSpan">wxTimeSpan</a><br> <br> ! <i>%if</i> wxLUA_USE_wxTimeSpan & wxUSE_DATETIME<br> <br> <i>%include</i> "wx/datetime.h"<br> *************** *** 3585,3594 **** </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxTimeSpan<br> <br> //-----------------------------------------------------------------------------<br> // <a href="#wxDateSpan">wxDateSpan</a><br> <br> ! <i>%if</i> wxLUA_USE_wxDateSpan<br> <br> <i>%include</i> "wx/datetime.h"<br> --- 3588,3597 ---- </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxTimeSpan & wxUSE_DATETIME<br> <br> //-----------------------------------------------------------------------------<br> // <a href="#wxDateSpan">wxDateSpan</a><br> <br> ! <i>%if</i> wxLUA_USE_wxDateSpan & wxUSE_DATETIME<br> <br> <i>%include</i> "wx/datetime.h"<br> *************** *** 3629,3638 **** </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxDateSpan<br> <br> //-----------------------------------------------------------------------------<br> // <a href="#wxDateTimeHolidayAuthority">wxDateTimeHolidayAuthority</a><br> <br> ! <i>%if</i> wxLUA_USE_wxDateTimeHolidayAuthority<br> <br> <font color=#AA0000><font size=+1><i>%class</i> <i>%noclassinfo</i> <i>%encapsulate</i> <b><a name="wxDateTimeHolidayAuthority">wxDateTimeHolidayAuthority</a></b></font></font><blockquote> --- 3632,3641 ---- </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxDateSpan & wxUSE_DATETIME<br> <br> //-----------------------------------------------------------------------------<br> // <a href="#wxDateTimeHolidayAuthority">wxDateTimeHolidayAuthority</a><br> <br> ! <i>%if</i> wxLUA_USE_wxDateTimeHolidayAuthority & wxUSE_DATETIME<br> <br> <font color=#AA0000><font size=+1><i>%class</i> <i>%noclassinfo</i> <i>%encapsulate</i> <b><a name="wxDateTimeHolidayAuthority">wxDateTimeHolidayAuthority</a></b></font></font><blockquote> *************** *** 3653,3662 **** </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxDateTimeHolidayAuthority<br> <br> //-----------------------------------------------------------------------------<br> // <a href="#wxTimer">wxTimer</a><br> <br> ! <i>%if</i> wxLUA_USE_wxTimer<br> <br> <i>%include</i> "wx/timer.h"<br> --- 3656,3665 ---- </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxDateTimeHolidayAuthority & wxUSE_DATETIME<br> <br> //-----------------------------------------------------------------------------<br> // <a href="#wxTimer">wxTimer</a><br> <br> ! <i>%if</i> wxLUA_USE_wxTimer & wxUSE_TIMER<br> <br> <i>%include</i> "wx/timer.h"<br> *************** *** 3688,3697 **** </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxTimer<br> <br> //-----------------------------------------------------------------------------<br> // <a href="#wxCalendarCtrl">wxCalendarCtrl</a><br> <br> ! <i>%if</i> wxLUA_USE_wxCalendarCtrl<br> <br> <i>%include</i> "wx/calctrl.h"<br> --- 3691,3700 ---- </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxTimer & wxUSE_TIMER<br> <br> //-----------------------------------------------------------------------------<br> // <a href="#wxCalendarCtrl">wxCalendarCtrl</a><br> <br> ! <i>%if</i> wxLUA_USE_wxCalendarCtrl & wxUSE_CALENDARCTRL<br> <br> <i>%include</i> "wx/calctrl.h"<br> *************** *** 3825,3834 **** </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxCalendarCtrl<br> <br> //-----------------------------------------------------------------------------<br> // <a href="#wxDatePickerCtrl">wxDatePickerCtrl</a><br> <br> ! <i>%if</i> wxLUA_USE_wxDatePickerCtrl<br> <br> <i>%include</i> "wx/datectrl.h"<br> --- 3828,3837 ---- </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxCalendarCtrl & wxUSE_CALENDARCTRL<br> <br> //-----------------------------------------------------------------------------<br> // <a href="#wxDatePickerCtrl">wxDatePickerCtrl</a><br> <br> ! <i>%if</i> wxLUA_USE_wxDatePickerCtrl & wxUSE_DATEPICKCTRL<br> <br> <i>%include</i> "wx/datectrl.h"<br> *************** *** 3853,3857 **** </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxDatePickerCtrl<br> <br> <HR> --- 3856,3860 ---- </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> ! <i>%endif</i> //wxLUA_USE_wxDatePickerCtrl & wxUSE_DATEPICKCTRL<br> <br> <HR> *************** *** 7470,7491 **** <br> <font color=#AA0000><font size=+1><i>%class</i> <b><a name="wxGLCanvas">wxGLCanvas</a></b>, <a href="#wxWindow">wxWindow</a></font></font><blockquote> <a href="#wxGLCanvas">wxGLCanvas</a>(<a href="#wxWindow">wxWindow</a>* parent, wxWindowID id = wxID_ANY, const <a href="#wxPoint">wxPoint</a>& pos = wxDefaultPosition, const <a href="#wxSize">wxSize</a>& size = wxDefaultSize, long style=0, const <a href="#wxString">wxString</a>& name="wxGLCanvas", int attribList[] = 0, const <a href="#wxPalette">wxPalette</a>& palette = wxNullPalette)<br> <i>%constructor</i> wxGLCanvasFromContext <a href="#wxGLCanvas">wxGLCanvas</a>(<a href="#wxWindow">wxWindow</a>* parent, <a href="#wxGLContext">wxGLContext</a>* sharedContext, wxWindowID id = wxID_ANY, const <a href="#wxPoint">wxPoint</a>& pos = wxDefaultPosition, const <a href="#wxSize">wxSize</a>& size = wxDefaultSize, long style=0, const <a href="#wxString">wxString</a>& name="wxGLCanvas", int attribList[] = 0, const <a href="#wxPalette">wxPalette</a>& palette = wxNullPalette)<br> ! <i>%constructor</i> wxGLCanvasFromCCanvas <a href="#wxGLCanvas">wxGLCanvas</a>(<a href="#wxWindow">wxWindow</a>* parent, <a href="#wxGLCanvas">wxGLCanvas</a>* sharedCanvas, wxWindowID id = wxID_ANY, const <a href="#wxPoint">wxPoint</a>& pos = wxDefaultPosition, const <a href="#wxSize">wxSize</a>& size = wxDefaultSize, long style=0, const <a href="#wxString">wxString</a>& name="wxGLCanvas", int attribList[] = 0, const <a href="#wxPalette">wxPalette</a>& palette = wxNullPalette)<br> <br> ! <a href="#wxGLContext">wxGLContext</a>* GetContext()<br> void SetCurrent()<br> void SetColour(const <a href="#wxString">wxString</a>& colour)<br> void SwapBuffers()<br> </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> <font color=#AA0000><font size=+1><i>%class</i> <b><a name="wxGLContext">wxGLContext</a></b>, <a href="#wxObject">wxObject</a></font></font><blockquote> ! <a href="#wxGLContext">wxGLContext</a>(bool isRGB, <a href="#wxGLCanvas">wxGLCanvas</a>* win, const <a href="#wxPalette">wxPalette</a>& palette = wxNullPalette)<br> ! <i>%constructor</i> wxGLContextOther <a href="#wxGLContext">wxGLContext</a>(bool isRGB, <a href="#wxGLCanvas">wxGLCanvas</a>* win, const <a href="#wxPalette">wxPalette</a>& palette = wxNullPalette, const <a href="#wxGLContext">wxGLContext</a>* other)<br> <br> - const <a href="#wxWindow">wxWindow</a>* GetWindow()<br> - void SetCurrent()<br> - void SetColour(const <a href="#wxString">wxString</a>& colour)<br> - void SwapBuffers()<br> </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> --- 7473,7505 ---- <br> <font color=#AA0000><font size=+1><i>%class</i> <b><a name="wxGLCanvas">wxGLCanvas</a></b>, <a href="#wxWindow">wxWindow</a></font></font><blockquote> + <font color=#CC3300> // <i>%override</i> Note: attribList[] parameter is a lua table with integer indexes</font><br> <a href="#wxGLCanvas">wxGLCanvas</a>(<a href="#wxWindow">wxWindow</a>* parent, wxWindowID id = wxID_ANY, const <a href="#wxPoint">wxPoint</a>& pos = wxDefaultPosition, const <a href="#wxSize">wxSize</a>& size = wxDefaultSize, long style=0, const <a href="#wxString">wxString</a>& name="wxGLCanvas", int attribList[] = 0, const <a href="#wxPalette">wxPalette</a>& palette = wxNullPalette)<br> <i>%constructor</i> wxGLCanvasFromContext <a href="#wxGLCanvas">wxGLCanvas</a>(<a href="#wxWindow">wxWindow</a>* parent, <a href="#wxGLContext">wxGLContext</a>* sharedContext, wxWindowID id = wxID_ANY, const <a href="#wxPoint">wxPoint</a>& pos = wxDefaultPosition, const <a href="#wxSize">wxSize</a>& size = wxDefaultSize, long style=0, const <a href="#wxString">wxString</a>& name="wxGLCanvas", int attribList[] = 0, const <a href="#wxPalette">wxPalette</a>& palette = wxNullPalette)<br> ! <i>%constructor</i> wxGLCanvasFromCanvas <a href="#wxGLCanvas">wxGLCanvas</a>(<a href="#wxWindow">wxWindow</a>* parent, <a href="#wxGLCanvas">wxGLCanvas</a>* sharedCanvas, wxWindowID id = wxID_ANY, const <a href="#wxPoint">wxPoint</a>& pos = wxDefaultPosition, const <a href="#wxSize">wxSize</a>& size = wxDefaultSize, long style=0, const <a href="#wxString">wxString</a>& name="wxGLCanvas", int attribList[] = 0, const <a href="#wxPalette">wxPalette</a>& palette = wxNullPalette)<br> <br> ! <a href="#wxGLContext">wxGLContext</a>* GetContext() const<br> void SetCurrent()<br> + <font color=#CC0033> <i>%wxchkver28</i> <i>%rename</i> SetCurrentContext void SetCurrent(const <a href="#wxGLContext">wxGLContext</a>& RC) const</font><br> void SetColour(const <a href="#wxString">wxString</a>& colour)<br> void SwapBuffers()<br> </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> + <br> <font color=#AA0000><font size=+1><i>%class</i> <b><a name="wxGLContext">wxGLContext</a></b>, <a href="#wxObject">wxObject</a></font></font><blockquote> ! // for <= 2.6<br> ! !<i>%wxchkver28</i> <a href="#wxGLContext">wxGLContext</a>(bool isRGB, <a href="#wxGLCanvas">wxGLCanvas</a>* win, const <a href="#wxPalette">wxPalette</a>& palette = wxNullPalette)<br> ! !<i>%wxchkver28</i> <i>%constructor</i> wxGLContextOther <a href="#wxGLContext">wxGLContext</a>(bool isRGB, <a href="#wxGLCanvas">wxGLCanvas</a>* win, const <a href="#wxPalette">wxPalette</a>& palette = wxNullPalette, const <a href="#wxGLContext">wxGLContext</a>* other)<br> ! <br> ! !<i>%wxchkver28</i> const <a href="#wxWindow">wxWindow</a>* GetWindow()<br> ! !<i>%wxchkver28</i> void SetCurrent()<br> ! !<i>%wxchkver28</i> void SetColour(const <a href="#wxString">wxString</a>& colour)<br> ! !<i>%wxchkver28</i> void SwapBuffers()<br> ! <br> ! // for >= 2.8<br> ! <br> ! <i>%wxchkver28</i> <a href="#wxGLContext">wxGLContext</a>(<a href="#wxGLCanvas">wxGLCanvas</a> *win, const <a href="#wxGLContext">wxGLContext</a>* other = NULL )<br> ! <br> ! <i>%wxchkver28</i> void SetCurrent(const <a href="#wxGLCanvas">wxGLCanvas</a>& win) const<br> <br> </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> *************** *** 7547,7554 **** <i>%static</i> int GetFromWindow(<a href="#wxWindow">wxWindow</a>* win)<br> <a href="#wxRect">wxRect</a> GetGeometry() const<br> ! <a href="#wxRect">wxRect</a> GetClientArea() const<br> <a href="#wxArrayVideoModes">wxArrayVideoModes</a> GetModes(const <a href="#wxVideoMode">wxVideoMode</a>& mode = wxDefaultVideoMode) const<br> <a href="#wxString">wxString</a> GetName() const<br> ! bool IsOk() const<br> bool IsPrimary()<br> </blockquote><font color=#AA0000><i>%endclass</i></font><br> --- 7561,7568 ---- <i>%static</i> int GetFromWindow(<a href="#wxWindow">wxWindow</a>* win)<br> <a href="#wxRect">wxRect</a> GetGeometry() const<br> ! <i>%wxchkver_2_8</i> <a href="#wxRect">wxRect</a> GetClientArea() const<br> <a href="#wxArrayVideoModes">wxArrayVideoModes</a> GetModes(const <a href="#wxVideoMode">wxVideoMode</a>& mode = wxDefaultVideoMode) const<br> <a href="#wxString">wxString</a> GetName() const<br> ! bool IsOk() const<br> bool IsPrimary()<br> </blockquote><font color=#AA0000><i>%endclass</i></font><br> *************** *** 13042,13046 **** --- 13056,13074 ---- <br> <a href="#wxLuaObject">wxLuaObject</a> *GetID()<br> + <br> + // This is an added function to <a href="#wxPrintout">wxPrintout</a> so you don't have to override GetPageInfo<br> void SetPageInfo(int minPage, int maxPage, int pageFrom = 0, int pageTo = 0)<br> + <br> + // The functions below are all virtual functions that you can override in lua.<br> + // See the printing sample and <a href="#wxPrintout">wxPrintout</a> for proper parameters and usage.<br> + //void GetPageInfo(int *minPage, int *maxPage, int *pageFrom, int *pageTo)<br> + //bool HasPage(int pageNum)<br> + //bool OnBeginDocument(int startPage, int endPage)<br> + //void OnEndDocument()<br> + //void OnBeginPrinting()<br> + //void OnEndPrinting()<br> + //void OnPreparePrinting()<br> + //bool OnPrintPage(int pageNum)<br> + <br> </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> *************** *** 13056,13059 **** --- 13084,13095 ---- <font color=#AA0000><font size=+1><i>%class</i> <b><a name="wxLuaHtmlWindow">wxLuaHtmlWindow</a></b>, <a href="#wxHtmlWindow">wxHtmlWindow</a></font></font><blockquote> <a href="#wxLuaHtmlWindow">wxLuaHtmlWindow</a>(<a href="#wxWindow">wxWindow</a> *parent, wxWindowID id = -1, const <a href="#wxPoint">wxPoint</a>& pos = wxDefaultPosition, const <a href="#wxSize">wxSize</a>& size = wxDefaultSize, long style = wxHW_SCROLLBAR_AUTO, const <a href="#wxString">wxString</a>& name = "wxLuaHtmlWindow")<br> + <br> + // The functions below are all virtual functions that you can override in lua.<br> + // See the html sample and <a href="#wxHtmlWindow">wxHtmlWindow</a> for proper parameters and usage.<br> + //bool OnCellClicked(<a href="#wxHtmlCell">wxHtmlCell</a> *cell, wxCoord x, wxCoord y, const <a href="#wxMouseEvent">wxMouseEvent</a>& event)<br> + //void OnCellMouseHover(<a href="#wxHtmlCell">wxHtmlCell</a> *cell, wxCoord x, wxCoord y)<br> + //void OnLinkClicked(const <a href="#wxHtmlLinkInfo">wxHtmlLinkInfo</a>& link)<br> + //void OnSetTitle(const <a href="#wxString">wxString</a>& title)<br> + <br> </blockquote><font color=#AA0000><i>%endclass</i></font><br> <br> Index: binding.html =================================================================== RCS file: /cvsroot/wxlua/wxLua/docs/binding.html,v retrieving revision 1.12 retrieving revision 1.13 diff -C2 -d -r1.12 -r1.13 *** binding.html 4 Dec 2006 05:54:40 -0000 1.12 --- binding.html 6 Feb 2007 04:17:41 -0000 1.13 *************** *** 88,92 **** actual lua programs that <i>genwxbind.lua</i> runs before processing the interface files, but after it has created ! various structures used for parsing allowing for customization. </li> <li style="text-align: justify;">Command line usage of --- 88,93 ---- actual lua programs that <i>genwxbind.lua</i> runs before processing the interface files, but after it has created ! various structures used for parsing allowing for ! customization.</li> <li style="text-align: justify;">Command line usage of *************** *** 235,239 **** <li>A single header file is generated that typically does not have to be included by any files other than those generated by the ! bindings. </li> <ul> --- 236,240 ---- <li>A single header file is generated that typically does not have to be included by any files other than those generated by the ! bindings.</li> <ul> *************** *** 245,249 **** <li>The only function that absolutely must be called is ! wxLuaBinding_[hook_cpp_binding_classname]_init(). It is probably easiest to put <i>extern bool wxLuaBinding_[hook_cpp_binding_classname]_init();</i> in your --- 246,250 ---- <li>The only function that absolutely must be called is ! <b>wxLuaBinding_[hook_cpp_binding_classname]_init()</b>. It is probably easiest to put <i>extern bool wxLuaBinding_[hook_cpp_binding_classname]_init();</i> in your *************** *** 255,259 **** wxLuaBinding derived class that is put into a static wxList of bindings. There should only be one of the binding classes created as ! they all share the same structures anyway. </li> <li><i>static wxLuaBindingList* --- 256,260 ---- wxLuaBinding derived class that is put into a static wxList of bindings. There should only be one of the binding classes created as ! they all share the same structures anyway.</li> <li><i>static wxLuaBindingList* *************** *** 482,487 **** you must use %class ... ns::ClassName and the constructor must also be ! ns::ClassName. ! </li> <li><i><b>%delete</b></i> is for --- 483,487 ---- you must use %class ... ns::ClassName and the constructor must also be ! ns::ClassName. </li> <li><i><b>%delete</b></i> is for *************** *** 744,749 **** functions will be named Get_m_x() and Set_m_x(int x) therefore it is recommended that ! you use ! <i>%rename</i> in conjunction with <i>%member</i>. </li> <li>For example, in wxPoint <i>"%rename X --- 744,749 ---- functions will be named Get_m_x() and Set_m_x(int x) therefore it is recommended that ! you use <i>%rename</i> in conjunction with <i>%member</i>. ! </li> <li>For example, in wxPoint <i>"%rename X *************** *** 967,971 **** </ul> - <i><b>%static var_type ClassMemberFunction(...)</b></i><br> --- 967,970 ---- *************** *** 1040,1044 **** <ul> ! <li>The next item will be <i>#if wxCHECK_VERSION(X,Y,Z).</i> </li> <li>The Y and Z parameters are optional and default to 0.</li> --- 1039,1044 ---- <ul> ! <li>The next item will be <i>#if wxCHECK_VERSION(X,Y,Z).</i> ! </li> <li>The Y and Z parameters are optional and default to 0.</li> *************** *** 1053,1057 **** <li>The next item will be <i>#if ! (defined(WXWIN_COMPATIBILITY_X_Y</i>) && <i>WXWIN_COMPATIBILITY_X_Y)</i>. </li> <li>The tags are defined for --- 1053,1058 ---- <li>The next item will be <i>#if ! (defined(WXWIN_COMPATIBILITY_X_Y</i>) && <i>WXWIN_COMPATIBILITY_X_Y)</i>. ! </li> <li>The tags are defined for *************** *** 1066,1070 **** <li>The next item will be <i>#if ! (defined(WXWIN_COMPATIBILITY_X_Y</i>) && <i>WXWIN_COMPATIBILITY_X_Y)</i>. </li> <li>The rest of the string beyond "%wxcompat" is appended to --- 1067,1072 ---- <li>The next item will be <i>#if ! (defined(WXWIN_COMPATIBILITY_X_Y</i>) && <i>WXWIN_COMPATIBILITY_X_Y)</i>. ! </li> <li>The rest of the string beyond "%wxcompat" is appended to |
