Some doc fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@16892 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2002-08-31 16:27:35 +00:00
parent 0653d364dd
commit 0b0625e922
5 changed files with 25 additions and 41 deletions

View File

@@ -1,4 +1,4 @@
\chapter{Constants}\label{functions} \chapter{Constants}\label{constants}
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage} \setfooter{\thepage}{}{}{}{}{\thepage}

View File

@@ -262,6 +262,16 @@ Returns a pointer to the status bar currently associated with the frame (if any)
\helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar} \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}
\membersection{wxFrame::GetStatusBarPane}\label{wxframegetstatusbarpane}
\func{int}{GetStatusBarPane}{\void}
Returns the status bar pane used to display menu and toolbar help.
\wxheading{See also}
\helpref{wxFrame::SetStatusBarPane}{wxframesetstatusbarpane}
\membersection{wxFrame::GetTitle}\label{wxframegettitle} \membersection{wxFrame::GetTitle}\label{wxframegettitle}
\constfunc{wxString}{GetTitle}{\void} \constfunc{wxString}{GetTitle}{\void}
@@ -530,6 +540,13 @@ Associates a status bar with the frame.
\helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar},\rtfsp \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar},\rtfsp
\helpref{wxFrame::GetStatusBar}{wxframegetstatusbar} \helpref{wxFrame::GetStatusBar}{wxframegetstatusbar}
\membersection{wxFrame::SetStatusBarPane}\label{wxframesetstatusbarpane}
\func{void}{SetStatusBarPane}{\param{int}{ n}}
Set the status bar pane used to display menu and toolbar help.
Using -1 disables help display.
\membersection{wxFrame::SetStatusText}\label{wxframesetstatustext} \membersection{wxFrame::SetStatusText}\label{wxframesetstatustext}
\func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{int}{ number = 0}} \func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{int}{ number = 0}}
@@ -624,39 +641,3 @@ This function has not been tested with MDI frames.
\helpref{wxFrame::IsFullScreen}{wxframeisfullscreen} \helpref{wxFrame::IsFullScreen}{wxframeisfullscreen}
\membersection{wxFrame::SetStatusBarPane}\label{wxframesetstatusbarpane}
\func{void}{SetStatusBarPane}{\param{int}{ n}}
Set the status bar pane used to display menu and toolbar help.
Using -1 disables help display.
\membersection{wxFrame::GetStatusBarPane}\label{wxframegetstatusbarpane}
\func{int}{GetStatusBarPane}{\void}
Returns the status bar pane used to display menu and toolbar help.
\wxheading{See also}
\helpref{wxFrame::SetStatusBarPane}{wxframesetstatusbarpane}
\membersection{wxFrame::SetStatusBarPane}\label{wxframesetstatusbarpane}
\func{void}{SetStatusBarPane}{\param{int}{ n}}
Set the status bar pane used to display menu and toolbar help.
Using -1 disables help display.
\membersection{wxFrame::GetStatusBarPane}\label{wxframegetstatusbarpane}
\func{int}{GetStatusBarPane}{\void}
Returns the status bar pane used to display menu and toolbar help.
\wxheading{See also}
\helpref{wxFrame::SetStatusBarPane}{wxframesetstatusbarpane}

View File

@@ -254,7 +254,8 @@ Inserts the object before the given {\it node}.
Returns {\tt TRUE} if the list is empty, {\tt FALSE} otherwise. Returns {\tt TRUE} if the list is empty, {\tt FALSE} otherwise.
\membersection{wxList::Item}\label{wxlistitem} % Use different label name to avoid clashing with wxListItem label
\membersection{wxList::Item}\label{wxlistitemfunc}
\constfunc{wxNode *}{Item}{\param{size\_t }{index}} \constfunc{wxNode *}{Item}{\param{size\_t }{index}}
@@ -272,7 +273,7 @@ Returns the node associated with {\it object} if it is in the list, NULL otherwi
\func{wxNode *}{Nth}{\param{int}{ n}} \func{wxNode *}{Nth}{\param{int}{ n}}
{\bf NB:} This function is deprecated, use \helpref{Item}{wxlistitem} instead. {\bf NB:} This function is deprecated, use \helpref{Item}{wxlistitemfunc} instead.
Returns the {\it nth} node in the list, indexing from zero (NULL if the list is empty Returns the {\it nth} node in the list, indexing from zero (NULL if the list is empty
or the nth node could not be found). or the nth node could not be found).

View File

@@ -130,7 +130,7 @@ The status field string if the field is valid, otherwise the empty string.
\helpref{wxStatusBar::SetStatusText}{wxstatusbarsetstatustext} \helpref{wxStatusBar::SetStatusText}{wxstatusbarsetstatustext}
\membersection{wxStatusBar::PopStatusText}\label{wxstatusbarpushstatustext} \membersection{wxStatusBar::PopStatusText}\label{wxstatusbarpopstatustext}
\func{void}{PopStatusText}{\param{int}{ field = 0}} \func{void}{PopStatusText}{\param{int}{ field = 0}}

View File

@@ -39,7 +39,8 @@ Return the text of the current tip and pass to the next one. This function is
pure virtual, it should be implemented in the derived classes. pure virtual, it should be implemented in the derived classes.
\membersection{wxTipProvider::PreprocessTip}\label{wxtipproviderpreprocesstip} \membersection{wxTipProvider::PreprocessTip}\label{wxtipproviderpreprocesstip}
\funct{virtual wxString}{PreProcessTip}{\param{const wxString\&} {tip}}
\func{virtual wxString}{PreProcessTip}{\param{const wxString\&}{tip}}
Returns a modified tip. This function will be called immediately after read, Returns a modified tip. This function will be called immediately after read,
and before being check whether it is a comment, an empty string or a string and before being check whether it is a comment, an empty string or a string
@@ -59,3 +60,4 @@ The program usually remembers the value returned by this function after calling
\helpref{wxShowTip}{wxshowtip}. Note that it is not the same as the value which \helpref{wxShowTip}{wxshowtip}. Note that it is not the same as the value which
was passed to wxShowTip $+ 1$ because the user might have pressed the "Next" was passed to wxShowTip $+ 1$ because the user might have pressed the "Next"
button in the tip dialog. button in the tip dialog.