From: Julian Smart Date: Sun, 6 Sep 1998 14:43:36 +0000 (+0000) Subject: Added some more class docs X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/3972fb4919148d1ed67f897ea5beb67eedd662f6 Added some more class docs git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@679 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/latex/wx/accel.tex b/docs/latex/wx/accel.tex new file mode 100644 index 0000000000..14aacf7843 --- /dev/null +++ b/docs/latex/wx/accel.tex @@ -0,0 +1,190 @@ +\section{\class{wxAcceleratorEntry}}\label{wxacceleratorentry} + +An object used by an application wishing to create an \helpref{accelerator table}{wxacceleratortable}. + +\wxheading{Derived from} + +None + +\wxheading{See also} + +\helpref{wxAcceleratorTable}{wxacceleratortable}, \helpref{wxWindow::SetAcceleratorTable}{wxwindowsetacceleratortable} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxAcceleratorEntry::wxAcceleratorEntry}\label{wxacceleratorentryconstr} + +\func{}{wxAcceleratorEntry}{\void} + +Default constructor. + +\func{}{wxAcceleratorEntry}{\param{int}{ flags}, \param{int}{ keyCode}, \param{int}{ cmd}} + +Constructor. + +\wxheading{Parameters} + +\docparam{flags}{One of wxACCEL\_SHIFT, wxACCEL\_CTRL and wxACCEL\_NORMAL. Indicates +which modifier key is held down.} + +\docparam{keyCode}{The keycode to be detected. See \helpref{Keycodes}{keycodes} for a full list of keycodes.} + +\docparam{cmd}{The menu or control command identifier.} + +\membersection{wxAcceleratorEntry::GetCommand}\label{wxacceleratorentrygetcommand} + +\constfunc{int}{GetCommand}{\void} + +Returns the command identifier for the accelerator table entry. + +\membersection{wxAcceleratorEntry::GetFlags}\label{wxacceleratorentrygetflags} + +\constfunc{int}{GetFlags}{\void} + +Returns the flags for the accelerator table entry. + +\membersection{wxAcceleratorEntry::GetKeyCode}\label{wxacceleratorentrygetkeycode} + +\constfunc{int}{GetKeyCode}{\void} + +Returns the keycode for the accelerator table entry. + +\membersection{wxAcceleratorEntry::Set}\label{wxacceleratorentryset} + +\func{void}{Set}{\param{int}{ flags}, \param{int}{ keyCode}, \param{int}{ cmd}} + +Sets the accelerator entry parameters. + +\wxheading{Parameters} + +\docparam{flags}{One of wxACCEL\_SHIFT, wxACCEL\_CTRL and wxACCEL\_NORMAL. Indicates +which modifier key is held down.} + +\docparam{keyCode}{The keycode to be detected. See \helpref{Keycodes}{keycodes} for a full list of keycodes.} + +\docparam{cmd}{The menu or control command identifier.} + +\section{\class{wxAcceleratorTable}}\label{wxacceleratortable} + +An accelerator table allows the application to specify a table of keyboard shortcuts for +menus or other commands. On Windows, menu or button commands are supported; on GTK, +only menu commands are supported. + +The object {\bf wxNullAcceleratorTable} is defined to be a table with no data, and is the +initial accelerator table for a window. + +\wxheading{Derived from} + +\helpref{wxObject}{wxobject} + +\wxheading{Example} + +{\small% +\begin{verbatim} + wxAcceleratorEntry entries[4]; + entries[0].Set(wxACCEL_CTRL, (int) 'N', ID_NEW_WINDOW); + entries[1].Set(wxACCEL_CTRL, (int) 'X', wxID_EXIT); + entries[2].Set(wxACCEL_SHIFT, (int) 'A', ID_ABOUT); + entries[3].Set(wxACCEL_NONE, WXK_DELETE, wxID_CUT); + wxAcceleratorTable accel(4, entries); + frame->SetAcceleratorTable(accel); +\end{verbatim} +} + +\wxheading{Remarks} + +An accelerator takes precedence over normal processing and can be a convenient way to program some event handling. +For example, you can use an accelerator table to enable a dialog with a multi-line text control to +accept CTRL-Enter as meaning 'OK' (but not in GTK at present). + +\wxheading{See also} + +\helpref{wxAcceleratorEntry}{wxacceleratorentry}, \helpref{wxWindow::SetAcceleratorTable}{wxwindowsetacceleratortable} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxAcceleratorTable::wxAcceleratorTable}\label{wxacceleratortableconstr} + +\func{}{wxAcceleratorTable}{\void} + +Default constructor. + +\func{}{wxAcceleratorTable}{\param{const wxAcceleratorTable\& }{bitmap}} + +Copy constructor. + +\func{}{wxAcceleratorTable}{\param{int}{ n}, \param{wxAcceleratorEntry}{ entries[]}} + +Creates from an array of \helpref{wxAcceleratorEntry}{wxacceleratorentry} objects. + +\func{}{wxAcceleratorTable}{\param{const wxString\&}{ resource}} + +Loads the accelerator table from a Windows resource (Windows only). + +\wxheading{Parameters} + +\docparam{n}{Number of accelerator entries.} + +\docparam{entries}{The array of entries.} + +\docparam{resource}{Name of a Windows accelerator.} + +\membersection{wxAcceleratorTable::\destruct{wxAcceleratorTable}} + +\func{}{\destruct{wxAcceleratorTable}}{\void} + +Destroys the wxAcceleratorTable object. + +\membersection{wxAcceleratorTable::Ok}\label{wxacceleratortableok} + +\constfunc{bool}{Ok}{\void} + +Returns TRUE if the accelerator table is valid. + +\membersection{wxAcceleratorTable::operator $=$} + +\func{wxAcceleratorTable\& }{operator $=$}{\param{const wxAcceleratorTable\& }{accel}} + +Assignment operator. This operator does not copy any data, but instead +passes a pointer to the data in {\it accel} and increments a reference +counter. It is a fast operation. + +\wxheading{Parameters} + +\docparam{accel}{Accelerator table to assign.} + +\wxheading{Return value} + +Returns 'this' object. + +\membersection{wxAcceleratorTable::operator $==$} + +\func{bool}{operator $==$}{\param{const wxAcceleratorTable\& }{accel}} + +Equality operator. This operator tests whether the internal data pointers are +equal (a fast test). + +\wxheading{Parameters} + +\docparam{accel}{Accelerator table to compare with 'this'} + +\wxheading{Return value} + +Returns TRUE if the accelerator tables were effectively equal, FALSE otherwise. + +\membersection{wxAcceleratorTable::operator $!=$} + +\func{bool}{operator $!=$}{\param{const wxAcceleratorTable\& }{accel}} + +Inequality operator. This operator tests whether the internal data pointers are +unequal (a fast test). + +\wxheading{Parameters} + +\docparam{accel}{Accelerator table to compare with 'this'} + +\wxheading{Return value} + +Returns TRUE if the accelerator tables were unequal, FALSE otherwise. + + diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index 230662b473..459b0adee0 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -33,8 +33,8 @@ The following are a variety of windows that are derived from wxWindow. \twocolitem{\helpref{wxSplitterWindow}{wxsplitterwindow}}{Window which can be split vertically or horizontally} \twocolitem{\helpref{wxStatusBar}{wxstatusbar}}{Implements the status bar on a frame} \twocolitem{\helpref{wxToolBar}{wxtoolbar}}{Toolbar class} -\twocolitem{\helpref{wxTabbedPanel}{wxtabbedpanel}}{Tabbed panel (to be replaced with wxNotebook)} -\twocolitem{\helpref{wxNotebook}{wxnotebook}}{Notebook class (undocumented)} +%\twocolitem{\helpref{wxTabbedPanel}{wxtabbedpanel}}{Tabbed panel (to be replaced with wxNotebook)} +\twocolitem{\helpref{wxNotebook}{wxnotebook}}{Notebook class} \end{twocollist} {\large {\bf Common dialogs}} @@ -172,7 +172,9 @@ An event object contains information about a specific event. Event handlers \twocolitem{\helpref{wxMenuEvent}{wxmenuevent}}{A menu event} \twocolitem{\helpref{wxMouseEvent}{wxmouseevent}}{A mouse event} \twocolitem{\helpref{wxMoveEvent}{wxmoveevent}}{A move event} +\twocolitem{\helpref{wxNotebookEvent}{wxnotebookevent}}{A notebook control event} \twocolitem{\helpref{wxPaintEvent}{wxpaintevent}}{A paint event} +\twocolitem{\helpref{wxProcessEvent}{wxprocessevent}}{A process ending event} %\twocolitem{\helpref{wxSessionEvent}{wxsessionevent}}{A session ending event} \twocolitem{\helpref{wxSizeEvent}{wxsizeevent}}{A size event} \twocolitem{\helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}}{A system colour change event} @@ -314,12 +316,14 @@ product. {\large {\bf Miscellaneous}} \begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxAcceleratorTable}{wxacceleratortable}}{Accelerator table} \twocolitem{\helpref{wxApp}{wxapp}}{Application class} +\twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing} \twocolitem{\helpref{wxHelpControllerBase}{wxhelpcontrollerbase}}{Base class for help controllers} +\twocolitem{\helpref{wxProcess}{wxprocess}}{Process class} \twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class} \twocolitem{\helpref{wxSystemSettings}{wxsystemsettings}}{System settings class} \twocolitem{\helpref{wxWinHelpController}{wxwinhelpcontroller}}{Controls WinHelp instances} -\twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing} \end{twocollist} diff --git a/docs/latex/wx/checklst.tex b/docs/latex/wx/checklst.tex new file mode 100644 index 0000000000..8a328a4ff4 --- /dev/null +++ b/docs/latex/wx/checklst.tex @@ -0,0 +1,95 @@ +\section{\class{wxCheckListBox}}\label{wxchecklistbox} + +A checklistbox is like a listbox, but allows items to be checked or unchecked. + +This class is currently only implemented under Windows, and wxWindows must be +compiled with USE\_OWNER\_DRAWN set to 1. + +Only the new functions for this class are documented; see also \helpref{wxListBox}{wxlistbox}. + +\wxheading{Derived from} + +\helpref{wxListBox}{wxlistbox}\\ +\helpref{wxControl}{wxcontrol}\\ +\helpref{wxWindow}{wxwindow}\\ +\helpref{wxEvtHandler}{wxevthandler}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Window styles} + +See \helpref{wxListBox}{wxlistbox}. + +\wxheading{Event handling} + +See \helpref{wxListBox}{wxlistbox}. + +\wxheading{See also} + +\helpref{wxListBox}{wxlistbox}, \helpref{wxChoice}{wxchoice}, \helpref{wxComboBox}{wxcombobox}, \helpref{wxListCtrl}{wxlistctrl}, +\rtfsp\helpref{wxCommandEvent}{wxcommandevent} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxCheckListBox::wxCheckListBox}\label{wxchecklistboxconstr} + +\func{}{wxCheckListBox}{\void} + +Default constructor. + +\func{}{wxCheckListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp +\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp +\param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp +\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}} + +Constructor, creating and showing a list box. + +\wxheading{Parameters} + +\docparam{parent}{Parent window. Must not be NULL.} + +\docparam{id}{Window identifier. A value of -1 indicates a default value.} + +\docparam{pos}{Window position.} + +\docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized +appropriately.} + +\docparam{n}{Number of strings with which to initialise the control.} + +\docparam{choices}{An array of strings with which to initialise the control.} + +\docparam{style}{Window style. See \helpref{wxCheckListBox}{wxchecklistbox}.} + +\docparam{validator}{Window validator.} + +\docparam{name}{Window name.} + +\membersection{wxCheckListBox::\destruct{wxCheckListBox}} + +\func{void}{\destruct{wxCheckListBox}}{\void} + +Destructor, destroying the list box. + +\membersection{wxCheckListBox::Check}\label{wxchecklistboxcheck} + +\func{void}{Check}{\param{int }{item}, \param{bool}{ check = TRUE}} + +Checks the given item. + +\wxheading{Parameters} + +\docparam{item}{Index of item to check.} + +\docparam{check}{TRUE if the item is to be checked, FALSE otherwise.} + +\membersection{wxCheckListBox::IsChecked}\label{wxchecklistboxischecked} + +\constfunc{bool}{IsChecked}{\param{int}{ item}} + +Returns TRUE if the given item is checked, FALSE otherwise. + +\wxheading{Parameters} + +\docparam{item}{Index of item whose check status is to be returned.} + + diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 1cd0dc855e..b2ff4d1384 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -27,6 +27,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$ }} \end{comment} +\input accel.tex \input activevt.tex \input app.tex \input button.tex @@ -34,6 +35,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$ \input bbutton.tex \input brush.tex \input checkbox.tex +\input checklst.tex \input choice.tex \input clasinfo.tex \input clientdc.tex @@ -113,6 +115,8 @@ $$\image{14cm;0cm}{wxclass.ps}$$ \input mltchdlg.tex \input mutex.tex \input node.tex +\input notebook.tex +\input noteevt.tex \input object.tex \input pagedlg.tex \input paintdc.tex @@ -123,10 +127,11 @@ $$\image{14cm;0cm}{wxclass.ps}$$ \input pathlist.tex \input pen.tex \input point.tex +\input postscpt.tex \input prevwin.tex \input print.tex \input process.tex -\input postscpt.tex +\input procevt.tex \input query.tex \input radiobox.tex \input radiobut.tex @@ -175,6 +180,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$ \input winhelp.tex \input function.tex +\input keycode.tex %%% Local Variables: diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex index eea61df4b4..536d025736 100644 --- a/docs/latex/wx/config.tex +++ b/docs/latex/wx/config.tex @@ -15,8 +15,8 @@ which is mapped onto the native wxConfigBase implementation on the given platform: i.e. wxRegConfig under Win32, wxIniConfig under Win16 and wxFileConfig otherwise. -See \helpref{config overview}{configoverview} for the descriptions of all -features of this class. +%See \helpref{config overview}{configoverview} for the descriptions of all +%features of this class. \wxheading{Derived from} @@ -98,8 +98,8 @@ disable this behaviour {\it DontCreateOnDemand()} is provided. \membersection{Path management} -As explained in \helpref{config overview}{configoverview}, the config classes -support a file system-like hierarchy of keys (files) and groups (directories). +%As explained in \helpref{config overview}{configoverview}, +The config classes support a file system-like hierarchy of keys (files) and groups (directories). As in the file system case, to specify a key in the config class you must use a path to it. Config classes also support the notion of the current group, which makes it possible to use the relative paths. To clarify all this, here diff --git a/docs/latex/wx/keycode.tex b/docs/latex/wx/keycode.tex new file mode 100644 index 0000000000..9b39ab66e5 --- /dev/null +++ b/docs/latex/wx/keycode.tex @@ -0,0 +1,84 @@ +\section{Keycodes}\label{keycodes} + +Keypresses are represented by an enumerated type, wxKeyCode. The possible values +are the ASCII character codes, plus the following: + +{\small +\begin{verbatim} + WXK_BACK = 8 + WXK_TAB = 9 + WXK_RETURN = 13 + WXK_ESCAPE = 27 + WXK_SPACE = 32 + WXK_DELETE = 127 + + WXK_START = 300 + WXK_LBUTTON + WXK_RBUTTON + WXK_CANCEL + WXK_MBUTTON + WXK_CLEAR + WXK_SHIFT + WXK_CONTROL + WXK_MENU + WXK_PAUSE + WXK_CAPITAL + WXK_PRIOR + WXK_NEXT + WXK_END + WXK_HOME + WXK_LEFT + WXK_UP + WXK_RIGHT + WXK_DOWN + WXK_SELECT + WXK_PRINT + WXK_EXECUTE + WXK_SNAPSHOT + WXK_INSERT + WXK_HELP + WXK_NUMPAD0 + WXK_NUMPAD1 + WXK_NUMPAD2 + WXK_NUMPAD3 + WXK_NUMPAD4 + WXK_NUMPAD5 + WXK_NUMPAD6 + WXK_NUMPAD7 + WXK_NUMPAD8 + WXK_NUMPAD9 + WXK_MULTIPLY + WXK_ADD + WXK_SEPARATOR + WXK_SUBTRACT + WXK_DECIMAL + WXK_DIVIDE + WXK_F1 + WXK_F2 + WXK_F3 + WXK_F4 + WXK_F5 + WXK_F6 + WXK_F7 + WXK_F8 + WXK_F9 + WXK_F10 + WXK_F11 + WXK_F12 + WXK_F13 + WXK_F14 + WXK_F15 + WXK_F16 + WXK_F17 + WXK_F18 + WXK_F19 + WXK_F20 + WXK_F21 + WXK_F22 + WXK_F23 + WXK_F24 + WXK_NUMLOCK + WXK_SCROLL +\end{verbatim} +} + diff --git a/docs/latex/wx/keyevent.tex b/docs/latex/wx/keyevent.tex index 0f86725e3c..53a2d5b7db 100644 --- a/docs/latex/wx/keyevent.tex +++ b/docs/latex/wx/keyevent.tex @@ -35,84 +35,7 @@ TRUE if control is pressed down. \member{long}{m\_keyCode} -Virtual keycode. An enumerated type, one of: - -\begin{verbatim} - WXK_BACK = 8 - WXK_TAB = 9 - WXK_RETURN = 13 - WXK_ESCAPE = 27 - WXK_SPACE = 32 - WXK_DELETE = 127 - - WXK_START = 300 - WXK_LBUTTON - WXK_RBUTTON - WXK_CANCEL - WXK_MBUTTON - WXK_CLEAR - WXK_SHIFT - WXK_CONTROL - WXK_MENU - WXK_PAUSE - WXK_CAPITAL - WXK_PRIOR - WXK_NEXT - WXK_END - WXK_HOME - WXK_LEFT - WXK_UP - WXK_RIGHT - WXK_DOWN - WXK_SELECT - WXK_PRINT - WXK_EXECUTE - WXK_SNAPSHOT - WXK_INSERT - WXK_HELP - WXK_NUMPAD0 - WXK_NUMPAD1 - WXK_NUMPAD2 - WXK_NUMPAD3 - WXK_NUMPAD4 - WXK_NUMPAD5 - WXK_NUMPAD6 - WXK_NUMPAD7 - WXK_NUMPAD8 - WXK_NUMPAD9 - WXK_MULTIPLY - WXK_ADD - WXK_SEPARATOR - WXK_SUBTRACT - WXK_DECIMAL - WXK_DIVIDE - WXK_F1 - WXK_F2 - WXK_F3 - WXK_F4 - WXK_F5 - WXK_F6 - WXK_F7 - WXK_F8 - WXK_F9 - WXK_F10 - WXK_F11 - WXK_F12 - WXK_F13 - WXK_F14 - WXK_F15 - WXK_F16 - WXK_F17 - WXK_F18 - WXK_F19 - WXK_F20 - WXK_F21 - WXK_F22 - WXK_F23 - WXK_F24 - WXK_NUMLOCK - WXK_SCROLL -\end{verbatim} +Virtual keycode. See \helpref{Keycodes}{keycodes} for a list of identifiers. \membersection{wxKeyEvent::m\_metaDown} @@ -174,7 +97,7 @@ Returns the Y position of the event. Returns the virtual key code. ASCII events return normal ASCII values, while non-ASCII events return values such as {\bf WXK\_LEFT} for the -left cursor key. See {\tt wx\_defs.h} for a full list of the virtual key codes. +left cursor key. See \helpref{Keycodes}{keycodes} for a full list of the virtual key codes. \membersection{wxKeyEvent::MetaDown} diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex new file mode 100644 index 0000000000..d8d9f8ab24 --- /dev/null +++ b/docs/latex/wx/notebook.tex @@ -0,0 +1,259 @@ +\section{\class{wxNotebook}}\label{wxnotebook} + +This class represents a notebook control, which manages multiple windows with associated tabs. + +To use the class, create a wxNotebook object and call \helpref{AddPage}{wxnotebookaddpage} or \helpref{InsertPage}{wxnotebookinsertpage}, +passing a window to be used as the page. Do not explicitly delete the window for a page that is currently +managed by wxNotebook. + +{\bf wxNotebookPage} is a typedef for wxWindow. + +\wxheading{Derived from} + +\helpref{wxControl}{wxcontrol}\\ +\helpref{wxWindow}{wxwindow}\\ +\helpref{wxEvtHandler}{wxevthandler}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Event handling} + +To process input from a notebook control, use the following event handler macros to direct input to member +functions that take a \helpref{wxNotebookEvent}{wxnotebookevent} argument. + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_NOTEBOOK_PAGE_CHANGED(id, func)}}{The page selection was changed. Processes a +wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGED event.} +\twocolitem{{\bf EVT\_NOTEBOOK_PAGE_CHANGING(id, func)}}{The page selection is about to be changed. +Processes a wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING event.} +\end{twocollist}% + +\wxheading{See also} + +\helpref{wxNotebookEvent}{wxnotebookevent}, \helpref{wxImageList}{wximagelist},\rtfsp +\helpref{wxTabCtrl}{wxtabctrl} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxNotebook::wxNotebook}\label{wxnotebookconstr} + +\func{}{wxNotebook}{\void} + +Default constructor. + +\func{}{wxNotebook}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, + \param{const wxSize\&}{ size}, \param{long}{ style = 0}, \param{const wxString\& }{name = "notebook"}} + +Constructs a notebook control. + +\wxheading{Parameters} + +\docparam{parent}{The parent window. Must be non-NULL.} + +\docparam{id}{The window identifier.} + +\docparam{pos}{The window position.} + +\docparam{size}{The window size.} + +\docparam{style}{The window style. Its value is a bit list of zero or more of {\bf wxTC\_MULTILINE}, + {\bf wxTC\_RIGHTJUSTIFY}, {\bf wxTC\_FIXEDWIDTH} and {\bf wxTC\_OWNERDRAW}.} + +\membersection{wxNotebook::\destruct{wxNotebook}} + +\func{}{\destruct{wxNotebook}}{\void} + +Destroys the wxNotebook object. + +\membersection{wxNotebook::AddPage}\label{wxnotebookaddpage} + +\func{bool}{AddPage}{\param{wxNotebookPage*}{ page}, + \param{const wxString\&}{ text}, + \param{bool}{ select = FALSE}, + \param{int}{ imageId = -1}} + +Adds a new page. + +\wxheading{Parameters} + +\docparam{page}{Specifies the new page.} + +\docparam{text}{Specifies the text for the new page.} + +\docparam{select}{Specifies whether the page should be selected.} + +\docparam{imageId}{Specifies the optional image index for the new page.} + +\wxheading{Return value} + +TRUE if successful, FALSE otherwise. + +\wxheading{Remarks} + +Do not delete the page, it will be deleted by the notebook. + +\wxheading{See also} + +\helpref{wxNotebook::InsertPage}{wxnotebookinsertpage} + +\membersection{wxNotebook::AdvanceSelection}\label{wxnotebookadvanceselection} + +\func{void}{AdvanceSelection}{\param{bool}{ forward = TRUE}} + +Cycles through the tabs. + +\membersection{wxNotebook::Create}\label{wxnotebookcreate} + +\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, + \param{const wxSize\&}{ size}, \param{long}{ style = 0}, \param{const wxString\& }{name = "notebook"}} + +Creates a notebook control. See \helpref{wxNotebook::wxNotebook}{wxnotebookconstr} for a description +of the parameters. + +\membersection{wxNotebook::DeleteAllPages}\label{wxnotebookdeleteallpages} + +\func{bool}{DeleteAllPages}{\void} + +Deletes all pages. + +\membersection{wxNotebook::DeletePage}\label{wxnotebookdeletepage} + +\func{bool}{DeletePage}{\param{int}{ page}} + +Deletes the specified page. + +\membersection{wxNotebook::GetImageList}\label{wxnotebookgetimagelist} + +\constfunc{wxImageList*}{GetImageList}{\void} + +Returns the associated image list. + +\wxheading{See also} + +\helpref{wxImageList}{wximagelist}, \helpref{wxNotebook::SetImageList}{wxnotebooksetimagelist} + +\membersection{wxNotebook::GetPage}\label{wxnotebookgetpage} + +\func{wxNotebookPage*}{GetPage}{\param{int}{ page}} + +Returns the window at the given page position. + +\membersection{wxNotebook::GetPageCount}\label{wxnotebookgetpagecount} + +\constfunc{int}{GetPageCount}{\void} + +Returns the number of pages in the notebook control. + +\membersection{wxNotebook::GetPageImage}\label{wxnotebookgetpageimage} + +\constfunc{int}{GetPageImage}{\void} + +Returns the image index for the given page. + +\membersection{wxNotebook::GetPageText}\label{wxnotebookgetpagetext} + +\constfunc{wxString}{GetPageText}{\void} + +Returns the string for the given page. + +\membersection{wxNotebook::GetRowCount}\label{wxnotebookgetrowcount} + +\constfunc{int}{GetRowCount}{\void} + +Returns the number of rows in the notebook control. + +\membersection{wxNotebook::GetSelection}\label{wxnotebookgetselection} + +\constfunc{int}{GetSelection}{\void} + +Returns the currently selected page, or -1 if none was selected. + +\membersection{wxNotebook::InsertPage}\label{wxnotebookinsertpage} + +\func{bool}{InsertPage}{\param{int}{ index}, \param{wxNotebookPage*}{ page}, + \param{const wxString\&}{ text}, + \param{bool}{ select = FALSE}, + \param{int}{ imageId = -1}} + +Inserts a new page at the specified position. + +\wxheading{Parameters} + +\docparam{index}{Specifies the position for the new page.} + +\docparam{page}{Specifies the new page.} + +\docparam{text}{Specifies the text for the new page.} + +\docparam{select}{Specifies whether the page should be selected.} + +\docparam{imageId}{Specifies the optional image index for the new page.} + +\wxheading{Return value} + +TRUE if successful, FALSE otherwise. + +\wxheading{Remarks} + +Do not delete the page, it will be deleted by the notebook. + +\wxheading{See also} + +\helpref{wxNotebook::AddPage}{wxnotebookaddpage} + +\membersection{wxNotebook::OnSelChange}\label{wxnotebookonselchange} + +\func{void}{OnSelChange}{\param{wxNotebookEvent\&}{ event}} + +An event handler function, called when the page selection is changed. + +\wxheading{See also} + +\helpref{wxNotebookEvent}{wxnotebookevent} + +\membersection{wxNotebook::SetImageList}\label{wxnotebooksetimagelist} + +\func{void}{SetImageList}{\param{wxImageList*}{ imageList}} + +Sets the image list for the page control. + +\wxheading{See also} + +\helpref{wxImageList}{wximagelist} + +\membersection{wxNotebook::SetPadding}\label{wxnotebooksetpadding} + +\func{void}{SetPadding}{\param{const wxSize\&}{ padding}} + +Sets the amount of space around each page's icon and label, in pixels. + +\membersection{wxNotebook::SetPageSize}\label{wxnotebooksetpagesize} + +\func{void}{SetPageSize}{\param{const wxSize\&}{ size}} + +Sets the width and height of the pages. + +\membersection{wxNotebook::SetPageImage}\label{wxnotebooksetpageimage} + +\func{bool}{SetPageImage}{\param{int}{ page}, \param{int }{image}} + +Sets the image index for the given page. {\it image} is an index into +the image list which was set with \helpref{wxNotebook::SetImageList}{wxnotebooksetimagelist}. + +\membersection{wxNotebook::SetPageText}\label{wxnotebooksetpagetext} + +\func{bool}{SetPageText}{\param{int}{ page}, \param{const wxString\& }{text}} + +Sets the text for the given page. + +\membersection{wxNotebook::SetSelection}\label{wxnotebooksetselection} + +\func{int}{SetSelection}{\param{int}{ page}} + +Sets the selection for the given page, returning the previous selection. + +\wxheading{See also} + +\helpref{wxNotebook::GetSelection}{wxnotebookgetselection} + + diff --git a/docs/latex/wx/noteevt.tex b/docs/latex/wx/noteevt.tex new file mode 100644 index 0000000000..a8602c5688 --- /dev/null +++ b/docs/latex/wx/noteevt.tex @@ -0,0 +1,66 @@ +\section{\class{wxNotebookEvent}}\label{wxnotebookevent} + +This class represents the events generated by a notebook control. + +\wxheading{Derived from} + +\helpref{wxCommandEvent}{wxcommandevent}\\ +\helpref{wxEvent}{wxevent}\\ +\helpref{wxEvtHandler}{wxevthandler}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Event table macros} + +To process a notebook event, use these event handler macros to direct input to member +functions that take a wxNotebookEvent argument. + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_NOTEBOOK_PAGE_CHANGED(id, func)}}{The page selection was changed. Processes a +wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGED event.} +\twocolitem{{\bf EVT\_NOTEBOOK_PAGE_CHANGING(id, func)}}{The page selection is about to be changed. +Processes a wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING event.} +\end{twocollist}% + +\wxheading{See also} + +\helpref{wxNotebook}{wxnotebook}, \helpref{wxTabCtrl}{wxtabctrl}, \helpref{wxTabEvent}{wxtabevent} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxNotebookEvent::wxNotebookEvent}\label{wxnotebookeventconstr} + +\func{}{wxNotebookEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL}, + \param{int}{ id = 0}, \param{int}{ sel = -1}, \param{int}{ oldSel = -1}} + +Constructor. + +\membersection{wxNotebookEvent::GetOldSelection}\label{wxnotebookeventgetoldselection} + +\constfunc{int}{GetOldSelection}{\void} + +Returns the page that was selected before the change, -1 if none was selected. + +\membersection{wxNotebookEvent::GetSelection}\label{wxnotebookeventgetselection} + +\constfunc{int}{GetSelection}{\void} + +Returns the currently selected page, or -1 if none was selected. + +\membersection{wxNotebookEvent::SetOldSelection}\label{wxnotebookeventsetoldselection} + +\func{void}{SetOldSelection}{\param{int}{ page}} + +Sets the id of the page selected before the change. + +\membersection{wxNotebookEvent::SetSelection}\label{wxnotebookeventsetselection} + +\func{void}{SetSelection}{\param{int}{ page}} + +Sets the selection member variable. + +\wxheading{See also} + +\helpref{wxNotebookEvent::GetSelection}{wxnotebookeventgetselection} + + diff --git a/docs/latex/wx/process.tex b/docs/latex/wx/process.tex index 160d34e1b2..ee84b0e404 100644 --- a/docs/latex/wx/process.tex +++ b/docs/latex/wx/process.tex @@ -15,7 +15,8 @@ isn't overriden. \func{}{wxProcess}{\param{wxEvtHandler *}{ parent = NULL}, \param{int}{ id = -1}} Constructs a process object. {\it id} is only used in the case you want to -use wxWindows events. +use wxWindows events. It identifies this object, or another window that will +receive the event. \wxheading{Parameters} @@ -37,3 +38,4 @@ It is called when the process with the pid {\it pid} finishes. It raises a wxWindows event when it isn't overriden. \docparam{pid}{The pid of the process which ends.} + diff --git a/docs/latex/wx/procevt.tex b/docs/latex/wx/procevt.tex new file mode 100644 index 0000000000..32663ecf35 --- /dev/null +++ b/docs/latex/wx/procevt.tex @@ -0,0 +1,52 @@ +\section{\class{wxProcessEvent}}\label{wxprocessevent} + +A process event is sent when a process is terminated. + +\wxheading{Derived from} + +\helpref{wxEvent}{wxevent}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Event table macros} + +To process a wxProcessEvent, use these event handler macros to direct input to a member +function that takes a wxProcessEvent argument. + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_END\_PROCESS(id, func)}}{Process a wxEVT\_END\_PROCESS event. +{\it id} is the identifier of the process object (the id passed to the wxProcess constructor) +or a window to receive the event.} +\end{twocollist}% + +\wxheading{See also} + +\helpref{wxProcess}{wxprocess},\rtfsp +\helpref{Event handling overview}{eventhandlingoverview} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxProcessEvent::wxProcessEvent} + +\func{}{wxProcessEvent}{\param{int }{id = 0}, \param{int }{pid = 0}} + +Constructor. Takes a wxProcessObject or window id, and a process id. + +\membersection{wxProcessEvent::m\_pid} + +\member{int}{m\_pid} + +Contains the process id. + +\membersection{wxProcessEvent::GetPid}\label{wxprocesseventgetpid} + +\constfunc{int}{GetPid}{\void} + +Returns the process id. + +\membersection{wxProcessEvent::SetPid}\label{wxprocesseventsetpid} + +\func{void}{SetPid}{\param{int}{ pid}} + +Sets the process id. + diff --git a/docs/latex/wx/tabctrl.tex b/docs/latex/wx/tabctrl.tex index 05aa81886d..f8ded606c1 100644 --- a/docs/latex/wx/tabctrl.tex +++ b/docs/latex/wx/tabctrl.tex @@ -11,7 +11,8 @@ This class represents a tab control, which manages multiple tabs. \wxheading{See also} -\helpref{wxTabEvent}{wxtabevent}, \helpref{wxImageList}{wximagelist} +\helpref{wxTabEvent}{wxtabevent}, \helpref{wxImageList}{wximagelist},\rtfsp +\helpref{wxNotebook}{wxnotebook} \latexignore{\rtfignore{\wxheading{Members}}} @@ -117,7 +118,7 @@ Returns the string for the given tab. \membersection{wxTabCtrl::GetRowCount}\label{wxtabctrlgetrowcount} -\constfunc{bool}{GetRowCount}{\void} +\constfunc{int}{GetRowCount}{\void} Returns the number of rows in the tab control. diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 438d651f49..3a85938a25 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -1347,6 +1347,12 @@ Available only under Windows. Use this function to optimise your scrolling implementations, to minimise the area that must be redrawn. +\membersection{wxWindow::SetAcceleratorTable}\label{wxwindowsetacceleratortable} + +\func{virtual void}{SetAcceleratorTable}{\param{const wxAcceleratorTable\&}{ accel}} + +Sets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxacceleratortable}. + \membersection{wxWindow::SetAutoLayout}\label{wxwindowsetautolayout} \func{void}{SetAutoLayout}{\param{const bool}{ autoLayout}}