1998-05-20 10:25:30 -04:00
|
|
|
\section{\class{wxDC}}\label{wxdc}
|
|
|
|
|
|
|
|
A wxDC is a {\it device context} onto which graphics and text can be drawn.
|
|
|
|
It is intended to represent a number of output devices in a generic way,
|
1998-06-14 16:48:39 -04:00
|
|
|
so a window can have a device context associated with it, and a printer also has a device context.
|
1998-05-20 10:25:30 -04:00
|
|
|
In this way, the same piece of code may write to a number of different devices,
|
|
|
|
if the device context is used as a parameter.
|
|
|
|
|
2006-01-09 07:25:06 -05:00
|
|
|
Notice that wxDC is an abstract base class and can't be created directly,
|
|
|
|
please use \helpref{wxPaintDC}{wxpaintdc}, \helpref{wxClientDC}{wxclientdc},
|
|
|
|
\helpref{wxWindowDC}{wxwindowdc}, \helpref{wxScreenDC}{wxscreendc},
|
|
|
|
\helpref{wxMemoryDC}{wxmemorydc} or \helpref{wxPrinterDC}{wxprinterdc}.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2000-10-20 12:10:13 -04:00
|
|
|
% VZ: we should really document them instead of this lame excuse, but I don't
|
|
|
|
% have time for it now, when it is done please remove this
|
|
|
|
Please note that in addition to the versions of the methods documented here,
|
|
|
|
there are also versions which accept single {\tt wxPoint} parameter instead of
|
|
|
|
two {\tt wxCoord} ones or {\tt wxPoint} and {\tt wxSize} instead of four of
|
|
|
|
them.
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\wxheading{Derived from}
|
|
|
|
|
|
|
|
\helpref{wxObject}{wxobject}
|
|
|
|
|
1999-02-15 15:41:29 -05:00
|
|
|
\wxheading{Include files}
|
|
|
|
|
|
|
|
<wx/dc.h>
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{Overview}{dcoverview}
|
|
|
|
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::Blit}\label{wxdcblit}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{bool}{Blit}{\param{wxCoord}{ xdest}, \param{wxCoord}{ ydest}, \param{wxCoord}{ width}, \param{wxCoord}{ height},
|
|
|
|
\param{wxDC* }{source}, \param{wxCoord}{ xsrc}, \param{wxCoord}{ ysrc}, \param{int}{ logicalFunc = wxCOPY},
|
2003-01-17 19:16:34 -05:00
|
|
|
\param{bool }{useMask = false}, \param{wxCoord}{ xsrcMask = -1}, \param{wxCoord}{ ysrcMask = -1}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Copy from a source DC to this DC, specifying the destination
|
2001-07-11 06:07:06 -04:00
|
|
|
coordinates, size of area to copy, source DC, source coordinates,
|
|
|
|
logical function, whether to use a bitmap mask, and mask source position.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
\wxheading{Parameters}
|
|
|
|
|
|
|
|
\docparam{xdest}{Destination device context x position.}
|
|
|
|
|
|
|
|
\docparam{ydest}{Destination device context y position.}
|
|
|
|
|
|
|
|
\docparam{width}{Width of source area to be copied.}
|
|
|
|
|
|
|
|
\docparam{height}{Height of source area to be copied.}
|
|
|
|
|
|
|
|
\docparam{source}{Source device context.}
|
|
|
|
|
|
|
|
\docparam{xsrc}{Source device context x position.}
|
|
|
|
|
|
|
|
\docparam{ysrc}{Source device context y position.}
|
|
|
|
|
|
|
|
\docparam{logicalFunc}{Logical function to use: see \helpref{wxDC::SetLogicalFunction}{wxdcsetlogicalfunction}.}
|
|
|
|
|
2003-01-17 19:16:34 -05:00
|
|
|
\docparam{useMask}{If true, Blit does a transparent blit using the mask that is associated with the bitmap
|
2001-07-11 06:07:06 -04:00
|
|
|
selected into the source device context. The Windows implementation does the following if MaskBlt cannot be used:
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
\begin{enumerate}
|
|
|
|
\item Creates a temporary bitmap and copies the destination area into it.
|
|
|
|
\item Copies the source area into the temporary bitmap using the specified logical function.
|
|
|
|
\item Sets the masked area in the temporary bitmap to BLACK by ANDing the
|
|
|
|
mask bitmap with the temp bitmap with the foreground colour set to WHITE
|
|
|
|
and the bg colour set to BLACK.
|
|
|
|
\item Sets the unmasked area in the destination area to BLACK by ANDing the
|
|
|
|
mask bitmap with the destination area with the foreground colour set to BLACK
|
|
|
|
and the background colour set to WHITE.
|
|
|
|
\item ORs the temporary bitmap with the destination area.
|
|
|
|
\item Deletes the temporary bitmap.
|
|
|
|
\end{enumerate}
|
|
|
|
|
|
|
|
This sequence of operations ensures that the source's transparent area need not be black,
|
|
|
|
and logical functions are supported.
|
2001-07-11 06:07:06 -04:00
|
|
|
|
2001-07-11 16:22:44 -04:00
|
|
|
{\bf Note:} on Windows, blitting with masks can be speeded up considerably by compiling
|
2004-05-04 04:27:20 -04:00
|
|
|
wxWidgets with the wxUSE\_DC\_CACHE option enabled. You can also influence whether MaskBlt
|
2001-07-11 06:07:06 -04:00
|
|
|
or the explicit mask blitting code above is used, by using \helpref{wxSystemOptions}{wxsystemoptions} and
|
|
|
|
setting the {\bf no-maskblt} option to 1.
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
}
|
|
|
|
|
2001-07-11 06:07:06 -04:00
|
|
|
\docparam{xsrcMask}{Source x position on the mask. If both xsrcMask and ysrcMask are -1, xsrc and ysrc
|
|
|
|
will be assumed for the mask source position. Currently only implemented on Windows.}
|
|
|
|
|
|
|
|
\docparam{ysrcMask}{Source y position on the mask. If both xsrcMask and ysrcMask are -1, xsrc and ysrc
|
|
|
|
will be assumed for the mask source position. Currently only implemented on Windows.}
|
|
|
|
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\wxheading{Remarks}
|
|
|
|
|
|
|
|
There is partial support for Blit in wxPostScriptDC, under X.
|
|
|
|
|
|
|
|
See \helpref{wxMemoryDC}{wxmemorydc} for typical usage.
|
|
|
|
|
1999-09-02 01:36:39 -04:00
|
|
|
\wxheading{See also}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
\helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask}
|
|
|
|
|
2001-07-11 16:22:44 -04:00
|
|
|
\begin{comment}
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2001-07-11 06:07:06 -04:00
|
|
|
\membersection{wxDC::CacheEnabled}\label{wxdccacheenabled}
|
|
|
|
|
|
|
|
\func{static bool}{CacheEnabled}{\void}
|
|
|
|
|
2003-01-17 19:16:34 -05:00
|
|
|
On supported platforms (currently only Windows), returns true
|
2001-07-11 06:07:06 -04:00
|
|
|
if the DC cache is enabled. The DC cache
|
|
|
|
can speed up the \helpref{Blit}{wxdcblit} operation when
|
|
|
|
drawing a large number of masked bitmaps.
|
|
|
|
|
|
|
|
If using the cache functions in your code, please test for the
|
|
|
|
wxUSE\_DC\_CACHEING preprocessor symbol for portability.
|
|
|
|
|
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{wxDC::EnableCache}{wxdcenablecache}, \helpref{wxDC::ClearCache}
|
2001-07-11 16:22:44 -04:00
|
|
|
\end{comment}
|
2001-07-11 06:07:06 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
\membersection{wxDC::CalcBoundingBox}\label{wxdccalcboundingbox}
|
|
|
|
|
|
|
|
\func{void}{CalcBoundingBox}{\param{wxCoord }{x}, \param{wxCoord }{y}}
|
|
|
|
|
|
|
|
Adds the specified point to the bounding box which can be retrieved with
|
|
|
|
\helpref{MinX}{wxdcminx}, \helpref{MaxX}{wxdcmaxx} and
|
|
|
|
\helpref{MinY}{wxdcminy}, \helpref{MaxY}{wxdcmaxy} functions.
|
|
|
|
|
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{ResetBoundingBox}{wxdcresetboundingbox}
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::Clear}\label{wxdcclear}
|
|
|
|
|
|
|
|
\func{void}{Clear}{\void}
|
|
|
|
|
|
|
|
Clears the device context using the current background brush.
|
|
|
|
|
2001-07-11 16:22:44 -04:00
|
|
|
\begin{comment}
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2001-07-11 06:07:06 -04:00
|
|
|
\membersection{wxDC::ClearCache}\label{wxdcclearcache}
|
|
|
|
|
|
|
|
\func{static void}{ClearCache}{\void}
|
|
|
|
|
|
|
|
On supported platforms (currently only Windows), clears
|
|
|
|
the contents of the DC cache (one bitmap and two Windows device contexts). The DC cache
|
|
|
|
can speed up the \helpref{Blit}{wxdcblit} operation when
|
|
|
|
drawing a large number of masked bitmaps. You should
|
|
|
|
call ClearCache at the end of length DC operations if you wish to only use
|
|
|
|
the cache transiently; you should also call it as your application exits.
|
|
|
|
|
|
|
|
If using the cache functions in your code, please test for the
|
|
|
|
wxUSE\_DC\_CACHEING preprocessor symbol for portability.
|
|
|
|
|
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{wxDC::EnableCache}{wxdcenablecache}, \helpref{wxDC::CacheEnabled}
|
2001-07-11 16:22:44 -04:00
|
|
|
\end{comment}
|
2001-07-11 06:07:06 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2004-12-16 16:24:45 -05:00
|
|
|
\membersection{wxDC::ComputeScaleAndOrigin}\label{wxdccomputescaleandorigin}
|
|
|
|
|
|
|
|
\func{virtual void}{ComputeScaleAndOrigin}{\void}
|
|
|
|
|
|
|
|
Performs all necessary computations for given platform and context type
|
|
|
|
after each change of scale and origin parameters. Usually called automatically
|
|
|
|
internally after such changes.
|
|
|
|
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::CrossHair}\label{wxdccrosshair}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{CrossHair}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Displays a cross hair using the current pen. This is a vertical
|
1998-06-14 16:48:39 -04:00
|
|
|
and horizontal line the height and width of the window, centred
|
1998-05-20 10:25:30 -04:00
|
|
|
on the given point.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DestroyClippingRegion}\label{wxdcdestroyclippingregion}
|
|
|
|
|
|
|
|
\func{void}{DestroyClippingRegion}{\void}
|
|
|
|
|
|
|
|
Destroys the current clipping region so that none of the DC is clipped.
|
|
|
|
See also \helpref{wxDC::SetClippingRegion}{wxdcsetclippingregion}.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DeviceToLogicalX}\label{wxdcdevicetologicalx}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Convert device X coordinate to logical coordinate, using the current
|
|
|
|
mapping mode.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DeviceToLogicalXRel}\label{wxdcdevicetologicalxrel}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Convert device X coordinate to relative logical coordinate, using the current
|
2002-01-29 15:48:07 -05:00
|
|
|
mapping mode but ignoring the x axis orientation.
|
|
|
|
Use this function for converting a width, for example.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DeviceToLogicalY}\label{wxdcdevicetologicaly}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{DeviceToLogicalY}{\param{wxCoord}{ y}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Converts device Y coordinate to logical coordinate, using the current
|
|
|
|
mapping mode.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DeviceToLogicalYRel}\label{wxdcdevicetologicalyrel}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Convert device Y coordinate to relative logical coordinate, using the current
|
2002-01-29 15:48:07 -05:00
|
|
|
mapping mode but ignoring the y axis orientation.
|
|
|
|
Use this function for converting a height, for example.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DrawArc}\label{wxdcdrawarc}
|
|
|
|
|
2003-09-15 07:42:54 -04:00
|
|
|
\func{void}{DrawArc}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ xc}, \param{wxCoord}{ yc}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
1998-08-18 10:54:21 -04:00
|
|
|
Draws an arc of a circle, centred on ({\it xc, yc}), with starting point ({\it x1, y1})
|
1998-05-20 10:25:30 -04:00
|
|
|
and ending at ({\it x2, y2}). The current pen is used for the outline
|
|
|
|
and the current brush for filling the shape.
|
|
|
|
|
1998-08-18 10:54:21 -04:00
|
|
|
The arc is drawn in an anticlockwise direction from the start point to the end point.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-12-14 13:50:32 -05:00
|
|
|
\membersection{wxDC::DrawBitmap}\label{wxdcdrawbitmap}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{DrawBitmap}{\param{const wxBitmap\&}{ bitmap}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{bool}{ transparent}}
|
1998-12-14 13:50:32 -05:00
|
|
|
|
2003-01-17 19:16:34 -05:00
|
|
|
Draw a bitmap on the device context at the specified point. If {\it transparent} is true and the bitmap has
|
1998-12-14 13:50:32 -05:00
|
|
|
a transparency mask, the bitmap will be drawn transparently.
|
|
|
|
|
2000-01-15 05:39:27 -05:00
|
|
|
When drawing a mono-bitmap, the current text foreground colour will be used to draw the foreground
|
2000-01-15 06:46:37 -05:00
|
|
|
of the bitmap (all bits set to 1), and the current text background colour to draw the background
|
2000-03-14 19:21:49 -05:00
|
|
|
(all bits set to 0). See also \helpref{SetTextForeground}{wxdcsettextforeground},
|
2000-01-15 06:46:37 -05:00
|
|
|
\helpref{SetTextBackground}{wxdcsettextbackground} and \helpref{wxMemoryDC}{wxmemorydc}.
|
2000-01-15 05:39:27 -05:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2000-02-17 07:53:36 -05:00
|
|
|
\membersection{wxDC::DrawCheckMark}\label{wxdcdrawcheckmark}
|
|
|
|
|
|
|
|
\func{void}{DrawCheckMark}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
|
|
|
|
|
|
|
|
\func{void}{DrawCheckMark}{\param{const wxRect \&}{rect}}
|
|
|
|
|
|
|
|
Draws a check mark inside the given rectangle.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2002-02-07 18:24:05 -05:00
|
|
|
\membersection{wxDC::DrawCircle}\label{wxdcdrawcircle}
|
|
|
|
|
|
|
|
\func{void}{DrawCircle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ radius}}
|
|
|
|
|
|
|
|
\func{void}{DrawCircle}{\param{const wxPoint\&}{ pt}, \param{wxCoord}{ radius}}
|
|
|
|
|
|
|
|
Draws a circle with the given centre and radius.
|
|
|
|
|
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{DrawEllipse}{wxdcdrawellipse}
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DrawEllipse}\label{wxdcdrawellipse}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{DrawEllipse}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2002-02-07 18:24:05 -05:00
|
|
|
\func{void}{DrawEllipse}{\param{const wxPoint\&}{ pt}, \param{const wxSize\&}{ size}}
|
|
|
|
|
|
|
|
\func{void}{DrawEllipse}{\param{const wxRect\&}{ rect}}
|
|
|
|
|
|
|
|
Draws an ellipse contained in the rectangle specified either with the given top
|
|
|
|
left corner and the given size or directly. The current pen is used for the
|
|
|
|
outline and the current brush for filling the shape.
|
|
|
|
|
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{DrawCircle}{wxdcdrawcircle}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DrawEllipticArc}\label{wxdcdrawellipticarc}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{DrawEllipticArc}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height},
|
1998-05-20 10:25:30 -04:00
|
|
|
\param{double}{ start}, \param{double}{ end}}
|
|
|
|
|
1999-02-19 02:58:02 -05:00
|
|
|
Draws an arc of an ellipse. The current pen is used for drawing the arc and
|
2000-09-01 12:48:25 -04:00
|
|
|
the current brush is used for drawing the pie.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
{\it x} and {\it y} specify the x and y coordinates of the upper-left corner of the rectangle that contains
|
|
|
|
the ellipse.
|
|
|
|
|
1999-02-19 02:58:02 -05:00
|
|
|
{\it width} and {\it height} specify the width and height of the rectangle that contains
|
1998-05-20 10:25:30 -04:00
|
|
|
the ellipse.
|
|
|
|
|
|
|
|
{\it start} and {\it end} specify the start and end of the arc relative to the three-o'clock
|
|
|
|
position from the center of the rectangle. Angles are specified
|
|
|
|
in degrees (360 is a complete circle). Positive values mean
|
|
|
|
counter-clockwise motion. If {\it start} is equal to {\it end}, a
|
|
|
|
complete ellipse will be drawn.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DrawIcon}\label{wxdcdrawicon}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{DrawIcon}{\param{const wxIcon\&}{ icon}, \param{wxCoord}{ x}, \param{wxCoord}{ y}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Draw an icon on the display (does nothing if the device context is PostScript).
|
1998-06-14 16:48:39 -04:00
|
|
|
This can be the simplest way of drawing bitmaps on a window.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2004-11-15 12:58:32 -05:00
|
|
|
\membersection{wxDC::DrawLabel}\label{wxdcdrawlabel}
|
|
|
|
|
|
|
|
\func{virtual void}{DrawLabel}{\param{const wxString\&}{ text},
|
|
|
|
\param{const wxBitmap\&}{ image},
|
|
|
|
\param{const wxRect\&}{ rect},
|
2004-11-18 09:07:49 -05:00
|
|
|
\param{int}{ alignment = wxALIGN\_LEFT | wxALIGN\_TOP},
|
2004-11-15 12:58:32 -05:00
|
|
|
\param{int}{ indexAccel = -1},
|
|
|
|
\param{wxRect *}{rectBounding = NULL}}
|
|
|
|
|
|
|
|
\func{void}{DrawLabel}{\param{const wxString\&}{ text}, \param{const wxRect\&}{ rect},
|
2004-11-18 09:07:49 -05:00
|
|
|
\param{int}{ alignment = wxALIGN\_LEFT | wxALIGN\_TOP},
|
2004-11-15 12:58:32 -05:00
|
|
|
\param{int}{ indexAccel = -1}}
|
|
|
|
|
|
|
|
Draw optional bitmap and the text into the given rectangle and aligns it as specified
|
|
|
|
by alignment parameter; it also will emphasize the character with the given index if
|
|
|
|
it is != -1 and return the bounding rectangle if required.
|
|
|
|
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DrawLine}\label{wxdcdrawline}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{DrawLine}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Draws a line from the first point to the second. The current pen is used
|
2003-08-04 06:14:52 -04:00
|
|
|
for drawing the line. Note that the point $(x2, y2)$ is {\emph not} part of the
|
|
|
|
line and is not drawn by this function (this is consistent with the behaviour
|
|
|
|
of many other toolkits).
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DrawLines}\label{wxdcdrawlines}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{DrawLines}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{DrawLines}{\param{wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Draws lines using an array of {\it points} of size {\it n}, or list of
|
|
|
|
pointers to points, adding the optional offset coordinate. The current
|
|
|
|
pen is used for drawing the lines. The programmer is responsible for
|
|
|
|
deleting the list of points.
|
|
|
|
|
1999-02-19 02:58:02 -05:00
|
|
|
\pythonnote{The wxPython version of this method accepts a Python list
|
|
|
|
of wxPoint objects.}
|
|
|
|
|
2001-04-14 15:46:05 -04:00
|
|
|
\perlnote{The wxPerl version of this method accepts
|
|
|
|
as its first parameter a reference to an array
|
|
|
|
of wxPoint objects.}
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DrawPolygon}\label{wxdcdrawpolygon}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
|
1998-05-20 10:25:30 -04:00
|
|
|
\param{int }{fill\_style = wxODDEVEN\_RULE}}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{DrawPolygon}{\param{wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
|
1998-05-20 10:25:30 -04:00
|
|
|
\param{int }{fill\_style = wxODDEVEN\_RULE}}
|
|
|
|
|
|
|
|
Draws a filled polygon using an array of {\it points} of size {\it n},
|
|
|
|
or list of pointers to points, adding the optional offset coordinate.
|
|
|
|
|
|
|
|
The last argument specifies the fill rule: {\bf wxODDEVEN\_RULE} (the
|
|
|
|
default) or {\bf wxWINDING\_RULE}.
|
|
|
|
|
|
|
|
The current pen is used for drawing the outline, and the current brush
|
|
|
|
for filling the shape. Using a transparent brush suppresses filling.
|
|
|
|
The programmer is responsible for deleting the list of points.
|
|
|
|
|
2004-05-04 04:27:20 -04:00
|
|
|
Note that wxWidgets automatically closes the first and last points.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
1999-02-19 02:58:02 -05:00
|
|
|
\pythonnote{The wxPython version of this method accepts a Python list
|
|
|
|
of wxPoint objects.}
|
|
|
|
|
2001-04-14 15:46:05 -04:00
|
|
|
\perlnote{The wxPerl version of this method accepts
|
|
|
|
as its first parameter a reference to an array
|
|
|
|
of wxPoint objects.}
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
|
|
|
\membersection{wxDC::DrawPolyPolygon}\label{wxdcdrawpolypolygon}
|
|
|
|
|
2004-02-29 18:31:02 -05:00
|
|
|
\func{void}{DrawPolyPolygon}{\param{int}{ n}, \param{int}{ count[]}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
|
|
|
|
\param{int }{fill\_style = wxODDEVEN\_RULE}}
|
|
|
|
|
|
|
|
Draws two or more filled polygons using an array of {\it points}, adding the
|
|
|
|
optional offset coordinates.
|
|
|
|
|
|
|
|
Notice that for the platforms providing a native implementation
|
|
|
|
of this function (Windows and PostScript-based wxDC currently), this is more
|
|
|
|
efficient than using \helpref{DrawPolygon}{wxdcdrawpolygon} in a loop.
|
|
|
|
|
|
|
|
{\it n} specifies the number of polygons to draw, the array {\it count} of size
|
|
|
|
{\it n} specifies the number of points in each of the polygons in the
|
|
|
|
{\it points} array.
|
|
|
|
|
|
|
|
The last argument specifies the fill rule: {\bf wxODDEVEN\_RULE} (the default)
|
|
|
|
or {\bf wxWINDING\_RULE}.
|
|
|
|
|
|
|
|
The current pen is used for drawing the outline, and the current brush for
|
|
|
|
filling the shape. Using a transparent brush suppresses filling.
|
|
|
|
|
|
|
|
The polygons maybe disjoint or overlapping. Each polygon specified in a call to
|
|
|
|
{\bf DrawPolyPolygon} must be closed. Unlike polygons created by the
|
|
|
|
\helpref{DrawPolygon}{wxdcdrawpolygon} member function, the polygons created by
|
|
|
|
{\bf DrawPolyPolygon} are not closed automatically.
|
|
|
|
|
|
|
|
\pythonnote{Not implemented yet}
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2004-02-29 18:31:02 -05:00
|
|
|
\perlnote{Not implemented yet}
|
2004-02-07 08:12:31 -05:00
|
|
|
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DrawPoint}\label{wxdcdrawpoint}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{DrawPoint}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-09-24 03:45:05 -04:00
|
|
|
Draws a point using the color of the current pen. Note that the other properties of the pen are not used, such as width etc..
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DrawRectangle}\label{wxdcdrawrectangle}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{DrawRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Draws a rectangle with the given top left corner, and with the given
|
|
|
|
size. The current pen is used for the outline and the current brush
|
|
|
|
for filling the shape.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\membersection{wxDC::DrawRotatedText}\label{wxdcdrawrotatedtext}
|
|
|
|
|
|
|
|
\func{void}{DrawRotatedText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{double}{ angle}}
|
|
|
|
|
|
|
|
Draws the text rotated by {\it angle} degrees.
|
|
|
|
|
2001-08-23 18:08:58 -04:00
|
|
|
{\bf NB:} Under Win9x only TrueType fonts can be drawn by this function. In
|
|
|
|
particular, a font different from {\tt wxNORMAL\_FONT} should be used as the
|
|
|
|
latter is not a TrueType font. {\tt wxSWISS\_FONT} is an example of a font
|
|
|
|
which is.
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{DrawText}{wxdcdrawtext}
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DrawRoundedRectangle}\label{wxdcdrawroundedrectangle}
|
|
|
|
|
2005-07-26 17:05:58 -04:00
|
|
|
\func{void}{DrawRoundedRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \param{double}{ radius}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Draws a rectangle with the given top left corner, and with the given
|
|
|
|
size. The corners are quarter-circles using the given radius. The
|
|
|
|
current pen is used for the outline and the current brush for filling
|
|
|
|
the shape.
|
|
|
|
|
|
|
|
If {\it radius} is positive, the value is assumed to be the
|
|
|
|
radius of the rounded corner. If {\it radius} is negative,
|
|
|
|
the absolute value is assumed to be the {\it proportion} of the smallest
|
|
|
|
dimension of the rectangle. This means that the corner can be
|
|
|
|
a sensible size relative to the size of the rectangle, and also avoids
|
|
|
|
the strange effects X produces when the corners are too big for
|
|
|
|
the rectangle.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DrawSpline}\label{wxdcdrawspline}
|
|
|
|
|
2005-03-01 04:24:56 -05:00
|
|
|
\func{void}{DrawSpline}{\param{int }{n}, \param{wxPoint }{points[]}}
|
2005-02-27 06:55:01 -05:00
|
|
|
|
|
|
|
Draws a spline between all given control points, using the current
|
|
|
|
pen.
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\func{void}{DrawSpline}{\param{wxList *}{points}}
|
|
|
|
|
|
|
|
Draws a spline between all given control points, using the current
|
2005-02-27 06:55:01 -05:00
|
|
|
pen. Doesn't delete the wxList and contents.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{DrawSpline}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ x3}, \param{wxCoord}{ y3}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Draws a three-point spline using the current pen.
|
|
|
|
|
1999-02-19 02:58:02 -05:00
|
|
|
\pythonnote{The wxPython version of this method accepts a Python list
|
|
|
|
of wxPoint objects.}
|
|
|
|
|
2001-04-14 15:46:05 -04:00
|
|
|
\perlnote{The wxPerl version of this method accepts a reference to an array
|
|
|
|
of wxPoint objects.}
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::DrawText}\label{wxdcdrawtext}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{DrawText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Draws a text string at the specified point, using the current text font,
|
|
|
|
and the current text foreground and background colours.
|
|
|
|
|
|
|
|
The coordinates refer to the top-left corner of the rectangle bounding
|
|
|
|
the string. See \helpref{wxDC::GetTextExtent}{wxdcgettextextent} for how
|
|
|
|
to get the dimensions of a text string, which can be used to position the
|
|
|
|
text more precisely.
|
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
{\bf NB:} under wxGTK the current
|
|
|
|
\helpref{logical function}{wxdcgetlogicalfunction} is used by this function
|
|
|
|
but it is ignored by wxMSW. Thus, you should avoid using logical functions
|
|
|
|
with this function in portable programs.
|
|
|
|
|
2001-07-11 16:22:44 -04:00
|
|
|
\begin{comment}
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2001-07-11 06:07:06 -04:00
|
|
|
\membersection{wxDC::EnableCache}\label{wxdcenablecache}
|
|
|
|
|
|
|
|
\func{static void}{EnableCache}{\param{bool}{ enableCache}}
|
|
|
|
|
|
|
|
On supported platforms (currently only Windows), enables the DC cache
|
|
|
|
which can speed up the \helpref{Blit}{wxdcblit} operation when
|
|
|
|
drawing a large number of masked bitmaps.
|
|
|
|
|
|
|
|
If using the cache functions in your code, please test for the
|
|
|
|
wxUSE\_DC\_CACHEING preprocessor symbol for portability.
|
|
|
|
|
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{wxDC::CacheEnabled}{wxdccacheenabled}, \helpref{wxDC::ClearCache}
|
2001-07-11 16:22:44 -04:00
|
|
|
\end{comment}
|
2001-07-11 06:07:06 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::EndDoc}\label{wxdcenddoc}
|
|
|
|
|
|
|
|
\func{void}{EndDoc}{\void}
|
|
|
|
|
|
|
|
Ends a document (only relevant when outputting to a printer).
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::EndPage}\label{wxdcendpage}
|
|
|
|
|
|
|
|
\func{void}{EndPage}{\void}
|
|
|
|
|
|
|
|
Ends a document page (only relevant when outputting to a printer).
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::FloodFill}\label{wxdcfloodfill}
|
|
|
|
|
2002-04-17 07:48:11 -04:00
|
|
|
\func{bool}{FloodFill}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{const wxColour\&}{ colour}, \param{int}{ style=wxFLOOD\_SURFACE}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2000-08-20 15:56:24 -04:00
|
|
|
Flood fills the device context starting from the given point, using
|
|
|
|
the {\it current brush colour}, and using a style:
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
\begin{itemize}\itemsep=0pt
|
|
|
|
\item wxFLOOD\_SURFACE: the flooding occurs until a colour other than the given colour is encountered.
|
|
|
|
\item wxFLOOD\_BORDER: the area to be flooded is bounded by the given colour.
|
|
|
|
\end{itemize}
|
|
|
|
|
2003-01-17 19:16:34 -05:00
|
|
|
Returns false if the operation failed.
|
2002-04-17 07:48:11 -04:00
|
|
|
|
2002-04-01 16:40:42 -05:00
|
|
|
{\it Note:} The present implementation for non-Windows platforms may fail to find
|
2002-04-17 07:48:11 -04:00
|
|
|
colour borders if the pixels do not match the colour exactly. However the
|
2003-01-17 19:16:34 -05:00
|
|
|
function will still return true.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::GetBackground}\label{wxdcgetbackground}
|
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
\constfunc{const wxBrush\&}{GetBackground}{\void}
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
Gets the brush used for painting the background (see \helpref{wxDC::SetBackground}{wxdcsetbackground}).
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
\membersection{wxDC::GetBackgroundMode}\label{wxdcgetbackgroundmode}
|
|
|
|
|
|
|
|
\constfunc{int}{GetBackgroundMode}{\void}
|
|
|
|
|
|
|
|
Returns the current background mode: {\tt wxSOLID} or {\tt wxTRANSPARENT}.
|
|
|
|
|
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{SetBackgroundMode}{wxdcsetbackgroundmode}
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::GetBrush}\label{wxdcgetbrush}
|
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
\constfunc{const wxBrush\&}{GetBrush}{\void}
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
Gets the current brush (see \helpref{wxDC::SetBrush}{wxdcsetbrush}).
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::GetCharHeight}\label{wxdcgetcharheight}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{GetCharHeight}{\void}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Gets the character height of the currently set font.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::GetCharWidth}\label{wxdcgetcharwidth}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{GetCharWidth}{\void}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Gets the average character width of the currently set font.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-06-14 16:48:39 -04:00
|
|
|
\membersection{wxDC::GetClippingBox}\label{wxdcgetclippingbox}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{GetClippingBox}{\param{wxCoord}{ *x}, \param{wxCoord}{ *y}, \param{wxCoord}{ *width}, \param{wxCoord}{ *height}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Gets the rectangle surrounding the current clipping region.
|
|
|
|
|
1999-02-19 02:58:02 -05:00
|
|
|
\pythonnote{No arguments are required and the four values defining the
|
|
|
|
rectangle are returned as a tuple.}
|
|
|
|
|
2000-12-20 11:10:46 -05:00
|
|
|
\perlnote{This method takes no arguments and returns a four element list
|
2001-11-23 17:08:45 -05:00
|
|
|
{\tt ( x, y, width, height )}}
|
2000-12-20 11:10:46 -05:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::GetFont}\label{wxdcgetfont}
|
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
\constfunc{const wxFont\&}{GetFont}{\void}
|
|
|
|
|
2006-01-02 18:28:36 -05:00
|
|
|
Gets the current font. Notice that even although each device context object has
|
|
|
|
some default font after creation, this method would return a \texttt{wxNullFont}
|
|
|
|
initially and only after calling \helpref{wxDC::SetFont}{wxdcsetfont} a valid
|
|
|
|
font is returned.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::GetLogicalFunction}\label{wxdcgetlogicalfunction}
|
|
|
|
|
|
|
|
\func{int}{GetLogicalFunction}{\void}
|
|
|
|
|
|
|
|
Gets the current logical function (see \helpref{wxDC::SetLogicalFunction}{wxdcsetlogicalfunction}).
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::GetMapMode}\label{wxdcgetmapmode}
|
|
|
|
|
|
|
|
\func{int}{GetMapMode}{\void}
|
|
|
|
|
|
|
|
Gets the {\it mapping mode} for the device context (see \helpref{wxDC::SetMapMode}{wxdcsetmapmode}).
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2004-02-11 18:49:31 -05:00
|
|
|
\membersection{wxDC::GetPartialTextExtents}\label{wxdcgetpartialtextextents}
|
|
|
|
|
|
|
|
\constfunc{bool}{GetPartialTextExtents}{\param{const wxString\& }{text},
|
|
|
|
\param{wxArrayInt\& }{widths}}
|
|
|
|
|
2005-04-08 10:34:30 -04:00
|
|
|
Fills the {\it widths} array with the widths from the beginning of
|
|
|
|
{\it text} to the corresponding character of {\it text}. The generic
|
2004-02-11 18:49:31 -05:00
|
|
|
version simply builds a running total of the widths of each character
|
|
|
|
using \helpref{GetTextExtent}{wxdcgettextextent}, however if the
|
|
|
|
various platforms have a native API function that is faster or more
|
2005-04-08 10:34:30 -04:00
|
|
|
accurate than the generic implementation then it should be used
|
2004-02-11 18:49:31 -05:00
|
|
|
instead.
|
|
|
|
|
|
|
|
\pythonnote{This method only takes the {\it text} parameter and
|
|
|
|
returns a Python list of integers.}
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-10-02 17:30:00 -04:00
|
|
|
\membersection{wxDC::GetPen}\label{wxdcgetpen}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
\constfunc{const wxPen\&}{GetPen}{\void}
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
|
|
|
|
|
2004-10-02 17:30:00 -04:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::GetPixel}\label{wxdcgetpixel}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{bool}{GetPixel}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxColour *}{colour}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2005-06-20 10:43:52 -04:00
|
|
|
Gets in {\it colour} the colour at the specified location.
|
2004-03-23 15:31:28 -05:00
|
|
|
Not available for wxPostScriptDC or wxMetafileDC.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2005-04-08 10:34:30 -04:00
|
|
|
Note that setting a pixel can be done using \helpref{DrawPoint}{wxdcdrawpoint}.
|
|
|
|
|
1999-10-07 18:16:50 -04:00
|
|
|
\pythonnote{For wxPython the wxColour value is returned and is not
|
|
|
|
required as a parameter.}
|
|
|
|
|
2000-12-20 11:10:46 -05:00
|
|
|
\perlnote{This method only takes the parameters {\tt x} and {\tt y} and returns
|
|
|
|
a Wx::Colour value}
|
|
|
|
|
2004-03-23 15:31:28 -05:00
|
|
|
\membersection{wxDC::GetPPI}\label{wxdcgetppi}
|
|
|
|
|
|
|
|
\constfunc{wxSize}{GetPPI}{\void}
|
|
|
|
|
|
|
|
Returns the resolution of the device in pixels per inch.
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::GetSize}\label{wxdcgetsize}
|
|
|
|
|
2004-03-23 15:31:28 -05:00
|
|
|
\constfunc{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-03-23 15:31:28 -05:00
|
|
|
\constfunc{wxSize}{GetSize}{\void}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-03-23 15:31:28 -05:00
|
|
|
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
|
1998-05-20 10:25:30 -04:00
|
|
|
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:
|
|
|
|
|
|
|
|
\begin{verbatim}
|
1999-12-06 04:51:40 -05:00
|
|
|
wxCoord w, h;
|
1998-05-20 10:25:30 -04:00
|
|
|
dc.GetSize(&w, &h);
|
|
|
|
double scaleX=(double)(maxX/w);
|
|
|
|
double scaleY=(double)(maxY/h);
|
|
|
|
dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY));
|
|
|
|
\end{verbatim}
|
|
|
|
|
1999-06-22 02:53:24 -04:00
|
|
|
\pythonnote{In place of a single overloaded method name, wxPython
|
|
|
|
implements the following methods:\par
|
|
|
|
\indented{2cm}{\begin{twocollist}
|
1999-12-25 15:34:56 -05:00
|
|
|
\twocolitem{{\bf GetSize()}}{Returns a wxSize}
|
|
|
|
\twocolitem{{\bf GetSizeTuple()}}{Returns a 2-tuple (width, height)}
|
1999-06-22 02:53:24 -04:00
|
|
|
\end{twocollist}}
|
|
|
|
}
|
1999-02-19 02:58:02 -05:00
|
|
|
|
2000-12-20 11:10:46 -05:00
|
|
|
\perlnote{In place of a single overloaded method, wxPerl uses:\par
|
|
|
|
\indented{2cm}{\begin{twocollist}
|
|
|
|
\twocolitem{{\bf GetSize()}}{Returns a Wx::Size}
|
|
|
|
\twocolitem{{\bf GetSizeWH()}}{Returns a 2-element list
|
2001-11-23 17:08:45 -05:00
|
|
|
{\tt ( width, height )}}
|
2000-12-20 11:10:46 -05:00
|
|
|
\end{twocollist}
|
|
|
|
}}
|
|
|
|
|
2004-03-23 15:31:28 -05:00
|
|
|
\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.
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
|
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
\constfunc{const wxColour\&}{GetTextBackground}{\void}
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{wxdcsettextbackground}).
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::GetTextExtent}\label{wxdcgettextextent}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{GetTextExtent}{\param{const wxString\& }{string}, \param{wxCoord *}{w}, \param{wxCoord *}{h},\\
|
|
|
|
\param{wxCoord *}{descent = NULL}, \param{wxCoord *}{externalLeading = NULL}, \param{wxFont *}{font = NULL}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Gets the dimensions of the string using the currently selected font.
|
|
|
|
\rtfsp{\it string} is the text string to measure, {\it w} and {\it h} are
|
|
|
|
the total width and height respectively, {\it descent} is the
|
|
|
|
dimension from the baseline of the font to the bottom of the
|
|
|
|
descender, and {\it externalLeading} is any extra vertical space added
|
|
|
|
to the font by the font designer (usually is zero).
|
|
|
|
|
|
|
|
The optional parameter {\it font} specifies an alternative
|
|
|
|
to the currently selected font: but note that this does not
|
|
|
|
yet work under Windows, so you need to set a font for
|
|
|
|
the device context first.
|
|
|
|
|
|
|
|
See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}.
|
|
|
|
|
1999-02-19 02:58:02 -05:00
|
|
|
\pythonnote{The following methods are implemented in wxPython:\par
|
|
|
|
\indented{2cm}{\begin{twocollist}
|
1999-12-25 15:34:56 -05:00
|
|
|
\twocolitem{{\bf GetTextExtent(string)}}{Returns a 2-tuple, (width, height)}
|
|
|
|
\twocolitem{{\bf GetFullTextExtent(string, font=NULL)}}{Returns a
|
1999-02-19 02:58:02 -05:00
|
|
|
4-tuple, (width, height, descent, externalLeading) }
|
|
|
|
\end{twocollist}}
|
|
|
|
}
|
|
|
|
|
2000-12-20 11:10:46 -05:00
|
|
|
\perlnote{In wxPerl this method is implemented as
|
|
|
|
{\bf GetTextExtent( string, font = undef )} returning a four element
|
2001-11-23 17:08:45 -05:00
|
|
|
array {\tt ( width, height, descent, externalLeading )}
|
2000-12-20 11:10:46 -05:00
|
|
|
}
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground}
|
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
\constfunc{const wxColour\&}{GetTextForeground}{\void}
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{wxdcsettextforeground}).
|
|
|
|
|
1999-12-11 10:35:34 -05:00
|
|
|
|
|
|
|
\membersection{wxDC::GetUserScale}\label{wxdcgetuserscale}
|
|
|
|
|
|
|
|
\func{void}{GetUserScale}{\param{double}{ *x}, \param{double}{ *y}}
|
|
|
|
|
|
|
|
Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetuserscale}).
|
|
|
|
|
2002-06-07 16:15:28 -04:00
|
|
|
\perlnote{In wxPerl this method takes no arguments and return a two element
|
2001-11-23 17:08:45 -05:00
|
|
|
array {\tt ( x, y )}}
|
1999-12-11 10:35:34 -05:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Converts logical X coordinate to device coordinate, using the current
|
|
|
|
mapping mode.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::LogicalToDeviceXRel}\label{wxdclogicaltodevicexrel}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Converts logical X coordinate to relative device coordinate, using the current
|
2002-01-29 15:48:07 -05:00
|
|
|
mapping mode but ignoring the x axis orientation.
|
|
|
|
Use this for converting a width, for example.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::LogicalToDeviceY}\label{wxdclogicaltodevicey}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{LogicalToDeviceY}{\param{wxCoord}{ y}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Converts logical Y coordinate to device coordinate, using the current
|
|
|
|
mapping mode.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::LogicalToDeviceYRel}\label{wxdclogicaltodeviceyrel}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Converts logical Y coordinate to relative device coordinate, using the current
|
2002-01-29 15:48:07 -05:00
|
|
|
mapping mode but ignoring the y axis orientation.
|
|
|
|
Use this for converting a height, for example.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::MaxX}\label{wxdcmaxx}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{MaxX}{\void}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Gets the maximum horizontal extent used in drawing commands so far.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::MaxY}\label{wxdcmaxy}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{MaxY}{\void}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Gets the maximum vertical extent used in drawing commands so far.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::MinX}\label{wxdcminx}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{MinX}{\void}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Gets the minimum horizontal extent used in drawing commands so far.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::MinY}\label{wxdcminy}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{wxCoord}{MinY}{\void}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Gets the minimum vertical extent used in drawing commands so far.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::Ok}\label{wxdcok}
|
|
|
|
|
|
|
|
\func{bool}{Ok}{\void}
|
|
|
|
|
2003-01-17 19:16:34 -05:00
|
|
|
Returns true if the DC is ok to use.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
\membersection{wxDC::ResetBoundingBox}\label{wxdcresetboundingbox}
|
|
|
|
|
|
|
|
\func{void}{ResetBoundingBox}{\void}
|
|
|
|
|
|
|
|
Resets the bounding box: after a call to this function, the bounding box
|
|
|
|
doesn't contain anything.
|
|
|
|
|
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{CalcBoundingBox}{wxdccalcboundingbox}
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2002-01-29 15:48:07 -05:00
|
|
|
\membersection{wxDC::SetAxisOrientation}\label{wxdcsetaxisorientation}
|
|
|
|
|
|
|
|
\func{void}{SetAxisOrientation}{\param{bool}{ xLeftRight},
|
|
|
|
\param{bool}{ yBottomUp}}
|
|
|
|
|
|
|
|
Sets the x and y axis orientation (i.e., the direction from lowest to
|
2005-03-06 12:16:58 -05:00
|
|
|
highest values on the axis). The default orientation is
|
|
|
|
x axis from left to right and y axis from top down.
|
2002-01-29 15:48:07 -05:00
|
|
|
|
|
|
|
\wxheading{Parameters}
|
|
|
|
|
|
|
|
\docparam{xLeftRight}{True to set the x axis orientation to the natural
|
|
|
|
left to right orientation, false to invert it.}
|
|
|
|
|
|
|
|
\docparam{yBottomUp}{True to set the y axis orientation to the natural
|
|
|
|
bottom up orientation, false to invert it.}
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::SetBackground}\label{wxdcsetbackground}
|
|
|
|
|
|
|
|
\func{void}{SetBackground}{\param{const wxBrush\& }{brush}}
|
|
|
|
|
|
|
|
Sets the current background brush for the DC.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::SetBackgroundMode}\label{wxdcsetbackgroundmode}
|
|
|
|
|
|
|
|
\func{void}{SetBackgroundMode}{\param{int}{ mode}}
|
|
|
|
|
|
|
|
{\it mode} may be one of wxSOLID and wxTRANSPARENT. This setting determines
|
|
|
|
whether text will be drawn with a background colour or not.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2004-09-03 22:44:43 -04:00
|
|
|
\membersection{wxDC::SetBrush}\label{wxdcsetbrush}
|
|
|
|
|
|
|
|
\func{void}{SetBrush}{\param{const wxBrush\& }{brush}}
|
|
|
|
|
|
|
|
Sets the current brush for the DC.
|
|
|
|
|
|
|
|
If the argument is wxNullBrush, the current brush is selected out of the device
|
|
|
|
context, and the original brush restored, allowing the current brush to
|
|
|
|
be destroyed safely.
|
|
|
|
|
|
|
|
See also \helpref{wxBrush}{wxbrush}.
|
|
|
|
|
|
|
|
See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
|
|
|
|
when drawing into a monochrome bitmap.
|
|
|
|
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::SetClippingRegion}\label{wxdcsetclippingregion}
|
|
|
|
|
1999-12-06 04:51:40 -05:00
|
|
|
\func{void}{SetClippingRegion}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2002-02-01 19:40:45 -05:00
|
|
|
\func{void}{SetClippingRegion}{\param{const wxPoint\& }{pt}, \param{const wxSize\& }{sz}}
|
|
|
|
|
|
|
|
\func{void}{SetClippingRegion}{\param{const wxRect\&}{ rect}}
|
|
|
|
|
1998-12-02 15:02:01 -05:00
|
|
|
\func{void}{SetClippingRegion}{\param{const wxRegion\&}{ region}}
|
|
|
|
|
2002-02-01 19:40:45 -05:00
|
|
|
Sets the clipping region for this device context to the intersection of the
|
|
|
|
given region described by the parameters of this method and the previously set
|
|
|
|
clipping region. You should call
|
|
|
|
\helpref{DestroyClippingRegion}{wxdcdestroyclippingregion} if you want to set
|
|
|
|
the clipping region exactly to the region specified.
|
|
|
|
|
|
|
|
The clipping region is an area to which drawing is restricted. Possible uses
|
|
|
|
for the clipping region are for clipping text or for speeding up window redraws
|
|
|
|
when only a known area of the screen is damaged.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
1998-12-02 15:02:01 -05:00
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}, \helpref{wxRegion}{wxregion}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2004-09-03 22:44:43 -04:00
|
|
|
\membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-09-03 22:44:43 -04:00
|
|
|
\func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-09-03 22:44:43 -04:00
|
|
|
Sets the device origin (i.e., the origin in pixels after scaling has been
|
|
|
|
applied).
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-09-03 22:44:43 -04:00
|
|
|
This function may be useful in Windows printing
|
|
|
|
operations for placing a graphic on a page.
|
2000-01-15 06:46:37 -05:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::SetFont}\label{wxdcsetfont}
|
|
|
|
|
|
|
|
\func{void}{SetFont}{\param{const wxFont\& }{font}}
|
|
|
|
|
2002-01-08 19:14:43 -05:00
|
|
|
Sets the current font for the DC. It must be a valid font, in particular you
|
|
|
|
should not pass {\tt wxNullFont} to this method.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
See also \helpref{wxFont}{wxfont}.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::SetLogicalFunction}\label{wxdcsetlogicalfunction}
|
|
|
|
|
|
|
|
\func{void}{SetLogicalFunction}{\param{int}{ function}}
|
|
|
|
|
1998-06-14 16:48:39 -04:00
|
|
|
Sets the current logical function for the device context. This determines how
|
1998-05-20 10:25:30 -04:00
|
|
|
a source pixel (from a pen or brush colour, or source device context if
|
|
|
|
using \helpref{wxDC::Blit}{wxdcblit}) combines with a destination pixel in the
|
|
|
|
current device context.
|
|
|
|
|
|
|
|
The possible values
|
|
|
|
and their meaning in terms of source and destination pixel values are
|
|
|
|
as follows:
|
|
|
|
|
|
|
|
\begin{verbatim}
|
|
|
|
wxAND src AND dst
|
|
|
|
wxAND_INVERT (NOT src) AND dst
|
|
|
|
wxAND_REVERSE src AND (NOT dst)
|
|
|
|
wxCLEAR 0
|
|
|
|
wxCOPY src
|
|
|
|
wxEQUIV (NOT src) XOR dst
|
|
|
|
wxINVERT NOT dst
|
|
|
|
wxNAND (NOT src) OR (NOT dst)
|
|
|
|
wxNOR (NOT src) AND (NOT dst)
|
|
|
|
wxNO_OP dst
|
|
|
|
wxOR src OR dst
|
|
|
|
wxOR_INVERT (NOT src) OR dst
|
|
|
|
wxOR_REVERSE src OR (NOT dst)
|
|
|
|
wxSET 1
|
|
|
|
wxSRC_INVERT NOT src
|
|
|
|
wxXOR src XOR dst
|
|
|
|
\end{verbatim}
|
|
|
|
|
|
|
|
The default is wxCOPY, which simply draws with the current colour.
|
|
|
|
The others combine the current colour and the background using a
|
1999-05-27 09:14:45 -04:00
|
|
|
logical operation. wxINVERT is commonly used for drawing rubber bands or
|
1998-05-20 10:25:30 -04:00
|
|
|
moving outlines, since drawing twice reverts to the original colour.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::SetMapMode}\label{wxdcsetmapmode}
|
|
|
|
|
|
|
|
\func{void}{SetMapMode}{\param{int}{ int}}
|
|
|
|
|
|
|
|
The {\it mapping mode} of the device context defines the unit of
|
|
|
|
measurement used to convert logical units to device units. Note that
|
|
|
|
in X, text drawing isn't handled consistently with the mapping mode; a
|
|
|
|
font is always specified in point size. However, setting the {\it
|
|
|
|
user scale} (see \helpref{wxDC::SetUserScale}{wxdcsetuserscale}) scales the text appropriately. In
|
2002-06-07 16:15:28 -04:00
|
|
|
Windows, scalable TrueType fonts are always used; in X, results depend
|
1998-05-20 10:25:30 -04:00
|
|
|
on availability of fonts, but usually a reasonable match is found.
|
|
|
|
|
2004-03-23 15:31:28 -05:00
|
|
|
The coordinate origin is always at the top left of the screen/printer.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-03-23 15:31:28 -05:00
|
|
|
Drawing to a Windows printer device context uses the current mapping mode,
|
|
|
|
but mapping mode is currently ignored for PostScript output.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
The mapping mode can be one of the following:
|
|
|
|
|
|
|
|
\begin{twocollist}\itemsep=0pt
|
1999-02-05 18:55:04 -05:00
|
|
|
\twocolitem{wxMM\_TWIPS}{Each logical unit is 1/20 of a point, or 1/1440 of
|
1998-05-20 10:25:30 -04:00
|
|
|
an inch.}
|
1999-02-05 18:55:04 -05:00
|
|
|
\twocolitem{wxMM\_POINTS}{Each logical unit is a point, or 1/72 of an inch.}
|
|
|
|
\twocolitem{wxMM\_METRIC}{Each logical unit is 1 mm.}
|
|
|
|
\twocolitem{wxMM\_LOMETRIC}{Each logical unit is 1/10 of a mm.}
|
|
|
|
\twocolitem{wxMM\_TEXT}{Each logical unit is 1 pixel.}
|
1998-05-20 10:25:30 -04:00
|
|
|
\end{twocollist}
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2004-09-03 22:44:43 -04:00
|
|
|
\membersection{wxDC::SetPalette}\label{wxdcsetpalette}
|
|
|
|
|
|
|
|
\func{void}{SetPalette}{\param{const wxPalette\& }{palette}}
|
|
|
|
|
|
|
|
If this is a window DC or memory DC, assigns the given palette to the window
|
|
|
|
or bitmap associated with the DC. If the argument is wxNullPalette, the current
|
|
|
|
palette is selected out of the device context, and the original palette
|
|
|
|
restored.
|
|
|
|
|
|
|
|
See \helpref{wxPalette}{wxpalette} for further details.
|
|
|
|
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::SetPen}\label{wxdcsetpen}
|
|
|
|
|
|
|
|
\func{void}{SetPen}{\param{const wxPen\& }{pen}}
|
|
|
|
|
|
|
|
Sets the current pen for the DC.
|
|
|
|
|
|
|
|
If the argument is wxNullPen, the current pen is selected out of the device
|
|
|
|
context, and the original pen restored.
|
|
|
|
|
2000-01-15 06:46:37 -05:00
|
|
|
See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
|
|
|
|
when drawing into a monochrome bitmap.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::SetTextBackground}\label{wxdcsettextbackground}
|
|
|
|
|
|
|
|
\func{void}{SetTextBackground}{\param{const wxColour\& }{colour}}
|
|
|
|
|
|
|
|
Sets the current text background colour for the DC.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::SetTextForeground}\label{wxdcsettextforeground}
|
|
|
|
|
|
|
|
\func{void}{SetTextForeground}{\param{const wxColour\& }{colour}}
|
|
|
|
|
|
|
|
Sets the current text foreground colour for the DC.
|
|
|
|
|
2000-01-15 06:46:37 -05:00
|
|
|
See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
|
|
|
|
when drawing into a monochrome bitmap.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::SetUserScale}\label{wxdcsetuserscale}
|
|
|
|
|
|
|
|
\func{void}{SetUserScale}{\param{double}{ xScale}, \param{double}{ yScale}}
|
|
|
|
|
|
|
|
Sets the user scaling factor, useful for applications which require
|
|
|
|
`zooming'.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::StartDoc}\label{wxdcstartdoc}
|
|
|
|
|
|
|
|
\func{bool}{StartDoc}{\param{const wxString\& }{message}}
|
|
|
|
|
|
|
|
Starts a document (only relevant when outputting to a printer).
|
2005-01-06 10:51:05 -05:00
|
|
|
Message is a message to show while printing.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\membersection{wxDC::StartPage}\label{wxdcstartpage}
|
|
|
|
|
|
|
|
\func{bool}{StartPage}{\void}
|
|
|
|
|
|
|
|
Starts a document page (only relevant when outputting to a printer).
|
|
|
|
|
2001-07-09 14:31:53 -04:00
|
|
|
\section{\class{wxDCClipper}}\label{wxdcclipper}
|
|
|
|
|
2004-12-11 16:33:17 -05:00
|
|
|
This is a small helper class which sets the specified DC to its constructor
|
2002-06-07 16:15:28 -04:00
|
|
|
clipping region and then automatically destroys it in its destructor. Using
|
2004-12-11 16:33:17 -05:00
|
|
|
it ensures that an unwanted clipping region is not left set on the DC.
|
2001-07-09 14:31:53 -04:00
|
|
|
|
|
|
|
\wxheading{Derived from}
|
|
|
|
|
|
|
|
No base class
|
|
|
|
|
|
|
|
\wxheading{Include files}
|
|
|
|
|
|
|
|
<wx/dc.h>
|
|
|
|
|
|
|
|
\wxheading{See also}
|
|
|
|
|
|
|
|
\helpref{wxDC}{wxdc}
|
|
|
|
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2004-09-30 07:15:59 -04:00
|
|
|
\membersection{wxDCClipper::wxDCClipper}\label{wxdcclipperctor}
|
2001-07-09 14:31:53 -04:00
|
|
|
|
|
|
|
\func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{wxCoord }{x},\param{wxCoord }{y},\param{wxCoord }{w},\param{wxCoord }{h},}
|
|
|
|
|
|
|
|
\func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{const wxRect\&}{ rect}}
|
|
|
|
|
2005-04-08 10:34:30 -04:00
|
|
|
Constructor: sets the clipping region for the given device context to the
|
2001-07-09 14:31:53 -04:00
|
|
|
specified rectangle.
|
|
|
|
|
2004-02-07 08:12:31 -05:00
|
|
|
|
2004-09-30 07:15:59 -04:00
|
|
|
\membersection{wxDCClipper::\destruct{wxDCClipper}}\label{wxdcclipperdtor}
|
2001-07-09 14:31:53 -04:00
|
|
|
|
|
|
|
\func{}{\destruct{wxDCClipper}}{\void}
|
|
|
|
|
2002-06-07 16:15:28 -04:00
|
|
|
Destructor: destroys the clipping region set in the constructor.
|
2001-07-09 14:31:53 -04:00
|
|
|
|