docs/latex/wx/treebookevent.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        treebookevent.tex
   3 %% Purpose:     wxTreebookEvent documentation
   4 %% Author:      Evgeniy Tarassov
   5 %% Modified by:
   6 %% Created:     2005-10-04
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) 2005 Vadim Zeitlin <vadim@wxwindows.org>
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxTreebookEvent}}\label{wxtreebookevent}
  13
  14 This class represents the events generated by a treebook control: currently,
  15 there are four of them. The PAGE\_CHANGING and PAGE\_CHANGED - have exactly the same
  16 behaviour as \helpref{wxNotebookEvent}{wxnotebookevent}.
  17
  18 The other two NODE\_COLLAPSED and NODE\_EXPANDED are triggered when page node in the tree control
  19 is collapsed/expanded. The page index could be retreived by calling
  20 \helpref{wxTreebookEvent::GetSelection}{wxtreebookeventgetselection}.
  21
  22
  23
  24 \wxheading{Derived from}
  25
  26 wxBookCtrlBaseEvent\\
  27 \helpref{wxNotifyEvent}{wxnotifyevent}\\
  28 \helpref{wxCommandEvent}{wxcommandevent}\\
  29 \helpref{wxEvent}{wxevent}\\
  30 \helpref{wxObject}{wxobject}
  31
  32
  33
  34 \wxheading{Include files}
  35
  36 <treebook.h>
  37
  38
  39
  40 \input treebookevt.inc
  41
  42
  43
  44 \wxheading{See also}
  45
  46 \helpref{wxNotebookEvent}{wxnotebookevent}, \helpref{wxTreebook}{wxtreebook}
  47
  48
  49
  50 \latexignore{\rtfignore{\wxheading{Members}}}
  51
  52
  53 \membersection{wxTreebookEvent::wxTreebookEvent}\label{wxtreebookeventwxtreebookevent}
  54
  55 \func{}{wxTreebookEvent}{\param{wxEventType }{commandType = wxEVT\_NULL}, \param{int }{id = 0}, \param{int }{nSel = wxNOT\_FOUND}, \param{int }{nOldSel = wxNOT\_FOUND}}
  56
  57 \wxheading{See also}
  58
  59 \helpref{wxNotebookEvent}{wxnotebookevent}
  60
  61
  62
  63 \membersection{wxTreebookEvent::GetOldSelection}\label{wxtreebookeventgetoldselection}
  64
  65 \constfunc{int}{GetOldSelection}{\void}
  66
  67 Returns the page that was selected before the change, wxNOT\_FOUND if none was selected.
  68
  69
  70
  71 \membersection{wxTreebookEvent::GetSelection}\label{wxtreebookeventgetselection}
  72
  73 \constfunc{int}{GetSelection}{\void}
  74
  75 Returns the currently selected page, or wxNOT\_FOUND if none was selected.
  76
  77 \wxheading{See also}
  78
  79 \helpref{wxNotebookEvent::GetSelection}{wxnotebookeventgetselection}
  80