added documentation stub files for wxAuiNotebook and wxAuiTabArt

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@43321 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2006-11-11 22:04:05 +00:00 · 2006-11-11 22:04:05 +00:00 · c0d9896aef
commit c0d9896aef
parent 3ca1046155
2 changed files with 298 additions and 0 deletions
--- a/docs/latex/wx/auinotebook.tex
+++ b/docs/latex/wx/auinotebook.tex
@ -0,0 +1,200 @@
+%
+% automatically generated by HelpGen $Revision$ from
+% auibook.h at 11/Nov/06 22:56:01
+%
+
+
+\section{\class{wxAuiNotebook}}\label{wxauinotebook}
+
+\wxheading{Derived from}
+
+\helpref{wxControl}{wxcontrol}
+
+\wxheading{Include files}
+
+<auibook.h>
+
+\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}}
+
+
+\membersection{wxAuiNotebook::\destruct{wxAuiNotebook}}\label{wxauinotebookdtor}
+
+\func{}{\destruct{wxAuiNotebook}}{\void}
+
+
+\membersection{wxAuiNotebook::AddPage}\label{wxauinotebookaddpage}
+
+\func{bool}{AddPage}{\param{wxWindow* }{page}, \param{const wxString\& }{caption}, \param{bool }{select = false}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}}
+
+
+\membersection{wxAuiNotebook::CalculateTabCtrlHeight}\label{wxauinotebookcalculatetabctrlheight}
+
+\func{int}{CalculateTabCtrlHeight}{\void}
+
+
+\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}}
+
+
+\membersection{wxAuiNotebook::DeletePage}\label{wxauinotebookdeletepage}
+
+\func{bool}{DeletePage}{\param{size\_t }{page}}
+
+
+\membersection{wxAuiNotebook::DoSizing}\label{wxauinotebookdosizing}
+
+\func{void}{DoSizing}{\void}
+
+
+\membersection{wxAuiNotebook::FindTab}\label{wxauinotebookfindtab}
+
+\func{bool}{FindTab}{\param{wxWindow* }{page}, \param{wxAuiTabCtrl** }{ctrl}, \param{int* }{idx}}
+
+
+\membersection{wxAuiNotebook::GetActiveTabCtrl}\label{wxauinotebookgetactivetabctrl}
+
+\func{wxAuiTabCtrl*}{GetActiveTabCtrl}{\void}
+
+
+\membersection{wxAuiNotebook::GetArtProvider}\label{wxauinotebookgetartprovider}
+
+\constfunc{wxAuiTabArt*}{GetArtProvider}{\void}
+
+
+\membersection{wxAuiNotebook::GetPage}\label{wxauinotebookgetpage}
+
+\constfunc{wxWindow*}{GetPage}{\param{size\_t }{page\_idx}}
+
+
+\membersection{wxAuiNotebook::GetPageCount}\label{wxauinotebookgetpagecount}
+
+\constfunc{size\_t}{GetPageCount}{\void}
+
+
+\membersection{wxAuiNotebook::GetPageIndex}\label{wxauinotebookgetpageindex}
+
+\constfunc{int}{GetPageIndex}{\param{wxWindow* }{page\_wnd}}
+
+
+\membersection{wxAuiNotebook::GetSelection}\label{wxauinotebookgetselection}
+
+\constfunc{int}{GetSelection}{\void}
+
+
+\membersection{wxAuiNotebook::GetTabCtrlFromPoint}\label{wxauinotebookgettabctrlfrompoint}
+
+\func{wxAuiTabCtrl*}{GetTabCtrlFromPoint}{\param{const wxPoint\& }{pt}}
+
+
+\membersection{wxAuiNotebook::GetTabFrameFromTabCtrl}\label{wxauinotebookgettabframefromtabctrl}
+
+\func{wxWindow*}{GetTabFrameFromTabCtrl}{\param{wxWindow* }{tab\_ctrl}}
+
+
+\membersection{wxAuiNotebook::InitNotebook}\label{wxauinotebookinitnotebook}
+
+\func{void}{InitNotebook}{\param{long }{style}}
+
+
+\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}}
+
+
+\membersection{wxAuiNotebook::OnChildFocus}\label{wxauinotebookonchildfocus}
+
+\func{void}{OnChildFocus}{\param{wxChildFocusEvent\& }{evt}}
+
+
+\membersection{wxAuiNotebook::OnEraseBackground}\label{wxauinotebookonerasebackground}
+
+\func{void}{OnEraseBackground}{\param{wxEraseEvent\& }{evt}}
+
+
+\membersection{wxAuiNotebook::OnRender}\label{wxauinotebookonrender}
+
+\func{void}{OnRender}{\param{wxAuiManagerEvent\& }{evt}}
+
+
+\membersection{wxAuiNotebook::OnSize}\label{wxauinotebookonsize}
+
+\func{void}{OnSize}{\param{wxSizeEvent\& }{evt}}
+
+
+\membersection{wxAuiNotebook::OnTabBeginDrag}\label{wxauinotebookontabbegindrag}
+
+\func{void}{OnTabBeginDrag}{\param{wxCommandEvent\& }{evt}}
+
+
+\membersection{wxAuiNotebook::OnTabButton}\label{wxauinotebookontabbutton}
+
+\func{void}{OnTabButton}{\param{wxCommandEvent\& }{evt}}
+
+
+\membersection{wxAuiNotebook::OnTabClicked}\label{wxauinotebookontabclicked}
+
+\func{void}{OnTabClicked}{\param{wxCommandEvent\& }{evt}}
+
+
+\membersection{wxAuiNotebook::OnTabDragMotion}\label{wxauinotebookontabdragmotion}
+
+\func{void}{OnTabDragMotion}{\param{wxCommandEvent\& }{evt}}
+
+
+\membersection{wxAuiNotebook::OnTabEndDrag}\label{wxauinotebookontabenddrag}
+
+\func{void}{OnTabEndDrag}{\param{wxCommandEvent\& }{evt}}
+
+
+\membersection{wxAuiNotebook::RemoveEmptyTabFrames}\label{wxauinotebookremoveemptytabframes}
+
+\func{void}{RemoveEmptyTabFrames}{\void}
+
+
+\membersection{wxAuiNotebook::RemovePage}\label{wxauinotebookremovepage}
+
+\func{bool}{RemovePage}{\param{size\_t }{page}}
+
+
+\membersection{wxAuiNotebook::SetArtProvider}\label{wxauinotebooksetartprovider}
+
+\func{void}{SetArtProvider}{\param{wxAuiTabArt* }{art}}
+
+
+\membersection{wxAuiNotebook::SetPageBitmap}\label{wxauinotebooksetpagebitmap}
+
+\func{bool}{SetPageBitmap}{\param{size\_t }{page}, \param{const wxBitmap\& }{bitmap}}
+
+
+\membersection{wxAuiNotebook::SetPageText}\label{wxauinotebooksetpagetext}
+
+\func{bool}{SetPageText}{\param{size\_t }{page}, \param{const wxString\& }{text}}
+
+
+\membersection{wxAuiNotebook::SetSelection}\label{wxauinotebooksetselection}
+
+\func{size\_t}{SetSelection}{\param{size\_t }{new\_page}}
+
+
+\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}}
+
--- a/docs/latex/wx/auitabart.tex
+++ b/docs/latex/wx/auitabart.tex
@ -0,0 +1,98 @@
+%
+% automatically generated by HelpGen $Revision$ from
+% auibook.h at 11/Nov/06 22:56:01
+%
+
+
+\section{\class{wxAuiTabArt}}\label{wxauitabart}
+
+
+tab art class
+
+\wxheading{Derived from}
+
+No base class
+
+\wxheading{Include files}
+
+<auibook.h>
+
+\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}
+
+
+\membersection{wxAuiTabArt::Clone}\label{wxauitabartclone}
+
+\func{wxAuiTabArt*}{Clone}{\void}
+
+
+\membersection{wxAuiTabArt::DrawBackground}\label{wxauitabartdrawbackground}
+
+\func{void}{DrawBackground}{\param{wxDC\& }{dc}, \param{wxWindow* }{wnd}, \param{const wxRect\& }{rect}}
+
+
+\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}}
+
+
+\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}}
+
+
+\membersection{wxAuiTabArt::GetBestTabCtrlSize}\label{wxauitabartgetbesttabctrlsize}
+
+\func{int}{GetBestTabCtrlSize}{\param{wxWindow* }{wnd}, \param{wxAuiNotebookPageArray\& }{pages}}
+
+
+\membersection{wxAuiTabArt::GetIndentSize}\label{wxauitabartgetindentsize}
+
+\func{int}{GetIndentSize}{\void}
+
+
+\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}}
+
+
+\membersection{wxAuiTabArt::SetFlags}\label{wxauitabartsetflags}
+
+\func{void}{SetFlags}{\param{unsigned int }{flags}}
+
+
+\membersection{wxAuiTabArt::SetMeasuringFont}\label{wxauitabartsetmeasuringfont}
+
+\func{void}{SetMeasuringFont}{\param{const wxFont\& }{font}}
+
+
+\membersection{wxAuiTabArt::SetNormalFont}\label{wxauitabartsetnormalfont}
+
+\func{void}{SetNormalFont}{\param{const wxFont\& }{font}}
+
+
+\membersection{wxAuiTabArt::SetSelectedFont}\label{wxauitabartsetselectedfont}
+
+\func{void}{SetSelectedFont}{\param{const wxFont\& }{font}}
+
+
+\membersection{wxAuiTabArt::SetSizingInfo}\label{wxauitabartsetsizinginfo}
+
+\func{void}{SetSizingInfo}{\param{const wxSize\& }{tab\_ctrl\_size}, \param{size\_t }{tab\_count}}
+
+
+\membersection{wxAuiTabArt::ShowWindowList}\label{wxauitabartshowwindowlist}
+
+\func{int}{ShowWindowList}{\param{wxWindow* }{wnd}, \param{const wxArrayString\& }{items}, \param{int }{active\_idx}}
+