From 8ffbb0f8df8e4c2facffc65c394c8933ac79c3af Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Sun, 12 Nov 2006 12:09:52 +0000 Subject: [PATCH] Manual Version update Filled in a few blanks git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@43337 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/auinotebook.tex | 57 +++++++++++++++-------------------- docs/latex/wx/auitabart.tex | 27 +++++++++++------ docs/latex/wx/collpane.tex | 2 ++ docs/latex/wx/manual.tex | 4 +-- 4 files changed, 46 insertions(+), 44 deletions(-) diff --git a/docs/latex/wx/auinotebook.tex b/docs/latex/wx/auinotebook.tex index 1e17dda5e9..72d5279b20 100644 --- a/docs/latex/wx/auinotebook.tex +++ b/docs/latex/wx/auinotebook.tex @@ -3,18 +3,17 @@ % auibook.h at 11/Nov/06 22:56:01 % - \section{\class{wxAuiNotebook}}\label{wxauinotebook} - -wxAuiNotebook is a notebook control which implements many features common in applications with dockable panes. Specifically, wxAuiNotebook implements functionality which allows the user to rearrange tab order via drag-and-drop, split the tab window into many different spliiter configurations, and toggle through different themes to customize the control's look and feel. - - +wxAuiNotebook is a notebook control which implements many features common in applications with dockable panes. +Specifically, wxAuiNotebook implements functionality which allows the user to rearrange tab order via drag-and-drop, +split the tab window into many different splitter configurations, and toggle through different themes to customize +the control's look and feel. An effort has been made to try to maintain an API as similar to that of wxNotebook. -The default theme that is used is wxAuiDefaultTabArt, which provides a modern, glossy look and feel. The theme can be changed by calling \helpref{wxAuiNotebook::SetArtProvider}{wxauinotebooksetartprovider} - +The default theme that is used is wxAuiDefaultTabArt, which provides a modern, glossy look and feel. +The theme can be changed by calling \helpref{wxAuiNotebook::SetArtProvider}{wxauinotebooksetartprovider}. \wxheading{Derived from} @@ -22,125 +21,119 @@ The default theme that is used is wxAuiDefaultTabArt, which provides a modern, g \wxheading{Include files} - + \wxheading{Data structures} \latexignore{\rtfignore{\wxheading{Members}}} - \membersection{wxAuiNotebook::wxAuiNotebook}\label{wxauinotebookwxauinotebook} \func{}{wxAuiNotebook}{\void} - \func{}{wxAuiNotebook}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxAUI\_NB\_DEFAULT\_STYLE}} -Constructor. Creates a wxAuiNotebok control. - -\membersection{wxAuiNotebook::\destruct{wxAuiNotebook}}\label{wxauinotebookdtor} - -\func{}{\destruct{wxAuiNotebook}}{\void} - +Constructor. Creates a wxAuiNotebok control. \membersection{wxAuiNotebook::AddPage}\label{wxauinotebookaddpage} \func{bool}{AddPage}{\param{wxWindow* }{page}, \param{const wxString\& }{caption}, \param{bool }{select = false}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}} +Adds a page. \membersection{wxAuiNotebook::Create}\label{wxauinotebookcreate} \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}} +Creates the notebook window. \membersection{wxAuiNotebook::DeletePage}\label{wxauinotebookdeletepage} \func{bool}{DeletePage}{\param{size\_t }{page}} - -\membersection{wxAuiNotebook::DoSizing}\label{wxauinotebookdosizing} - -\func{void}{DoSizing}{\void} - +Deletes a page at the given index. \membersection{wxAuiNotebook::FindTab}\label{wxauinotebookfindtab} \func{bool}{FindTab}{\param{wxWindow* }{page}, \param{wxAuiTabCtrl** }{ctrl}, \param{int* }{idx}} +Finds a tab. \membersection{wxAuiNotebook::GetActiveTabCtrl}\label{wxauinotebookgetactivetabctrl} \func{wxAuiTabCtrl*}{GetActiveTabCtrl}{\void} +Returns the active tab. \membersection{wxAuiNotebook::GetArtProvider}\label{wxauinotebookgetartprovider} \constfunc{wxAuiTabArt*}{GetArtProvider}{\void} +Returns the associated art provider. \membersection{wxAuiNotebook::GetPage}\label{wxauinotebookgetpage} \constfunc{wxWindow*}{GetPage}{\param{size\_t }{page\_idx}} +Returns the page specified by the given index. \membersection{wxAuiNotebook::GetPageCount}\label{wxauinotebookgetpagecount} \constfunc{size\_t}{GetPageCount}{\void} +Returns the number of pages. \membersection{wxAuiNotebook::GetPageIndex}\label{wxauinotebookgetpageindex} \constfunc{int}{GetPageIndex}{\param{wxWindow* }{page\_wnd}} +Reurns the page index for the given window. \membersection{wxAuiNotebook::GetSelection}\label{wxauinotebookgetselection} \constfunc{int}{GetSelection}{\void} - -\membersection{wxAuiNotebook::InitNotebook}\label{wxauinotebookinitnotebook} - -\func{void}{InitNotebook}{\param{long }{style}} - +Returns the currently selected page. \membersection{wxAuiNotebook::InsertPage}\label{wxauinotebookinsertpage} \func{bool}{InsertPage}{\param{size\_t }{page\_idx}, \param{wxWindow* }{page}, \param{const wxString\& }{caption}, \param{bool }{select = false}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}} +Inserts a page. \membersection{wxAuiNotebook::RemovePage}\label{wxauinotebookremovepage} \func{bool}{RemovePage}{\param{size\_t }{page}} +Removes a page. \membersection{wxAuiNotebook::SetArtProvider}\label{wxauinotebooksetartprovider} \func{void}{SetArtProvider}{\param{wxAuiTabArt* }{art}} +Sets the art provider to be used by the notebook. \membersection{wxAuiNotebook::SetPageBitmap}\label{wxauinotebooksetpagebitmap} \func{bool}{SetPageBitmap}{\param{size\_t }{page}, \param{const wxBitmap\& }{bitmap}} +Sets the bitmap for the page. \membersection{wxAuiNotebook::SetPageText}\label{wxauinotebooksetpagetext} \func{bool}{SetPageText}{\param{size\_t }{page}, \param{const wxString\& }{text}} +Sets the ab label for the page. \membersection{wxAuiNotebook::SetSelection}\label{wxauinotebooksetselection} \func{size\_t}{SetSelection}{\param{size\_t }{new\_page}} +Sets the page selection. \membersection{wxAuiNotebook::SetTabCtrlHeight}\label{wxauinotebooksettabctrlheight} \func{void}{SetTabCtrlHeight}{\param{int }{height}} -these can be overridden - - -\membersection{wxAuiNotebook::SetWindowStyleFlag}\label{wxauinotebooksetwindowstyleflag} - -\func{void}{SetWindowStyleFlag}{\param{long }{style}} +Sets the tab height. diff --git a/docs/latex/wx/auitabart.tex b/docs/latex/wx/auitabart.tex index 60f6b4b2ab..d535e00258 100644 --- a/docs/latex/wx/auitabart.tex +++ b/docs/latex/wx/auitabart.tex @@ -3,11 +3,9 @@ % auibook.h at 11/Nov/06 22:56:01 % - \section{\class{wxAuiTabArt}}\label{wxauitabart} - -tab art class +Tab art class. \wxheading{Derived from} @@ -15,84 +13,93 @@ No base class \wxheading{Include files} - + \wxheading{Data structures} \latexignore{\rtfignore{\wxheading{Members}}} - \membersection{wxAuiTabArt::wxAuiTabArt}\label{wxauitabartwxauitabart} \func{}{wxAuiTabArt}{\void} - -\membersection{wxAuiTabArt::\destruct{wxAuiTabArt}}\label{wxauitabartdtor} - -\func{}{\destruct{wxAuiTabArt}}{\void} - +Constructor. \membersection{wxAuiTabArt::Clone}\label{wxauitabartclone} \func{wxAuiTabArt*}{Clone}{\void} +Clones the art object. \membersection{wxAuiTabArt::DrawBackground}\label{wxauitabartdrawbackground} \func{void}{DrawBackground}{\param{wxDC\& }{dc}, \param{wxWindow* }{wnd}, \param{const wxRect\& }{rect}} +Draws a background on the given area. \membersection{wxAuiTabArt::DrawButton}\label{wxauitabartdrawbutton} \func{void}{DrawButton}{\param{wxDC\& }{dc}, \param{wxWindow* }{wnd}, \param{const wxRect\& }{in\_rect}, \param{int }{bitmap\_id}, \param{int }{button\_state}, \param{int }{orientation}, \param{const wxBitmap\& }{bitmap\_override}, \param{wxRect* }{out\_rect}} +Draws a button. \membersection{wxAuiTabArt::DrawTab}\label{wxauitabartdrawtab} \func{void}{DrawTab}{\param{wxDC\& }{dc}, \param{wxWindow* }{wnd}, \param{const wxRect\& }{in\_rect}, \param{const wxString\& }{caption}, \param{const wxBitmap\& }{bitmap}, \param{bool }{active}, \param{int }{close\_button\_state}, \param{wxRect* }{out\_tab\_rect}, \param{wxRect* }{out\_button\_rect}, \param{int* }{x\_extent}} +Draws a tab. \membersection{wxAuiTabArt::GetBestTabCtrlSize}\label{wxauitabartgetbesttabctrlsize} \func{int}{GetBestTabCtrlSize}{\param{wxWindow* }{wnd}, \param{wxAuiNotebookPageArray\& }{pages}} +Returns the tab control size. \membersection{wxAuiTabArt::GetIndentSize}\label{wxauitabartgetindentsize} \func{int}{GetIndentSize}{\void} +Returns the indent size. \membersection{wxAuiTabArt::GetTabSize}\label{wxauitabartgettabsize} \func{wxSize}{GetTabSize}{\param{wxDC\& }{dc}, \param{wxWindow* }{wnd}, \param{const wxString\& }{caption}, \param{const wxBitmap\& }{bitmap}, \param{bool }{active}, \param{int }{close\_button\_state}, \param{int* }{x\_extent}} +Returns the tab size for the given caption, bitmap and state. \membersection{wxAuiTabArt::SetFlags}\label{wxauitabartsetflags} \func{void}{SetFlags}{\param{unsigned int }{flags}} +Sets flags. \membersection{wxAuiTabArt::SetMeasuringFont}\label{wxauitabartsetmeasuringfont} \func{void}{SetMeasuringFont}{\param{const wxFont\& }{font}} +Sets the font used for calculating measurements. \membersection{wxAuiTabArt::SetNormalFont}\label{wxauitabartsetnormalfont} \func{void}{SetNormalFont}{\param{const wxFont\& }{font}} +Sets the normal font for drawing labels. \membersection{wxAuiTabArt::SetSelectedFont}\label{wxauitabartsetselectedfont} \func{void}{SetSelectedFont}{\param{const wxFont\& }{font}} +Sets the font for drawing text for selected UI elements. \membersection{wxAuiTabArt::SetSizingInfo}\label{wxauitabartsetsizinginfo} \func{void}{SetSizingInfo}{\param{const wxSize\& }{tab\_ctrl\_size}, \param{size\_t }{tab\_count}} +Sets sizing information. \membersection{wxAuiTabArt::ShowWindowList}\label{wxauitabartshowwindowlist} \func{int}{ShowWindowList}{\param{wxWindow* }{wnd}, \param{const wxArrayString\& }{items}, \param{int }{active\_idx}} +Pops up a menu to show the list of windows managed by wxAui. + diff --git a/docs/latex/wx/collpane.tex b/docs/latex/wx/collpane.tex index 1eccbe335f..4aa80a4e33 100644 --- a/docs/latex/wx/collpane.tex +++ b/docs/latex/wx/collpane.tex @@ -26,6 +26,7 @@ would automatically get resized each time the user expands or collapse the pane resulting usually in a weird, flickering effect. Usage sample: + \begin{verbatim} wxCollapsiblePane *collpane = new wxCollapsiblePane(this, wxID_ANY, wxT("Details:")); @@ -161,3 +162,4 @@ Same as \texttt{\helpref{Collapse}{wxcollapsiblepanecollapse}(false)}. Returns a pointer to the pane window. Add controls to the returned \helpref{wxWindow}{wxwindow} to make them collapsible. + diff --git a/docs/latex/wx/manual.tex b/docs/latex/wx/manual.tex index 8932a391c3..63e0bbd7ba 100644 --- a/docs/latex/wx/manual.tex +++ b/docs/latex/wx/manual.tex @@ -26,13 +26,13 @@ %\special{!/@scaleunit 1 def} \parskip=10pt \parindent=0pt -\title{wxWidgets 2.7.2: A portable C++ and Python GUI toolkit} +\title{wxWidgets 2.8.0: A portable C++ and Python GUI toolkit} \winhelponly{\author{by Julian Smart et al %\winhelponly{\\$$\image{1cm;0cm}{wxwin.wmf}$$} }} \winhelpignore{\author{Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al} -\date{October, 2006} +\date{November, 2006} } \makeindex \begin{document} -- 2.47.2