projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| eca15c0d VZ |
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 | ||
| 991ad6cd | 36 | <wx/treebook.h> |
| eca15c0d | 37 | |
| a7af285d VZ |
38 | \wxheading{Library} |
| 39 | ||
| 40 | \helpref{wxCore}{librarieslist} | |
| 41 | ||
| eca15c0d VZ |
42 | |
| 43 | ||
| 44 | \input treebookevt.inc | |
| 45 | ||
| 46 | ||
| 47 | ||
| 48 | \wxheading{See also} | |
| 49 | ||
| 50 | \helpref{wxNotebookEvent}{wxnotebookevent}, \helpref{wxTreebook}{wxtreebook} | |
| 51 | ||
| 52 | ||
| 53 | ||
| 54 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 55 | ||
| 56 | ||
| 57 | \membersection{wxTreebookEvent::wxTreebookEvent}\label{wxtreebookeventwxtreebookevent} | |
| 58 | ||
| 59 | \func{}{wxTreebookEvent}{\param{wxEventType }{commandType = wxEVT\_NULL}, \param{int }{id = 0}, \param{int }{nSel = wxNOT\_FOUND}, \param{int }{nOldSel = wxNOT\_FOUND}} | |
| 60 | ||
| 61 | \wxheading{See also} | |
| 62 | ||
| 63 | \helpref{wxNotebookEvent}{wxnotebookevent} | |
| 64 | ||
| 65 | ||
| 66 | ||
| 67 | \membersection{wxTreebookEvent::GetOldSelection}\label{wxtreebookeventgetoldselection} | |
| 68 | ||
| 69 | \constfunc{int}{GetOldSelection}{\void} | |
| 70 | ||
| 71 | Returns the page that was selected before the change, wxNOT\_FOUND if none was selected. | |
| 72 | ||
| 73 | ||
| 74 | ||
| 75 | \membersection{wxTreebookEvent::GetSelection}\label{wxtreebookeventgetselection} | |
| 76 | ||
| 77 | \constfunc{int}{GetSelection}{\void} | |
| 78 | ||
| 79 | Returns the currently selected page, or wxNOT\_FOUND if none was selected. | |
| 80 | ||
| 81 | \wxheading{See also} | |
| 82 | ||
| 83 | \helpref{wxNotebookEvent::GetSelection}{wxnotebookeventgetselection} | |
| 84 |