From 5c5a3c4130ce1db30aeba7a40f02dc76377b69cf Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Sat, 5 Jan 2002 23:16:44 +0000 Subject: [PATCH] Added bone structure for Gizmos docs git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@13396 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- contrib/docs/latex/gizmos/back.gif | Bin 0 -> 978 bytes contrib/docs/latex/gizmos/body.tex | 10 ++ contrib/docs/latex/gizmos/books.bmp | Bin 0 -> 1222 bytes contrib/docs/latex/gizmos/books.gif | Bin 0 -> 440 bytes contrib/docs/latex/gizmos/bullet.bmp | Bin 0 -> 198 bytes contrib/docs/latex/gizmos/category.tex | 30 ++++ contrib/docs/latex/gizmos/classes.tex | 19 +++ contrib/docs/latex/gizmos/contents.gif | Bin 0 -> 996 bytes .../latex/gizmos/dynamicsashsplitevent.tex | 39 +++++ .../latex/gizmos/dynamicsashunifyevent.tex | 42 +++++ .../docs/latex/gizmos/dynamicsashwindow.tex | 54 +++++++ contrib/docs/latex/gizmos/editablelistbox.tex | 70 +++++++++ contrib/docs/latex/gizmos/forward.gif | Bin 0 -> 959 bytes contrib/docs/latex/gizmos/lednumberctrl.tex | 68 +++++++++ contrib/docs/latex/gizmos/makefile.vc | 107 +++++++++++++ contrib/docs/latex/gizmos/manual.tex | 75 +++++++++ contrib/docs/latex/gizmos/multicellcanvas.tex | 57 +++++++ .../docs/latex/gizmos/multicellitemhandle.tex | 78 ++++++++++ contrib/docs/latex/gizmos/multicellsizer.tex | 74 +++++++++ contrib/docs/latex/gizmos/readme.txt | 116 ++++++++++++++ contrib/docs/latex/gizmos/refs.bib | 59 ++++++++ .../latex/gizmos/remotelyscrolledtreectrl.tex | 143 ++++++++++++++++++ contrib/docs/latex/gizmos/shelves.bmp | Bin 0 -> 630 bytes .../latex/gizmos/splitterscrolledwindow.tex | 42 +++++ contrib/docs/latex/gizmos/tex2rtf.ini | 46 ++++++ .../docs/latex/gizmos/thinsplitterwindow.tex | 54 +++++++ contrib/docs/latex/gizmos/topics.tex | 8 + .../docs/latex/gizmos/treecompanionwindow.tex | 63 ++++++++ contrib/docs/latex/gizmos/tusage.tex | 22 +++ contrib/docs/latex/gizmos/up.gif | Bin 0 -> 998 bytes 30 files changed, 1276 insertions(+) create mode 100644 contrib/docs/latex/gizmos/back.gif create mode 100644 contrib/docs/latex/gizmos/body.tex create mode 100644 contrib/docs/latex/gizmos/books.bmp create mode 100644 contrib/docs/latex/gizmos/books.gif create mode 100644 contrib/docs/latex/gizmos/bullet.bmp create mode 100644 contrib/docs/latex/gizmos/category.tex create mode 100644 contrib/docs/latex/gizmos/classes.tex create mode 100644 contrib/docs/latex/gizmos/contents.gif create mode 100644 contrib/docs/latex/gizmos/dynamicsashsplitevent.tex create mode 100644 contrib/docs/latex/gizmos/dynamicsashunifyevent.tex create mode 100644 contrib/docs/latex/gizmos/dynamicsashwindow.tex create mode 100644 contrib/docs/latex/gizmos/editablelistbox.tex create mode 100644 contrib/docs/latex/gizmos/forward.gif create mode 100644 contrib/docs/latex/gizmos/lednumberctrl.tex create mode 100644 contrib/docs/latex/gizmos/makefile.vc create mode 100644 contrib/docs/latex/gizmos/manual.tex create mode 100644 contrib/docs/latex/gizmos/multicellcanvas.tex create mode 100644 contrib/docs/latex/gizmos/multicellitemhandle.tex create mode 100644 contrib/docs/latex/gizmos/multicellsizer.tex create mode 100644 contrib/docs/latex/gizmos/readme.txt create mode 100644 contrib/docs/latex/gizmos/refs.bib create mode 100644 contrib/docs/latex/gizmos/remotelyscrolledtreectrl.tex create mode 100644 contrib/docs/latex/gizmos/shelves.bmp create mode 100644 contrib/docs/latex/gizmos/splitterscrolledwindow.tex create mode 100644 contrib/docs/latex/gizmos/tex2rtf.ini create mode 100644 contrib/docs/latex/gizmos/thinsplitterwindow.tex create mode 100644 contrib/docs/latex/gizmos/topics.tex create mode 100644 contrib/docs/latex/gizmos/treecompanionwindow.tex create mode 100644 contrib/docs/latex/gizmos/tusage.tex create mode 100644 contrib/docs/latex/gizmos/up.gif diff --git a/contrib/docs/latex/gizmos/back.gif b/contrib/docs/latex/gizmos/back.gif new file mode 100644 index 0000000000000000000000000000000000000000..88a3740f9134d7a569b56a9f76e6aa552672993e GIT binary patch literal 978 zcmZ?wbhEHbbYM_m_|5fj;(a}CV`%O8V#mmmJDyQBv znOUrUdY)b7H6AG;jlf>Rey!M3TUK6P?i!m{q7|$j(iU2nb+j@t;aY#t_B`I%AGL2Z zO6>3Q?Jm>3v>|kImhI|mtHW1|tWDEBQI>amZ`s68xzaas@2+e3%;$D{>W3T0V&ot1 Q_1d}V>FF7|>?{n{02fm-00000 literal 0 HcmV?d00001 diff --git a/contrib/docs/latex/gizmos/body.tex b/contrib/docs/latex/gizmos/body.tex new file mode 100644 index 0000000000..05ff33a594 --- /dev/null +++ b/contrib/docs/latex/gizmos/body.tex @@ -0,0 +1,10 @@ +\chapter{Introduction}\label{introduction} +\pagenumbering{arabic}% +\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% +\setfooter{\thepage}{}{}{}{}{\thepage}% + +\section{What is the Gizmos library?} + +This manual describes a class library with a miscellany of useful user interface +classes. + diff --git a/contrib/docs/latex/gizmos/books.bmp b/contrib/docs/latex/gizmos/books.bmp new file mode 100644 index 0000000000000000000000000000000000000000..cf1e148734c807052ec6359ad2eb1a3e8d43d43d GIT binary patch literal 1222 zcmb7?v2KGf5Qg0-f^PH?BCA8E<{c_a$x@Y}nZr;qXR5NnfE2boQZn^-S4x_%j?%%`Rfz!C$uHnGuoYEAr~D;JxHUzQYZhY(}{X$xY0SE&#JC# z5a%D|9QDv}6Qc3-Wv8+GlQ-*8<`8epNC>=NSLPUH1b$st*H{R=IXD*!fgA8x5Dt6l zUCo=!AsqI8={C$E9QGLr_q_i zFK;h=LxQhf>;v~gWIyoy(Zu$`w=UNZZuYl$t>-8&*n94Z?RTzqLWjlGhdMVK;w1@P zgX#l^|MHTQ1q9k0=J>%Sz9`L#Hix;bEVz#^(qoBse!qj(7b literal 0 HcmV?d00001 diff --git a/contrib/docs/latex/gizmos/books.gif b/contrib/docs/latex/gizmos/books.gif new file mode 100644 index 0000000000000000000000000000000000000000..118aa0a8192c37c9bb6485f20b5ade0301fc555e GIT binary patch literal 440 zcmZ?wbhEHb)MwCR*vtR|`@wiWnA#8I?caakz=4K_hW|kE{|x`Z6p#k8fI#sl3nK#q zCxZ@1C&&y2mVX8(Jy-9wczt&F{{)Rb#iUs&Tr&LJOCH~{JHXw%N&7~5_y9%j zG##3Iq2kfk84Y4ZJF6Aem?k-iT~*BvTX}G0(OJHO$CKGvB#xbD-er4t@BKUrA2;nE ze>1ZyD=OGISUNZ?a_bvB%gQS|Sc=-aWgPvJ11cY%Z&0_y`>Bt>r4U{PqRC)V$Le3UB`FFw(r|Cai!zh6DKa6WZ5XW zeC0*A%g^^-uc&{Tb?5p0hvJW)-hKA&+m)qKGdpxXBxLMp{_Zu?BH_V5R-PB{xa>-< z{!ldecz*Wwa{kAi%t@Y#j#6oSx}UmUC z{=?pL4d3s4p literal 0 HcmV?d00001 diff --git a/contrib/docs/latex/gizmos/category.tex b/contrib/docs/latex/gizmos/category.tex new file mode 100644 index 0000000000..8484135622 --- /dev/null +++ b/contrib/docs/latex/gizmos/category.tex @@ -0,0 +1,30 @@ +\chapter{Classes by category}\label{classesbycat} +\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% +\setfooter{\thepage}{}{}{}{}{\thepage}% + +A classification of Gizmos classes by category. +\twocolwidtha{5cm} + +\begin{comment} +{\large {\bf Service classes}} + +\overview{wxMPService class overview}{wxmpserviceoverview} + +Service classes reduce the diversity of PMF classes, by making +them comply to a common interface. A service class serves as an interface (or +mix-in class in C++ terms), which cannot itself represent an +independent object. It should be inherited as a second (or +third) base class. + +Derived services classes all derive from wxEvtHandler as well as +wxPMService. + +\begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxPMService}{wxpmservice}}{Base class} +\twocolitem{\helpref{wxPMBootstrapService}{wxpmbootstrapservice}}{Boot strap service} +\twocolitem{\helpref{wxPMLAlgorithm}{wxpmlalgorithm}}{Layout algorithm service} +\twocolitem{\helpref{wxPMSashLayoutAlgorithm}{wxpmsashlayoutalgorithm}}{Sash layout algorithm service} +\twocolitem{\helpref{wxPMPane}{wxpmpane}}{Base class for panes lying outside the MDI client area} +\end{twocollist} +\end{comment} + diff --git a/contrib/docs/latex/gizmos/classes.tex b/contrib/docs/latex/gizmos/classes.tex new file mode 100644 index 0000000000..20edd1e691 --- /dev/null +++ b/contrib/docs/latex/gizmos/classes.tex @@ -0,0 +1,19 @@ +\chapter{Alphabetical class reference}\label{classref} +\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% +\setfooter{\thepage}{}{}{}{}{\thepage}% + +% NB: the files should be in alphabetic order of the classes documented in +% them and *not* in alphabetic order of the file names! + +\input dynamicsashsplitevent.tex +\input dynamicsashunifyevent.tex +\input dynamicsashwindow.tex +\input editablelistbox.tex +\input lednumberctrl.tex +\input multicellcanvas.tex +\input multicellitemhandle.tex +\input multicellsizer.tex +\input remotelyscrolledtreectrl.tex +\input splitterscrolledwindow.tex +\input thinsplitterwindow.tex +\input treecompanionwindow.tex diff --git a/contrib/docs/latex/gizmos/contents.gif b/contrib/docs/latex/gizmos/contents.gif new file mode 100644 index 0000000000000000000000000000000000000000..723174f81d04d16e94016186ac0322dcddb603c7 GIT binary patch literal 996 zcmZ?wbhEHbbYM_m_|5kxA zV8N1xh6Z3tW&ovR5Cxe34SwPCqkp^L+21?)C@%eigo zjb6XYK{ltit-ZayK=RQZsqlw)b_u-S7xTMFKYoAy)o)vOlz%vRFz5Xto6e7mgSU6F l8>#t(=cJr!`K{OHv%&EGv6=dhWPNvSd3kw-DjN%fH2`phKPvzL literal 0 HcmV?d00001 diff --git a/contrib/docs/latex/gizmos/dynamicsashsplitevent.tex b/contrib/docs/latex/gizmos/dynamicsashsplitevent.tex new file mode 100644 index 0000000000..6367cc84e9 --- /dev/null +++ b/contrib/docs/latex/gizmos/dynamicsashsplitevent.tex @@ -0,0 +1,39 @@ +% +% automatically generated by HelpGen $Revision$ from +% dynamicsash.h at 05/Jan/02 23:08:13 +% + + +\section{\class{wxDynamicSashSplitEvent}}\label{wxdynamicsashsplitevent} + + +wxDynamicSashSplitEvents are sent to your view by wxDynamicSashWindow + whenever your view is being split by the user. It is your + responsibility to handle this event by creating a new view window as + a child of the wxDynamicSashWindow. wxDynamicSashWindow will + automatically reparent it to the proper place in its window hierarchy. + +\wxheading{Derived from} + +\helpref{wxCommandEvent}{wxcommandevent} + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxDynamicSashSplitEvent::wxDynamicSashSplitEvent}\label{wxdynamicsashspliteventwxdynamicsashsplitevent} + +\func{}{wxDynamicSashSplitEvent}{\param{const wxDynamicSashSplitEvent\& }{event}} + + +\func{}{wxDynamicSashSplitEvent}{\param{wxObject* }{target}} + + +\func{}{wxDynamicSashSplitEvent}{\void} + + +\membersection{wxDynamicSashSplitEvent::Clone}\label{wxdynamicsashspliteventclone} + +\constfunc{wxEvent*}{Clone}{\void} + diff --git a/contrib/docs/latex/gizmos/dynamicsashunifyevent.tex b/contrib/docs/latex/gizmos/dynamicsashunifyevent.tex new file mode 100644 index 0000000000..1529dd8c99 --- /dev/null +++ b/contrib/docs/latex/gizmos/dynamicsashunifyevent.tex @@ -0,0 +1,42 @@ +% +% automatically generated by HelpGen $Revision$ from +% dynamicsash.h at 05/Jan/02 23:08:13 +% + + +\section{\class{wxDynamicSashUnifyEvent}}\label{wxdynamicsashunifyevent} + + +wxDynamicSashUnifyEvents are sent to your view by wxDynamicSashWindow + whenever the sash which splits your view and its sibling is being + reunified such that your view is expanding to replace its sibling. + You needn't do anything with this event if you are allowing + wxDynamicSashWindow to manage your view's scrollbars, but it is useful + if you are managing the scrollbars yourself so that you can keep + the scrollbars' event handlers connected to your view's event handler + class. + +\wxheading{Derived from} + +\helpref{wxCommandEvent}{wxcommandevent} + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxDynamicSashUnifyEvent::wxDynamicSashUnifyEvent}\label{wxdynamicsashunifyeventwxdynamicsashunifyevent} + +\func{}{wxDynamicSashUnifyEvent}{\param{const wxDynamicSashUnifyEvent\& }{event}} + + +\func{}{wxDynamicSashUnifyEvent}{\param{wxObject* }{target}} + + +\func{}{wxDynamicSashUnifyEvent}{\void} + + +\membersection{wxDynamicSashUnifyEvent::Clone}\label{wxdynamicsashunifyeventclone} + +\constfunc{wxEvent*}{Clone}{\void} + diff --git a/contrib/docs/latex/gizmos/dynamicsashwindow.tex b/contrib/docs/latex/gizmos/dynamicsashwindow.tex new file mode 100644 index 0000000000..039b5cacce --- /dev/null +++ b/contrib/docs/latex/gizmos/dynamicsashwindow.tex @@ -0,0 +1,54 @@ +% +% automatically generated by HelpGen $Revision$ from +% dynamicsash.h at 05/Jan/02 23:08:13 +% + + +\section{\class{wxDynamicSashWindow}}\label{wxdynamicsashwindow} + + +wxDynamicSashWindow. See above. + +\wxheading{Derived from} + +\helpref{wxWindow}{wxwindow} + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxDynamicSashWindow::wxDynamicSashWindow}\label{wxdynamicsashwindowwxdynamicsashwindow} + +\func{}{wxDynamicSashWindow}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long style = wxCLIP\_CHILDREN | wxDS\_MANAGE\_SCROLLBARS | }{wxDS\_DRAG\_CORNER}, \param{const wxString\& }{name = "dynamicSashWindow"}} + + +\func{}{wxDynamicSashWindow}{\void} + + +\membersection{wxDynamicSashWindow::\destruct{wxDynamicSashWindow}}\label{wxdynamicsashwindowdtor} + +\func{}{\destruct{wxDynamicSashWindow}}{\void} + + +\membersection{wxDynamicSashWindow::AddChild}\label{wxdynamicsashwindowaddchild} + +\func{void}{AddChild}{\param{wxWindowBase* }{child}} + +This is overloaded from wxWindowBase. It's not here for you to + call directly. + +\membersection{wxDynamicSashWindow::Create}\label{wxdynamicsashwindowcreate} + +\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long style = wxCLIP\_CHILDREN | wxDS\_MANAGE\_SCROLLBARS | }{wxDS\_DRAG\_CORNER}, \param{const wxString\& }{name = "dynamicSashWindow"}} + + +\membersection{wxDynamicSashWindow::GetHScrollBar}\label{wxdynamicsashwindowgethscrollbar} + +\constfunc{wxScrollBar*}{GetHScrollBar}{\param{const wxWindow* }{child}} + + +\membersection{wxDynamicSashWindow::GetVScrollBar}\label{wxdynamicsashwindowgetvscrollbar} + +\constfunc{wxScrollBar*}{GetVScrollBar}{\param{const wxWindow* }{child}} + diff --git a/contrib/docs/latex/gizmos/editablelistbox.tex b/contrib/docs/latex/gizmos/editablelistbox.tex new file mode 100644 index 0000000000..d993eaf533 --- /dev/null +++ b/contrib/docs/latex/gizmos/editablelistbox.tex @@ -0,0 +1,70 @@ +% +% automatically generated by HelpGen $Revision$ from +% editlbox.h at 05/Jan/02 23:08:13 +% + + +\section{\class{wxEditableListBox}}\label{wxeditablelistbox} + + +This class provides a composite control that lets the +user easily enter list of strings + +\wxheading{Derived from} + +\helpref{wxPanel}{wxpanel} + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxEditableListBox::wxEditableListBox}\label{wxeditablelistboxwxeditablelistbox} + +\func{}{wxEditableListBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{const wxString\& }{name = wxT("editableListBox")}} + + +\membersection{wxEditableListBox::GetStrings}\label{wxeditablelistboxgetstrings} + +\func{void}{GetStrings}{\param{wxArrayString\& }{strings}} + + +\membersection{wxEditableListBox::OnDelItem}\label{wxeditablelistboxondelitem} + +\func{void}{OnDelItem}{\param{wxCommandEvent\& }{event}} + + +\membersection{wxEditableListBox::OnDownItem}\label{wxeditablelistboxondownitem} + +\func{void}{OnDownItem}{\param{wxCommandEvent\& }{event}} + + +\membersection{wxEditableListBox::OnEditItem}\label{wxeditablelistboxonedititem} + +\func{void}{OnEditItem}{\param{wxCommandEvent\& }{event}} + + +\membersection{wxEditableListBox::OnEndLabelEdit}\label{wxeditablelistboxonendlabeledit} + +\func{void}{OnEndLabelEdit}{\param{wxListEvent\& }{event}} + + +\membersection{wxEditableListBox::OnItemSelected}\label{wxeditablelistboxonitemselected} + +\func{void}{OnItemSelected}{\param{wxListEvent\& }{event}} + + +\membersection{wxEditableListBox::OnNewItem}\label{wxeditablelistboxonnewitem} + +\func{void}{OnNewItem}{\param{wxCommandEvent\& }{event}} + + +\membersection{wxEditableListBox::OnUpItem}\label{wxeditablelistboxonupitem} + +\func{void}{OnUpItem}{\param{wxCommandEvent\& }{event}} + + +\membersection{wxEditableListBox::SetStrings}\label{wxeditablelistboxsetstrings} + +\func{void}{SetStrings}{\param{const wxArrayString\& }{strings}} + diff --git a/contrib/docs/latex/gizmos/forward.gif b/contrib/docs/latex/gizmos/forward.gif new file mode 100644 index 0000000000000000000000000000000000000000..d8862174ed264064e4092accd3b9cef539651ad1 GIT binary patch literal 959 zcmZ?wbhEHbbYM_m_|5NZ; wbH-jL-q~hvBDNIFUuAn+=ylY_lIO=twXW(!Y|OjPCFiqa!^6Y8%uEc{09+_1fB*mh literal 0 HcmV?d00001 diff --git a/contrib/docs/latex/gizmos/lednumberctrl.tex b/contrib/docs/latex/gizmos/lednumberctrl.tex new file mode 100644 index 0000000000..3fb75ad5b1 --- /dev/null +++ b/contrib/docs/latex/gizmos/lednumberctrl.tex @@ -0,0 +1,68 @@ +% +% automatically generated by HelpGen $Revision$ from +% ledctrl.h at 05/Jan/02 23:08:14 +% + + +\section{\class{wxLEDNumberCtrl}}\label{wxlednumberctrl} + + + +wxLEDNumberCtrl + + +\wxheading{Derived from} + +\helpref{wxControl}{wxcontrol} + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxLEDNumberCtrl::wxLEDNumberCtrl}\label{wxlednumberctrlwxlednumberctrl} + +\func{}{wxLEDNumberCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = -1}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long style = wxLED\_ALIGN\_LEFT | }{wxLED\_DRAW\_FADED}} + + +\func{}{wxLEDNumberCtrl}{\void} + +Constructors. + + +\membersection{wxLEDNumberCtrl::Create}\label{wxlednumberctrlcreate} + +\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = -1}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}} + +Create functions. + + +\membersection{wxLEDNumberCtrl::GetAlignment}\label{wxlednumberctrlgetalignment} + +\constfunc{wxLEDValueAlign}{GetAlignment}{\void} + + +\membersection{wxLEDNumberCtrl::GetDrawFaded}\label{wxlednumberctrlgetdrawfaded} + +\constfunc{bool}{GetDrawFaded}{\void} + + +\membersection{wxLEDNumberCtrl::GetValue}\label{wxlednumberctrlgetvalue} + +\constfunc{const wxString\&}{GetValue}{\void} + + +\membersection{wxLEDNumberCtrl::SetAlignment}\label{wxlednumberctrlsetalignment} + +\func{void}{SetAlignment}{\param{wxLEDValueAlign }{Alignment}, \param{bool }{Redraw = TRUE}} + + +\membersection{wxLEDNumberCtrl::SetDrawFaded}\label{wxlednumberctrlsetdrawfaded} + +\func{void}{SetDrawFaded}{\param{bool }{DrawFaded}, \param{bool }{Redraw = TRUE}} + + +\membersection{wxLEDNumberCtrl::SetValue}\label{wxlednumberctrlsetvalue} + +\func{void}{SetValue}{\param{const wxString\& }{Value}, \param{bool }{Redraw = TRUE}} + diff --git a/contrib/docs/latex/gizmos/makefile.vc b/contrib/docs/latex/gizmos/makefile.vc new file mode 100644 index 0000000000..e104b70db5 --- /dev/null +++ b/contrib/docs/latex/gizmos/makefile.vc @@ -0,0 +1,107 @@ +# File: makefile.vc +# Author: Julian Smart +# Created: 2002 +# Updated: +# Copyright: (c) 2002, Julian Smart +# +# "%W% %G%" +# +# Makefile : Builds documents using VC++ nmake +# + +WXDIR=$(WXWIN) +THISDIR=$(WXDIR)\contrib\docs\latex\gizmos +DOCDIR = $(WXDIR)\docs +WAITFLAG=/w + +docs: dirs winhelp html pdfrtf htb htmlhelp +winhelp: $(DOCDIR)/winhelp/gizmos.hlp +rtf: $(THISDIR)/latex/gizmos/gizmos.rtf +pdfrtf: $(DOCDIR)/pdf/gizmos.rtf +htb: $(DOCDIR)\htb\gizmos.htb +html: $(DOCDIR)\html\gizmos\gizmos.htm +htmlhelp: $(DOCDIR)\htmlhelp\gizmos.chm + +dirs: + -mkdir $(DOCDIR)\winhelp + -mkdir $(DOCDIR)\html + -mkdir $(DOCDIR)\html\gizmos + -mkdir $(DOCDIR)\htmlhelp + -mkdir $(DOCDIR)\htb + -mkdir $(DOCDIR)\pdf + +$(DOCDIR)/winhelp/gizmos.hlp: $(THISDIR)/gizmos.rtf $(THISDIR)/gizmos.hpj + cd $(THISDIR) + -erase gizmos.ph + hc gizmos + -erase $(DOCDIR)\winhelp\gizmos.hlp + -erase $(DOCDIR)\winhelp\gizmos.cnt + move gizmos.hlp $(DOCDIR)\winhelp\gizmos.hlp + move gizmos.cnt $(DOCDIR)\winhelp\gizmos.cnt + cd $(THISDIR) + +$(THISDIR)/gizmos.rtf: $(THISDIR)/classes.tex $(THISDIR)/body.tex $(THISDIR)/topics.tex $(THISDIR)/manual.tex + cd $(THISDIR) + -start $(WAITFLAG) tex2rtf $(THISDIR)/manual.tex $(THISDIR)/gizmos.rtf -twice -winhelp + cd $(THISDIR) + +$(DOCDIR)/pdf/gizmos.rtf: $(THISDIR)/classes.tex $(THISDIR)/body.tex $(THISDIR)/topics.tex $(THISDIR)/manual.tex + cd $(THISDIR) + -copy *.wmf $(DOCDIR)\pdf + -copy *.bmp $(DOCDIR)\pdf + -start $(WAITFLAG) tex2rtf $(THISDIR)/manual.tex $(DOCDIR)/pdf/gizmos.rtf -twice -rtf + cd $(THISDIR) + +$(DOCDIR)\html\gizmos\gizmos.htm: $(THISDIR)\classes.tex $(THISDIR)\body.tex $(THISDIR)/topics.tex $(THISDIR)\manual.tex + cd $(THISDIR) + -mkdir $(DOCDIR)\html\gizmos + copy *.gif $(DOCDIR)\html\gizmos + -start $(WAITFLAG) tex2rtf $(THISDIR)\manual.tex $(DOCDIR)\html\gizmos\gizmos.htm -twice -html + -erase $(DOCDIR)\html\gizmos\*.con + -erase $(DOCDIR)\html\gizmos\*.ref + -erase $(THISDIR)\*.con + -erase $(THISDIR)\*.ref + cd $(THISDIR) + +$(DOCDIR)\htmlhelp\gizmos.chm : $(DOCDIR)\html\gizmos\gizmos.htm $(DOCDIR)\html\gizmos\gizmos.hhp + cd $(DOCDIR)\html\gizmos + -hhc gizmos.hhp + -mkdir ..\..\htmlhelp + -erase $(DOCDIR)\htmlhelp\gizmos.chm + move gizmos.chm ..\..\htmlhelp + cd $(THISDIR) + +# An htb file is a zip file containing the .htm, .gif, .hhp, .hhc and .hhk +# files, renamed to htb. +# This can then be used with e.g. helpview. +# Optionally, a cached version of the .hhp file can be generated with hhp2cached. +$(DOCDIR)\htb\gizmos.htb: $(DOCDIR)\html\gizmos\gizmos.htm + cd $(WXDIR)\docs\html\gizmos + -erase gizmos.zip gizmos.htb + zip gizmos.zip *.htm *.gif *.hhp *.hhc *.hhk + -mkdir $(DOCDIR)\htb + move gizmos.zip $(DOCDIR)\htb\gizmos.htb + cd $(THISDIR) + +# In order to force document reprocessing +touchmanual: + -touch $(WXDIR)\docs\latex\gizmos\manual.tex + +updatedocs: touchmanual alldocs + +cleandocs: + -erase $(DOCDIR)\winhelp\gizmos.hlp + -erase $(DOCDIR)\winhelp\gizmos.cnt + -erase $(DOCDIR)\html\gizmos\*.htm + -erase $(DOCDIR)\pdf\gizmos.rtf + -erase $(THISDIR)\gizmos.rtf + -erase $(THISDIR)\gizmos.PH + -erase $(DOCDIR)\htmlhelp\gizmos.chm + -erase $(DOCDIR)\htb\gizmos.htb + +# Start Word, running the GeneratePDF macro. MakeManual.dot should be in the +# Office StartUp folder, and PDFMaker should be installed. +#updatepdf: # touchmanual pdfrtf +# start $(WAITFLAG) "winword d:\wx2\wxWindows\docs\latex\pdf\gizmos.rtf /mGeneratePDF" + + diff --git a/contrib/docs/latex/gizmos/manual.tex b/contrib/docs/latex/gizmos/manual.tex new file mode 100644 index 0000000000..ad8f1ab753 --- /dev/null +++ b/contrib/docs/latex/gizmos/manual.tex @@ -0,0 +1,75 @@ +\documentstyle[a4,11pt,makeidx,verbatim,texhelp,fancyheadings,palatino]{report} +% JACS: doesn't make it through Tex2RTF, sorry. I will put it into texhelp.sty +% since Tex2RTF doesn't parse it. +% BTW, style MUST be report for it to work for Tex2RTF. +%KB: +%\addtolength{\textwidth}{1in} +%\addtolength{\oddsidemargin}{-0.5in} +%\addtolength{\topmargin}{-0.5in} +%\addtolength{\textheight}{1in} +%\sloppy +%end of my changes +\newcommand{\indexit}[1]{#1\index{#1}}% +\newcommand{\pipe}[0]{$\|$\ }% +\definecolour{black}{0}{0}{0}% +\definecolour{cyan}{0}{255}{255}% +\definecolour{green}{0}{255}{0}% +\definecolour{magenta}{255}{0}{255}% +\definecolour{red}{255}{0}{0}% +\definecolour{blue}{0}{0}{200}% +\definecolour{yellow}{255}{255}{0}% +\definecolour{white}{255}{255}{255}% +% +\input psbox.tex +% Remove this for processing with dvi2ps instead of dvips +%\special{!/@scaleunit 1 def} +\parskip=10pt +\parindent=0pt +\title{Gizmos: a library of enhanced controls} +\author{by Julian Smart and others} +\date{January 5th 2002} + +\makeindex +\begin{document} +\maketitle +\pagestyle{fancyplain} +\bibliographystyle{plain} +\setheader{{\it CONTENTS}}{}{}{}{}{{\it CONTENTS}} +\setfooter{\thepage}{}{}{}{}{\thepage}% +\pagenumbering{roman} +\tableofcontents + +\chapter{Copyright notice} +\setheader{{\it COPYRIGHT}}{}{}{}{}{{\it COPYRIGHT}}% +\setfooter{\thepage}{}{}{}{}{\thepage}% + +The licence is the wxWindows Licence. + +\input{body.tex} +\input{classes.tex} +\input{category.tex} +\input{topics.tex} + +\bibliography{refs} +\addcontentsline{toc}{chapter}{Bibliography} +\setheader{{\it REFERENCES}}{}{}{}{}{{\it REFERENCES}}% +\setfooter{\thepage}{}{}{}{}{\thepage}% + +\newpage +% Note: In RTF, the \printindex must come before the +% change of header/footer, since the \printindex inserts +% the RTF \sect command which divides one chapter from +% the next. +\rtfonly{\printindex +\addcontentsline{toc}{chapter}{Index} +\setheader{{\it INDEX}}{}{}{}{}{{\it INDEX}}% +\setfooter{\thepage}{}{}{}{}{\thepage} +} +% In Latex, it must be this way around (I think) +\latexonly{\addcontentsline{toc}{chapter}{Index} +\setheader{{\it INDEX}}{}{}{}{}{{\it INDEX}}% +\setfooter{\thepage}{}{}{}{}{\thepage} +\printindex +} + +\end{document} diff --git a/contrib/docs/latex/gizmos/multicellcanvas.tex b/contrib/docs/latex/gizmos/multicellcanvas.tex new file mode 100644 index 0000000000..bddc307297 --- /dev/null +++ b/contrib/docs/latex/gizmos/multicellcanvas.tex @@ -0,0 +1,57 @@ +% +% automatically generated by HelpGen $Revision$ from +% multicell.h at 05/Jan/02 23:08:14 +% + + +\section{\class{wxMultiCellCanvas}}\label{wxmulticellcanvas} + + +wxCell is used internally, so we don't need to declare it here + +wxMultiCellCanvas + + +\wxheading{Derived from} + +\helpref{wxFlexGridSizer}{wxflexgridsizer} + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxMultiCellCanvas::wxMultiCellCanvas}\label{wxmulticellcanvaswxmulticellcanvas} + +\func{}{wxMultiCellCanvas}{\param{wxWindow* }{parent}, \param{int }{numRows = 2}, \param{int }{numCols = 2}} + + +\membersection{wxMultiCellCanvas::Add}\label{wxmulticellcanvasadd} + +\func{void}{Add}{\param{wxWindow* }{win}, \param{unsigned int }{row}, \param{unsigned int }{col}} + + +\membersection{wxMultiCellCanvas::CalculateConstraints}\label{wxmulticellcanvascalculateconstraints} + +\func{void}{CalculateConstraints}{\void} + + +\membersection{wxMultiCellCanvas::MaxCols}\label{wxmulticellcanvasmaxcols} + +\func{int}{MaxCols}{\void} + + +\membersection{wxMultiCellCanvas::MaxRows}\label{wxmulticellcanvasmaxrows} + +\func{int}{MaxRows}{\void} + + +\membersection{wxMultiCellCanvas::Resize}\label{wxmulticellcanvasresize} + +\func{void}{Resize}{\param{int }{numRows}, \param{int }{numCols}} + + +\membersection{wxMultiCellCanvas::SetMinCellSize}\label{wxmulticellcanvassetmincellsize} + +\func{void}{SetMinCellSize}{\param{const wxSize }{size}} + diff --git a/contrib/docs/latex/gizmos/multicellitemhandle.tex b/contrib/docs/latex/gizmos/multicellitemhandle.tex new file mode 100644 index 0000000000..82846e5b6c --- /dev/null +++ b/contrib/docs/latex/gizmos/multicellitemhandle.tex @@ -0,0 +1,78 @@ +% +% automatically generated by HelpGen $Revision$ from +% multicell.h at 05/Jan/02 23:08:13 +% + + +\section{\class{wxMultiCellItemHandle}}\label{wxmulticellitemhandle} + + + +classes + + +wxMultiCellItemHandle + + +\wxheading{Derived from} + +\helpref{wxObject}{wxobject} + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxMultiCellItemHandle::wxMultiCellItemHandle}\label{wxmulticellitemhandlewxmulticellitemhandle} + +\func{}{wxMultiCellItemHandle}{\param{int }{row}, \param{int }{column}, \param{wxSize }{size}, \param{wxResizable }{style = wxNOT\_RESIZABLE}, \param{wxSize }{weight = wxSize(1,1)}, \param{int }{align = wxALIGN\_NOT}} + + +\func{}{wxMultiCellItemHandle}{\param{int }{row}, \param{int }{column}, \param{wxResizable }{style}, \param{wxSize }{weight = wxSize(1,1)}, \param{int }{align = wxALIGN\_NOT}} + + +\func{}{wxMultiCellItemHandle}{\param{int }{row}, \param{int }{column}, \param{int }{align}} + + +\func{}{wxMultiCellItemHandle}{\param{int }{row}, \param{int }{column}, \param{int }{height = 1}, \param{int }{width = 1}, \param{wxSize }{size = wxDefaultSize}, \param{wxResizable }{style = wxNOT\_RESIZABLE}, \param{wxSize }{weight = wxSize(1,1)}, \param{int }{align = wxALIGN\_NOT}} + + +\membersection{wxMultiCellItemHandle::GetAlignment}\label{wxmulticellitemhandlegetalignment} + +\func{int}{GetAlignment}{\void} + + +\membersection{wxMultiCellItemHandle::GetColumn}\label{wxmulticellitemhandlegetcolumn} + +\func{int}{GetColumn}{\void} + + +\membersection{wxMultiCellItemHandle::GetHeight}\label{wxmulticellitemhandlegetheight} + +\func{int}{GetHeight}{\void} + + +\membersection{wxMultiCellItemHandle::GetLocalSize}\label{wxmulticellitemhandlegetlocalsize} + +\func{wxSize}{GetLocalSize}{\void} + + +\membersection{wxMultiCellItemHandle::GetRow}\label{wxmulticellitemhandlegetrow} + +\func{int}{GetRow}{\void} + + +\membersection{wxMultiCellItemHandle::GetStyle}\label{wxmulticellitemhandlegetstyle} + +\func{wxResizable}{GetStyle}{\void} + + +\membersection{wxMultiCellItemHandle::GetWeight}\label{wxmulticellitemhandlegetweight} + +\func{wxSize}{GetWeight}{\void} + + +\membersection{wxMultiCellItemHandle::GetWidth}\label{wxmulticellitemhandlegetwidth} + +\func{int}{GetWidth}{\void} + diff --git a/contrib/docs/latex/gizmos/multicellsizer.tex b/contrib/docs/latex/gizmos/multicellsizer.tex new file mode 100644 index 0000000000..3c1384854d --- /dev/null +++ b/contrib/docs/latex/gizmos/multicellsizer.tex @@ -0,0 +1,74 @@ +% +% automatically generated by HelpGen $Revision$ from +% multicell.h at 05/Jan/02 23:08:14 +% + + +\section{\class{wxMultiCellSizer}}\label{wxmulticellsizer} + + + +wxMultiCellSizer + + +\wxheading{Derived from} + +\helpref{wxSizer}{wxsizer} + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxMultiCellSizer::wxMultiCellSizer}\label{wxmulticellsizerwxmulticellsizer} + +\func{}{wxMultiCellSizer}{\param{int }{rows}, \param{int }{cols}} + + +\func{}{wxMultiCellSizer}{\param{wxSize \& }{size}} + + +\membersection{wxMultiCellSizer::\destruct{wxMultiCellSizer}}\label{wxmulticellsizerdtor} + +\func{}{\destruct{wxMultiCellSizer}}{\void} + + +\membersection{wxMultiCellSizer::CalcMin}\label{wxmulticellsizercalcmin} + +\func{wxSize}{CalcMin}{\void} + + +\membersection{wxMultiCellSizer::EnableGridLines}\label{wxmulticellsizerenablegridlines} + +\func{bool}{EnableGridLines}{\param{wxWindow* }{win}} + + +\membersection{wxMultiCellSizer::OnPaint}\label{wxmulticellsizeronpaint} + +\func{void}{OnPaint}{\param{wxDC\& }{dc}} + + +\membersection{wxMultiCellSizer::RecalcSizes}\label{wxmulticellsizerrecalcsizes} + +\func{void}{RecalcSizes}{\void} + + +\membersection{wxMultiCellSizer::SetColumnWidth}\label{wxmulticellsizersetcolumnwidth} + +\func{bool}{SetColumnWidth}{\param{int }{column}, \param{int }{colSize = 5}, \param{bool }{expandable = FALSE}} + + +\membersection{wxMultiCellSizer::SetDefaultCellSize}\label{wxmulticellsizersetdefaultcellsize} + +\func{bool}{SetDefaultCellSize}{\param{wxSize }{size}} + + +\membersection{wxMultiCellSizer::SetGridPen}\label{wxmulticellsizersetgridpen} + +\func{bool}{SetGridPen}{\param{wxPen* }{pen}} + + +\membersection{wxMultiCellSizer::SetRowHeight}\label{wxmulticellsizersetrowheight} + +\func{bool}{SetRowHeight}{\param{int }{row}, \param{int }{rowSize = 5}, \param{bool }{expandable = FALSE}} + diff --git a/contrib/docs/latex/gizmos/readme.txt b/contrib/docs/latex/gizmos/readme.txt new file mode 100644 index 0000000000..138a1e073e --- /dev/null +++ b/contrib/docs/latex/gizmos/readme.txt @@ -0,0 +1,116 @@ +Generating the FL Reference Manual +=================================== + +Like the wxWindows manual, the FL manual uses Tex2RTF to +generate HTML, MS HTML Help, wxHTML Help, WinHelp, RTF, and PDF +formats. + +VC++ users can use makefile.vc in this directory, e.g.: + + nmake -f makefile.vc docs ; Create directories and + ; all formats + +or + + nmake -f makefile.vc dirs html ; Create directories, then + ; HTML files + +The targets that the makefile supports are: + +html ; HTML +htb ; wxHTML Help: the HTML files + hhp, hhc files, + ; archived in a fl.htb (zip format) file +htmlhelp ; MS HTML Help: the HTML files + hhp, hhc files + ; then processed with hhc to produce fl.chm +winhelp ; WinHelp format: Tex2RTF produces RTF and CNT + ; files, then the makefile invokes hc.exe to produce + ; the fl.hlp file +rtf: ; WinHelp RTF (intermediate stage for winhelp) +pdfrtf ; Makes an RTF file suitable for loading into + ; MS Word and generating a PDF via Adobe Acrobat + +If you wish to run Tex2RTF directly, you can do e.g. + + tex2rtf $(DOCDIR)\latex\FL\manual.tex $(DOCDIR)\html\FL\fl.htm -twice -html + +For more information on using Tex2RTF, please see: + + docs/tech/tn0003.txt: Adding wxWindows class documentation + +in the wxWindows hierarchy, and also utils/tex2rtf. The Tex2RTF +manual is supplied with wxWindows documentation, in (for example) +docs/html/tex2rtf/t2rtf.htm or docs/htmlhelp/tex2rtf.chm. + +You can configure the way Tex2RTF works with tex2rtf.ini in +docs/latex/fl. + +Generating HTML format +====================== + +To generate HTML documentation, you need to use the -html +argument to Tex2RTF. A whole directory of files will be +generated. + +Generating MS HTML Help format +============================== + +To generate MS HTML Help documentation, you need to generate +the HTML files as above and then run + + hhc fl.hhp + +You'll need the MS HTML Help compiler, obtainable from Microsoft +or bundled with your C++ compiler. + +Generating wxHTML Help format +============================= + +To generate wxHTML Help documentation, you need to generate +the HTML files as above and then archive the HTML, image, +hhc, hhp and optionally hhk files into fl.htb. + +The helpview program can be used to view fl.htb +on supported platforms. Get it from the wxWindows web site +or compile it with samples/html/helpview in the wxWindows +distribution. + +Generating WinHelp format +========================= + +To generate Windows Help documentation, you need to generate +the RTF file and contents file (.cnt) using --winhelp and +then run hc.exe to produce the .hlp file + +Generating PDF format +===================== + +Run Tex2RTF with the -rtf argument, load the RTF into MS Word, +select the whole document, press F9, then apply wordstyle.dot +found in distrib/msw in the wxWindows distribution. +Then generate the PDF using Adobe Acrobat PDFWriter. + +Note that for the contents to be formatted correctly, +each class section should end with a blank line. Otherwise +the contents will have bits of the reference in it. + +Generating .tex files from .h files +=================================== + +Much of the class reference is generated from the headers. +The intention is to comment the headers more thoroughly, then +regenerate the .tex files, before working directly on the +.tex files. + +To regenerate .tex files, you'll need the HelpGen utility from +latest wxWindows CVS, in utils/helpgen/src. Compile wxBase, +then HelpGen. Run helpgen with e.g. + + helpgen dump file.h + +and a separate .tex file for each class will appear in the +current directory. + +-- +Julian Smart, January 3rd 2002 +julian.smart@btopenworld.com + diff --git a/contrib/docs/latex/gizmos/refs.bib b/contrib/docs/latex/gizmos/refs.bib new file mode 100644 index 0000000000..836814c312 --- /dev/null +++ b/contrib/docs/latex/gizmos/refs.bib @@ -0,0 +1,59 @@ +@techreport{robins87, +author = {Robins, Gabriel}, +title = {The {ISI} grapher: a portable tool for displaying graphs pictorially (ISI/RS-87-196)}, +institution = {University of South California}, +year = {1987}, +month = {September} +} +@book{helpbook, +author = {Boggan, Scott and Fakas, David and Welinske, Joe} +, title = {Developing on-line help for {W}indows} +, publisher = {Sams Publishing} +, address = {11711 North College, Carmel, Indiana 46032, USA} +, year = {1993} +} +@book{wong93, +author = {Wong, William} +, title = {Plug and play programming} +, publisher = {M and T Books} +, address = {115 West 18th Street, New York, New York 10011} +, year = {1993} +} +@book{pree94, +author = {Pree, Wolfgang} +, title = {Design patterns for object-oriented software development} +, publisher = {Addison-Wesley} +, address = {Reading, MA} +, year = {1994} +} +@book{gamma95, +author = {Gamma, Erich and Helm, Richard and Johnson, Ralph and Vlissides, John} +, title = {Design patterns: elements of reusable object-oriented software} +, publisher = {Addison-Wesley} +, address = {Reading, MA} +, year = {1994} +} +@book{kopka, +author = {Kopka, Helmut and Daly, Patrick W.} +, title = {A Guide to LaTeX} +, publisher = {Addison-Wesley} +, year = {1993} +} +@manual{smart95a, +author = {Smart, Julian} +, title = {wxCLIPS User Manual} +, publisher = {Artificial Intelligence Applications Institute} +, organization = {University of Edinburgh} +, address = {80 South Bridge, Edinburgh, EH1 1HN} +, year = {1995} +} + +@manual{smart95b, +author = {Smart, Julian} +, title = {Tex2RTF User Manual} +, publisher = {Artificial Intelligence Applications Institute} +, organization = {University of Edinburgh} +, address = {80 South Bridge, Edinburgh, EH1 1HN} +, year = {1995} +} + diff --git a/contrib/docs/latex/gizmos/remotelyscrolledtreectrl.tex b/contrib/docs/latex/gizmos/remotelyscrolledtreectrl.tex new file mode 100644 index 0000000000..75ca54fa94 --- /dev/null +++ b/contrib/docs/latex/gizmos/remotelyscrolledtreectrl.tex @@ -0,0 +1,143 @@ +% +% automatically generated by HelpGen $Revision$ from +% splittree.h at 05/Jan/02 23:08:14 +% + + +\section{\class{wxRemotelyScrolledTreeCtrl}}\label{wxremotelyscrolledtreectrl} + + +wxRemotelyScrolledTreeCtrl + + This tree control disables its vertical scrollbar and catches scroll + events passed by a scrolled window higher in the hierarchy. + It also updates the scrolled window vertical scrollbar as appropriate. + +\wxheading{Derived from} + +\helpref{wxTreeCtrl}{wxtreectrl} + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxRemotelyScrolledTreeCtrl::wxRemotelyScrolledTreeCtrl}\label{wxremotelyscrolledtreectrlwxremotelyscrolledtreectrl} + +\func{}{wxRemotelyScrolledTreeCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pt = wxDefaultPosition}, \param{const wxSize\& }{sz = wxDefaultSize}, \param{long }{style = wxTR\_HAS\_BUTTONS}} + + +\membersection{wxRemotelyScrolledTreeCtrl::\destruct{wxRemotelyScrolledTreeCtrl}}\label{wxremotelyscrolledtreectrldtor} + +\func{}{\destruct{wxRemotelyScrolledTreeCtrl}}{\void} + + +\membersection{wxRemotelyScrolledTreeCtrl::AdjustRemoteScrollbars}\label{wxremotelyscrolledtreectrladjustremotescrollbars} + +\func{void}{AdjustRemoteScrollbars}{\void} + +Adjust the containing wxScrolledWindow's scrollbars appropriately + + +\membersection{wxRemotelyScrolledTreeCtrl::CalcTreeSize}\label{wxremotelyscrolledtreectrlcalctreesize} + +\func{void}{CalcTreeSize}{\param{const wxTreeItemId\& }{id}, \param{wxRect\& }{rect}} + + +\func{void}{CalcTreeSize}{\param{wxRect\& }{rect}} + +Calculate the tree overall size so we can set the scrollbar +correctly + + +\membersection{wxRemotelyScrolledTreeCtrl::GetCompanionWindow}\label{wxremotelyscrolledtreectrlgetcompanionwindow} + +\constfunc{wxWindow*}{GetCompanionWindow}{\void} + + +\membersection{wxRemotelyScrolledTreeCtrl::GetScrollPos}\label{wxremotelyscrolledtreectrlgetscrollpos} + +\constfunc{int}{GetScrollPos}{\param{int }{orient}} + +In case we're using the generic tree control. + + +\membersection{wxRemotelyScrolledTreeCtrl::GetScrolledWindow}\label{wxremotelyscrolledtreectrlgetscrolledwindow} + +\constfunc{wxScrolledWindow*}{GetScrolledWindow}{\void} + +Find the scrolled window that contains this control + + +\membersection{wxRemotelyScrolledTreeCtrl::GetViewStart}\label{wxremotelyscrolledtreectrlgetviewstart} + +\constfunc{void}{GetViewStart}{\param{int* }{x}, \param{int* }{y}} + +In case we're using the generic tree control. +Get the view start + + +\membersection{wxRemotelyScrolledTreeCtrl::HideVScrollbar}\label{wxremotelyscrolledtreectrlhidevscrollbar} + +\func{void}{HideVScrollbar}{\void} + +Helpers + + +\membersection{wxRemotelyScrolledTreeCtrl::OnExpand}\label{wxremotelyscrolledtreectrlonexpand} + +\func{void}{OnExpand}{\param{wxTreeEvent\& }{event}} + + +\membersection{wxRemotelyScrolledTreeCtrl::OnPaint}\label{wxremotelyscrolledtreectrlonpaint} + +\func{void}{OnPaint}{\param{wxPaintEvent\& }{event}} + + +\membersection{wxRemotelyScrolledTreeCtrl::OnScroll}\label{wxremotelyscrolledtreectrlonscroll} + +\func{void}{OnScroll}{\param{wxScrollWinEvent\& }{event}} + + +\membersection{wxRemotelyScrolledTreeCtrl::OnSize}\label{wxremotelyscrolledtreectrlonsize} + +\func{void}{OnSize}{\param{wxSizeEvent\& }{event}} + +Events + + +\membersection{wxRemotelyScrolledTreeCtrl::PrepareDC}\label{wxremotelyscrolledtreectrlpreparedc} + +\func{void}{PrepareDC}{\param{wxDC\& }{dc}} + +In case we're using the generic tree control. + + +\membersection{wxRemotelyScrolledTreeCtrl::ScrollToLine}\label{wxremotelyscrolledtreectrlscrolltoline} + +\func{void}{ScrollToLine}{\param{int }{posHoriz}, \param{int }{posVert}} + +Scroll to the given line (in scroll units where each unit is +the height of an item) + + +\membersection{wxRemotelyScrolledTreeCtrl::SetCompanionWindow}\label{wxremotelyscrolledtreectrlsetcompanionwindow} + +\func{void}{SetCompanionWindow}{\param{wxWindow* }{companion}} + +Accessors +The companion window is one which will get notified when certain +events happen such as node expansion + + +\membersection{wxRemotelyScrolledTreeCtrl::SetScrollbars}\label{wxremotelyscrolledtreectrlsetscrollbars} + +\func{void}{SetScrollbars}{\param{int }{pixelsPerUnitX}, \param{int }{pixelsPerUnitY}, \param{int }{noUnitsX}, \param{int }{noUnitsY}, \param{int }{xPos = 0}, \param{int }{yPos = 0}, \param{bool }{noRefresh = FALSE}} + +Overrides +Override this in case we're using the generic tree control. +Calls to this should disable the vertical scrollbar. +Number of pixels per user unit (0 or -1 for no scrollbar) +Length of virtual canvas in user units +Length of page in user units + diff --git a/contrib/docs/latex/gizmos/shelves.bmp b/contrib/docs/latex/gizmos/shelves.bmp new file mode 100644 index 0000000000000000000000000000000000000000..f51aa39680485d535af17c8729205128b2f9c460 GIT binary patch literal 630 zcmaixF;2ul3`KuXiji1k_6C%cE74G+v|MLHx0YzO&@c>InDD<29yVs7yr!L0Z>0} zG}TM1zu00w%hP(xs#hHI?|0PJ7RIRWOWV5jJDxtc^t+zi4y@MS_WyZPwXPd`v9dZQ z{_GTd_Oax@@<7yMSP!g@+&2Da-SB&(pYEetlh|MN1J{lEYi447ur5+OXfj;(a}CV`%O8V#mmmJDyQBv znOUrUdY)b7p%TfE