git.saurik.com Git - wxWidgets.git/blame_incremental - contrib/docs/latex/gizmos/remotelyscrolledtreectrl.tex

... / ...

Commit	Line	Data
	1	%
	2	% automatically generated by HelpGen $Revision$ from
	3	% splittree.h at 05/Jan/02 23:08:14
	4	%
	5
	6
	7	\section{\class{wxRemotelyScrolledTreeCtrl}}\label{wxremotelyscrolledtreectrl}
	8
	9
	10	wxRemotelyScrolledTreeCtrl
	11
	12	This tree control disables its vertical scrollbar and catches scroll
	13	events passed by a scrolled window higher in the hierarchy.
	14	It also updates the scrolled window vertical scrollbar as appropriate.
	15
	16	\wxheading{Derived from}
	17
	18	\helpref{wxTreeCtrl}{wxtreectrl}
	19
	20	\wxheading{Data structures}
	21
	22	\latexignore{\rtfignore{\wxheading{Members}}}
	23
	24
	25	\membersection{wxRemotelyScrolledTreeCtrl::wxRemotelyScrolledTreeCtrl}\label{wxremotelyscrolledtreectrlwxremotelyscrolledtreectrl}
	26
	27	\func{}{wxRemotelyScrolledTreeCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pt = wxDefaultPosition}, \param{const wxSize\& }{sz = wxDefaultSize}, \param{long }{style = wxTR\_HAS\_BUTTONS}}
	28
	29
	30	\membersection{wxRemotelyScrolledTreeCtrl::\destruct{wxRemotelyScrolledTreeCtrl}}\label{wxremotelyscrolledtreectrldtor}
	31
	32	\func{}{\destruct{wxRemotelyScrolledTreeCtrl}}{\void}
	33
	34
	35	\membersection{wxRemotelyScrolledTreeCtrl::AdjustRemoteScrollbars}\label{wxremotelyscrolledtreectrladjustremotescrollbars}
	36
	37	\func{void}{AdjustRemoteScrollbars}{\void}
	38
	39	Adjust the containing wxScrolledWindow's scrollbars appropriately
	40
	41
	42	\membersection{wxRemotelyScrolledTreeCtrl::CalcTreeSize}\label{wxremotelyscrolledtreectrlcalctreesize}
	43
	44	\func{void}{CalcTreeSize}{\param{const wxTreeItemId\& }{id}, \param{wxRect\& }{rect}}
	45
	46
	47	\func{void}{CalcTreeSize}{\param{wxRect\& }{rect}}
	48
	49	Calculate the tree overall size so we can set the scrollbar
	50	correctly
	51
	52
	53	\membersection{wxRemotelyScrolledTreeCtrl::GetCompanionWindow}\label{wxremotelyscrolledtreectrlgetcompanionwindow}
	54
	55	\constfunc{wxWindow*}{GetCompanionWindow}{\void}
	56
	57
	58	\membersection{wxRemotelyScrolledTreeCtrl::GetScrollPos}\label{wxremotelyscrolledtreectrlgetscrollpos}
	59
	60	\constfunc{int}{GetScrollPos}{\param{int }{orient}}
	61
	62	In case we're using the generic tree control.
	63
	64
	65	\membersection{wxRemotelyScrolledTreeCtrl::GetScrolledWindow}\label{wxremotelyscrolledtreectrlgetscrolledwindow}
	66
	67	\constfunc{wxScrolledWindow*}{GetScrolledWindow}{\void}
	68
	69	Find the scrolled window that contains this control
	70
	71
	72	\membersection{wxRemotelyScrolledTreeCtrl::GetViewStart}\label{wxremotelyscrolledtreectrlgetviewstart}
	73
	74	\constfunc{void}{GetViewStart}{\param{int* }{x}, \param{int* }{y}}
	75
	76	In case we're using the generic tree control.
	77	Get the view start
	78
	79
	80	\membersection{wxRemotelyScrolledTreeCtrl::HideVScrollbar}\label{wxremotelyscrolledtreectrlhidevscrollbar}
	81
	82	\func{void}{HideVScrollbar}{\void}
	83
	84	Helpers
	85
	86
	87	\membersection{wxRemotelyScrolledTreeCtrl::OnExpand}\label{wxremotelyscrolledtreectrlonexpand}
	88
	89	\func{void}{OnExpand}{\param{wxTreeEvent\& }{event}}
	90
	91
	92	\membersection{wxRemotelyScrolledTreeCtrl::OnPaint}\label{wxremotelyscrolledtreectrlonpaint}
	93
	94	\func{void}{OnPaint}{\param{wxPaintEvent\& }{event}}
	95
	96
	97	\membersection{wxRemotelyScrolledTreeCtrl::OnScroll}\label{wxremotelyscrolledtreectrlonscroll}
	98
	99	\func{void}{OnScroll}{\param{wxScrollWinEvent\& }{event}}
	100
	101
	102	\membersection{wxRemotelyScrolledTreeCtrl::OnSize}\label{wxremotelyscrolledtreectrlonsize}
	103
	104	\func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
	105
	106	Events
	107
	108
	109	\membersection{wxRemotelyScrolledTreeCtrl::PrepareDC}\label{wxremotelyscrolledtreectrlpreparedc}
	110
	111	\func{void}{PrepareDC}{\param{wxDC\& }{dc}}
	112
	113	In case we're using the generic tree control.
	114
	115
	116	\membersection{wxRemotelyScrolledTreeCtrl::ScrollToLine}\label{wxremotelyscrolledtreectrlscrolltoline}
	117
	118	\func{void}{ScrollToLine}{\param{int }{posHoriz}, \param{int }{posVert}}
	119
	120	Scroll to the given line (in scroll units where each unit is
	121	the height of an item)
	122
	123
	124	\membersection{wxRemotelyScrolledTreeCtrl::SetCompanionWindow}\label{wxremotelyscrolledtreectrlsetcompanionwindow}
	125
	126	\func{void}{SetCompanionWindow}{\param{wxWindow* }{companion}}
	127
	128	Accessors
	129	The companion window is one which will get notified when certain
	130	events happen such as node expansion
	131
	132
	133	\membersection{wxRemotelyScrolledTreeCtrl::SetScrollbars}\label{wxremotelyscrolledtreectrlsetscrollbars}
	134
	135	\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}}
	136
	137	Overrides
	138	Override this in case we're using the generic tree control.
	139	Calls to this should disable the vertical scrollbar.
	140	Number of pixels per user unit (0 or -1 for no scrollbar)
	141	Length of virtual canvas in user units
	142	Length of page in user units
	143