some doc updates

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@43352 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Benjamin Williams
2006-11-12 16:16:01 +00:00
parent 82c51a8ec9
commit 683b60e9ab
2 changed files with 12 additions and 18 deletions

View File

@@ -5,6 +5,9 @@
\section{\class{wxAuiDockArt}}\label{wxauidockart} \section{\class{wxAuiDockArt}}\label{wxauidockart}
wxAuiDockArt is part of the wxAUI class framework.
See also \helpref{wxAUI overview}{wxauioverview}.
Dock art provider code - a dock provider provides all drawing Dock art provider code - a dock provider provides all drawing
functionality to the wxAui dock manager. This allows the dock functionality to the wxAui dock manager. This allows the dock
manager to have a plugable look-and-feel. manager to have a plugable look-and-feel.

View File

@@ -5,6 +5,9 @@
\section{\class{wxAuiNotebook}}\label{wxauinotebook} \section{\class{wxAuiNotebook}}\label{wxauinotebook}
wxAuiPaneInfo is part of the wxAUI class framework.
See also \helpref{wxAUI overview}{wxauioverview}.
wxAuiNotebook is a notebook control which implements many features common in applications with dockable panes. 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, 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 split the tab window into many different splitter configurations, and toggle through different themes to customize
@@ -39,7 +42,7 @@ Constructor. Creates a wxAuiNotebok control.
\func{bool}{AddPage}{\param{wxWindow* }{page}, \param{const wxString\& }{caption}, \param{bool }{select = false}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}} \func{bool}{AddPage}{\param{wxWindow* }{page}, \param{const wxString\& }{caption}, \param{bool }{select = false}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}}
Adds a page. Adds a page. If the {\it select} parameter is true, calling this will generate a page change event.
\membersection{wxAuiNotebook::Create}\label{wxauinotebookcreate} \membersection{wxAuiNotebook::Create}\label{wxauinotebookcreate}
@@ -51,19 +54,7 @@ Creates the notebook window.
\func{bool}{DeletePage}{\param{size\_t }{page}} \func{bool}{DeletePage}{\param{size\_t }{page}}
Deletes a page at the given index. Deletes a page at the given index. Calling this method will generate a page change event.
\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} \membersection{wxAuiNotebook::GetArtProvider}\label{wxauinotebookgetartprovider}
@@ -87,7 +78,7 @@ Returns the number of pages.
\constfunc{int}{GetPageIndex}{\param{wxWindow* }{page\_wnd}} \constfunc{int}{GetPageIndex}{\param{wxWindow* }{page\_wnd}}
Reurns the page index for the given window. Reurns the page index for the specified window. If the window is not found in the notebook, wxNOT_FOUND is returned.
\membersection{wxAuiNotebook::GetSelection}\label{wxauinotebookgetselection} \membersection{wxAuiNotebook::GetSelection}\label{wxauinotebookgetselection}
@@ -105,7 +96,7 @@ Inserts a page.
\func{bool}{RemovePage}{\param{size\_t }{page}} \func{bool}{RemovePage}{\param{size\_t }{page}}
Removes a page. Removes a page, without deleting the window pointer.
\membersection{wxAuiNotebook::SetArtProvider}\label{wxauinotebooksetartprovider} \membersection{wxAuiNotebook::SetArtProvider}\label{wxauinotebooksetartprovider}
@@ -123,13 +114,13 @@ Sets the bitmap for the page.
\func{bool}{SetPageText}{\param{size\_t }{page}, \param{const wxString\& }{text}} \func{bool}{SetPageText}{\param{size\_t }{page}, \param{const wxString\& }{text}}
Sets the ab label for the page. Sets the tab label for the page.
\membersection{wxAuiNotebook::SetSelection}\label{wxauinotebooksetselection} \membersection{wxAuiNotebook::SetSelection}\label{wxauinotebooksetselection}
\func{size\_t}{SetSelection}{\param{size\_t }{new\_page}} \func{size\_t}{SetSelection}{\param{size\_t }{new\_page}}
Sets the page selection. Sets the page selection. Calling this method will generate a page change event.
\membersection{wxAuiNotebook::SetTabCtrlHeight}\label{wxauinotebooksettabctrlheight} \membersection{wxAuiNotebook::SetTabCtrlHeight}\label{wxauinotebooksettabctrlheight}