wxWidgets/docs/latex/wx/treebookevent.tex

85 lines
2.2 KiB
TeX

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name: treebookevent.tex
%% Purpose: wxTreebookEvent documentation
%% Author: Evgeniy Tarassov
%% Modified by:
%% Created: 2005-10-04
%% RCS-ID: $Id$
%% Copyright: (c) 2005 Vadim Zeitlin <vadim@wxwindows.org>
%% License: wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{\class{wxTreebookEvent}}\label{wxtreebookevent}
This class represents the events generated by a treebook control: currently,
there are four of them. The PAGE\_CHANGING and PAGE\_CHANGED - have exactly the same
behaviour as \helpref{wxNotebookEvent}{wxnotebookevent}.
The other two NODE\_COLLAPSED and NODE\_EXPANDED are triggered when page node in the tree control
is collapsed/expanded. The page index could be retreived by calling
\helpref{wxTreebookEvent::GetSelection}{wxtreebookeventgetselection}.
\wxheading{Derived from}
wxBookCtrlBaseEvent\\
\helpref{wxNotifyEvent}{wxnotifyevent}\\
\helpref{wxCommandEvent}{wxcommandevent}\\
\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/treebook.h>
\wxheading{Library}
\helpref{wxCore}{librarieslist}
\input treebookevt.inc
\wxheading{See also}
\helpref{wxNotebookEvent}{wxnotebookevent}, \helpref{wxTreebook}{wxtreebook}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxTreebookEvent::wxTreebookEvent}\label{wxtreebookeventwxtreebookevent}
\func{}{wxTreebookEvent}{\param{wxEventType }{commandType = wxEVT\_NULL}, \param{int }{id = 0}, \param{int }{nSel = wxNOT\_FOUND}, \param{int }{nOldSel = wxNOT\_FOUND}}
\wxheading{See also}
\helpref{wxNotebookEvent}{wxnotebookevent}
\membersection{wxTreebookEvent::GetOldSelection}\label{wxtreebookeventgetoldselection}
\constfunc{int}{GetOldSelection}{\void}
Returns the page that was selected before the change, wxNOT\_FOUND if none was selected.
\membersection{wxTreebookEvent::GetSelection}\label{wxtreebookeventgetselection}
\constfunc{int}{GetSelection}{\void}
Returns the currently selected page, or wxNOT\_FOUND if none was selected.
\wxheading{See also}
\helpref{wxNotebookEvent::GetSelection}{wxnotebookeventgetselection}