Misc doc fixes
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@26307 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -96,6 +96,7 @@ Copy constructor. This uses reference counting so is a cheap operation.
|
||||
\begin{twocollist}\itemsep=0pt
|
||||
\twocolitem{{\bf wxTRANSPARENT}}{Transparent (no fill).}
|
||||
\twocolitem{{\bf wxSOLID}}{Solid.}
|
||||
\twocolitem{{\bf wxSTIPPLE}}{Uses a bitmap as a stipple.}
|
||||
\twocolitem{{\bf wxBDIAGONAL\_HATCH}}{Backward diagonal hatch.}
|
||||
\twocolitem{{\bf wxCROSSDIAG\_HATCH}}{Cross-diagonal hatch.}
|
||||
\twocolitem{{\bf wxFDIAGONAL\_HATCH}}{Forward diagonal hatch.}
|
||||
|
@@ -7,6 +7,9 @@ class under Windows wxWindows must be compiled with USE\_OWNER\_DRAWN set to 1.
|
||||
|
||||
Only the new functions for this class are documented; see also \helpref{wxListBox}{wxlistbox}.
|
||||
|
||||
Please note that wxCheckListBox uses client data in its implementation,
|
||||
and therefore this is not available to the application.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxListBox}{wxlistbox}\\
|
||||
|
@@ -684,13 +684,12 @@ instead.
|
||||
|
||||
Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
|
||||
|
||||
|
||||
\membersection{wxDC::GetPixel}\label{wxdcgetpixel}
|
||||
|
||||
\func{bool}{GetPixel}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxColour *}{colour}}
|
||||
|
||||
Sets {\it colour} to the colour at the specified location. Windows only; an X implementation
|
||||
is being worked on. Not available for wxPostScriptDC or wxMetafileDC.
|
||||
Sets {\it colour} to the colour at the specified location.
|
||||
Not available for wxPostScriptDC or wxMetafileDC.
|
||||
|
||||
\pythonnote{For wxPython the wxColour value is returned and is not
|
||||
required as a parameter.}
|
||||
@@ -698,17 +697,20 @@ required as a parameter.}
|
||||
\perlnote{This method only takes the parameters {\tt x} and {\tt y} and returns
|
||||
a Wx::Colour value}
|
||||
|
||||
\membersection{wxDC::GetPPI}\label{wxdcgetppi}
|
||||
|
||||
\constfunc{wxSize}{GetPPI}{\void}
|
||||
|
||||
Returns the resolution of the device in pixels per inch.
|
||||
|
||||
\membersection{wxDC::GetSize}\label{wxdcgetsize}
|
||||
|
||||
\func{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}}
|
||||
\constfunc{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}}
|
||||
|
||||
For a PostScript device context, this gets the maximum size of graphics
|
||||
drawn so far on the device context.
|
||||
\constfunc{wxSize}{GetSize}{\void}
|
||||
|
||||
For a Windows printer device context, this gets the horizontal and vertical
|
||||
resolution. It can be used to scale graphics to fit the page when using
|
||||
a Windows printer device context. For example, if {\it maxX} and {\it maxY}\rtfsp
|
||||
This gets the horizontal and vertical resolution in device units. It can be used to scale graphics to fit the page.
|
||||
For example, if {\it maxX} and {\it maxY}\rtfsp
|
||||
represent the maximum horizontal and vertical `pixel' values used in your
|
||||
application, the following code will scale the graphic to fit on the
|
||||
printer page:
|
||||
@@ -737,6 +739,13 @@ implements the following methods:\par
|
||||
\end{twocollist}
|
||||
}}
|
||||
|
||||
\membersection{wxDC::GetSizeMM}\label{wxdcgetsizemm}
|
||||
|
||||
\constfunc{void}{GetSizeMM}{\param{wxCoord *}{width}, \param{wxCoord *}{height}}
|
||||
|
||||
\constfunc{wxSize}{GetSizeMM}{\void}
|
||||
|
||||
Returns the horizontal and vertical resolution in millimetres.
|
||||
|
||||
\membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
|
||||
|
||||
@@ -1038,12 +1047,10 @@ user scale} (see \helpref{wxDC::SetUserScale}{wxdcsetuserscale}) scales the text
|
||||
Windows, scalable TrueType fonts are always used; in X, results depend
|
||||
on availability of fonts, but usually a reasonable match is found.
|
||||
|
||||
Note that the coordinate origin should ideally be selectable, but for
|
||||
now is always at the top left of the screen/printer.
|
||||
The coordinate origin is always at the top left of the screen/printer.
|
||||
|
||||
Drawing to a Windows printer device context under UNIX
|
||||
uses the current mapping mode, but mapping mode is currently ignored for
|
||||
PostScript output.
|
||||
Drawing to a Windows printer device context uses the current mapping mode,
|
||||
but mapping mode is currently ignored for PostScript output.
|
||||
|
||||
The mapping mode can be one of the following:
|
||||
|
||||
|
@@ -28,12 +28,13 @@ No base class
|
||||
|
||||
Virtual destructor for any base class.
|
||||
|
||||
\membersection{wxHelpProvider::Set}\label{wxhelpproviderset}
|
||||
\membersection{wxHelpProvider::AddHelp}\label{wxhelpprovideraddhelp}
|
||||
|
||||
\func{wxHelpProvider*}{Set}{\param{wxHelpProvider* }{helpProvider}}
|
||||
\func{void}{AddHelp}{\param{wxWindowBase* }{window}, \param{const wxString\& }{text}}
|
||||
|
||||
Get/set the current, application-wide help provider. Returns
|
||||
the previous one.
|
||||
Associates the text with the given window or id. Although all help
|
||||
providers have these functions to allow making \helpref{wxWindow::SetHelpText}{wxwindowsethelptext}
|
||||
work, not all of them implement the functions.
|
||||
|
||||
\membersection{wxHelpProvider::Get}\label{wxhelpproviderget}
|
||||
|
||||
@@ -50,24 +51,6 @@ Gets the help string for this window. Its interpretation is dependent on the hel
|
||||
except that empty string always means that no help is associated with
|
||||
the window.
|
||||
|
||||
\membersection{wxHelpProvider::ShowHelp}\label{wxhelpprovidershowhelp}
|
||||
|
||||
\func{bool}{ShowHelp}{\param{wxWindowBase* }{window}}
|
||||
|
||||
Shows help for the given window. Uses \helpref{GetHelp}{wxhelpprovidergethelp} internally if
|
||||
applicable.
|
||||
|
||||
Returns true if it was done, or false if no help was available
|
||||
for this window.
|
||||
|
||||
\membersection{wxHelpProvider::AddHelp}\label{wxhelpprovideraddhelp}
|
||||
|
||||
\func{void}{AddHelp}{\param{wxWindowBase* }{window}, \param{const wxString\& }{text}}
|
||||
|
||||
Associates the text with the given window or id. Although all help
|
||||
providers have these functions to allow making \helpref{wxWindow::SetHelpText}{wxwindowsethelptext}
|
||||
work, not all of them implement the functions.
|
||||
|
||||
\func{void}{AddHelp}{\param{wxWindowID }{id}, \param{const wxString\& }{text}}
|
||||
|
||||
This version associates the given text with all windows with this id.
|
||||
@@ -82,3 +65,20 @@ Removes the association between the window pointer and the help text. This is
|
||||
called by the wxWindow destructor. Without this, the table of help strings will fill up
|
||||
and when window pointers are reused, the wrong help string will be found.
|
||||
|
||||
\membersection{wxHelpProvider::Set}\label{wxhelpproviderset}
|
||||
|
||||
\func{wxHelpProvider*}{Set}{\param{wxHelpProvider* }{helpProvider}}
|
||||
|
||||
Get/set the current, application-wide help provider. Returns
|
||||
the previous one.
|
||||
|
||||
\membersection{wxHelpProvider::ShowHelp}\label{wxhelpprovidershowhelp}
|
||||
|
||||
\func{bool}{ShowHelp}{\param{wxWindowBase* }{window}}
|
||||
|
||||
Shows help for the given window. Uses \helpref{GetHelp}{wxhelpprovidergethelp} internally if
|
||||
applicable.
|
||||
|
||||
Returns true if it was done, or false if no help was available
|
||||
for this window.
|
||||
|
||||
|
@@ -275,7 +275,7 @@ function is called with a NULL array.
|
||||
|
||||
\membersection{wxPen::SetJoin}\label{wxpensetjoin}
|
||||
|
||||
\func{void}{SetJoin}{\param{int}{join\_style}}
|
||||
\func{void}{SetJoin}{\param{int }{join\_style}}
|
||||
|
||||
Sets the pen join style, which may be one of {\bf wxJOIN\_BEVEL}, {\bf wxJOIN\_ROUND} and
|
||||
\rtfsp{\bf wxJOIN\_MITER}. The default is {\bf wxJOIN\_ROUND}.
|
||||
|
@@ -395,7 +395,7 @@ Copy constructor.
|
||||
|
||||
Construct an object from a print dialog data object.
|
||||
|
||||
\membersection{wxPrintDialogData::\destruct{wxprintdialogdata}}
|
||||
\membersection{wxPrintDialogData::\destruct{wxPrintDialogData}}
|
||||
|
||||
\func{}{\destruct{wxPrintDialogData}}{\void}
|
||||
|
||||
|
@@ -2001,7 +2001,7 @@ be treated as damaged.}
|
||||
|
||||
\membersection{wxWindow::RefreshRect}\label{wxwindowrefreshrect}
|
||||
|
||||
\func{void}{Refresh}{\param{const wxRect\& }{rect}}
|
||||
\func{void}{RefreshRect}{\param{const wxRect\& }{rect}}
|
||||
|
||||
Redraws the contents of the given rectangle: the area inside it will be
|
||||
repainted.
|
||||
|
Reference in New Issue
Block a user