[ 1507795 ] Small doc patch.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39792 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Włodzimierz Skiba 2006-06-19 09:20:16 +00:00
parent d924939be8
commit 410bfc9383
4 changed files with 58 additions and 39 deletions

View File

@ -19,7 +19,12 @@ example) but you will only need to override a single
\wxheading{Derived from}
\helpref{wxVListBox}{wxvlistbox}
\helpref{wxVListBox}{wxvlistbox}\\
\helpref{wxVScrolledWindow}{wxvscrolledwindow}\\
\helpref{wxPanel}{wxpanel}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}

View File

@ -1,3 +1,14 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name: progdlg.tex
%% Purpose: wxProgressDialog documentation
%% Author: wxWidgets Team
%% Modified by:
%% Created: 01.06.03
%% RCS-ID: $Id$
%% Copyright: (c) wxWidgets Team
%% License: wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{\class{wxProgressDialog}}\label{wxprogressdialog}
This class represents a dialog that shows a short message and a
@ -52,10 +63,10 @@ reached.}
\twocolitem{{\bf wxPD\_SMOOTH}}{Causes smooth progress of the gauge control.}
\twocolitem{{\bf wxPD\_CAN\_ABORT}}{This flag tells the dialog that it should have a
"Cancel" button which the user may press. If this happens, the next call to
\helpref{Update()}{wxprogressdialogupdate} will return false.}
\helpref{Update()}{wxprogressdialogupdate} will return false.}
\twocolitem{{\bf wxPD\_CAN\_SKIP}}{This flag tells the dialog that it should have a
"Skip" button which the user may press. If this happens, the next call to
\helpref{Update()}{wxprogressdialogupdate} will return true in its skip parameter.}
\helpref{Update()}{wxprogressdialogupdate} will return true in its skip parameter.}
\twocolitem{{\bf wxPD\_ELAPSED\_TIME}}{This flag tells the dialog that it should show elapsed time (since creating the dialog).}
\twocolitem{{\bf wxPD\_ESTIMATED\_TIME}}{This flag tells the dialog that it should show estimated time.}
\twocolitem{{\bf wxPD\_REMAINING\_TIME}}{This flag tells the dialog that it should show remaining time.}
@ -66,7 +77,7 @@ reached.}
\membersection{wxProgressDialog::\destruct{wxProgressDialog}}\label{wxprogressdialogdtor}
\func{}{\destruct{wxMessageDialog}}{\void}
\func{}{\destruct{wxProgressDialog}}{\void}
Destructor. Deletes the dialog and enables all top level windows.
@ -101,4 +112,3 @@ it is equal to the maximum.}
empty (which is the default) the message is not changed.}
\docparam{skip}{If "Skip" button was pressed since last
\helpref{Update}{wxprogressdialogupdate} call the skip is true.}

View File

@ -31,7 +31,11 @@ event macros may be used with it.
\wxheading{Derived from}
\helpref{wxVScrolledWindow}{wxvscrolledwindow}
\helpref{wxVScrolledWindow}{wxvscrolledwindow}\\
\helpref{wxPanel}{wxpanel}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
@ -170,7 +174,7 @@ may only return $0$ or $1$ however.
\constfunc{int}{GetSelection}{\void}
Get the currently selected item or $-1$ if there is no selection.
Get the currently selected item or {\tt wxNOT\_FOUND} if there is no selection.
\membersection{wxVListBox::GetSelectionBackground}\label{wxvlistboxgetselectionbackground}
@ -376,4 +380,3 @@ This method is only valid for multi selection listboxes.
\wxheading{See also}
\helpref{Select}{wxvlistboxselect}

View File

@ -39,7 +39,10 @@ well as logical coordinates.
\wxheading{Derived from}
\helpref{wxPanel}{wxpanel}
\helpref{wxPanel}{wxpanel}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
@ -296,5 +299,3 @@ Return {\tt true} if we scrolled the window, {\tt false} if nothing was done.
Set the number of lines the window contains: the derived class must
provide the heights for all lines with indices up to the one given here
in its \helpref{OnGetLineHeight()}{wxvscrolledwindowongetlineheight}.