From c840833a667f3831da3ccfd98439c0c36d8c9835 Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Tue, 23 Mar 2004 20:31:28 +0000 Subject: [PATCH] Misc doc fixes git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_4_BRANCH@26307 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/brush.tex | 1 + docs/latex/wx/checklst.tex | 3 +++ docs/latex/wx/dc.tex | 36 +++++++++++++++++++++++------------- docs/latex/wx/pen.tex | 2 +- docs/latex/wx/window.tex | 2 +- 5 files changed, 29 insertions(+), 15 deletions(-) diff --git a/docs/latex/wx/brush.tex b/docs/latex/wx/brush.tex index f11d4f97da..c7dfa3ae11 100644 --- a/docs/latex/wx/brush.tex +++ b/docs/latex/wx/brush.tex @@ -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.} diff --git a/docs/latex/wx/checklst.tex b/docs/latex/wx/checklst.tex index a66f7c944d..9b6a5dfdcc 100644 --- a/docs/latex/wx/checklst.tex +++ b/docs/latex/wx/checklst.tex @@ -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}\\ diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index f2f55be06f..49b7c0b390 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -592,8 +592,8 @@ Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}). \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.} @@ -601,16 +601,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: @@ -639,6 +643,14 @@ 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} \func{wxColour\&}{GetTextBackground}{\void} @@ -916,12 +928,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: diff --git a/docs/latex/wx/pen.tex b/docs/latex/wx/pen.tex index 5a79e8f523..00bf9999af 100644 --- a/docs/latex/wx/pen.tex +++ b/docs/latex/wx/pen.tex @@ -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}. diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index e707f43d96..0c84f77760 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -1809,7 +1809,7 @@ be treated as damaged.} \membersection{wxWindow::RefreshRect}\label{wxwindowrefreshrect} -\func{virtual void}{Refresh}{\param{const wxRect\& }{rect}} +\func{virtual void}{RefreshRect}{\param{const wxRect\& }{rect}} Redraws the contents of the given rectangle: the area inside it will be repainted.