X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4c2752843a35456778402aa200e48058455182d8..917be7ed065337e8a7a67615969ecaade9eea809:/docs/latex/wx/dc.tex?ds=inline diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index a9fe39aa7e..c2f28ef4b0 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -31,14 +31,14 @@ them. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxDC::wxDC} +\membersection{wxDC::wxDC}\label{wxdcctor} \func{}{wxDC}{\void} Constructor. -\membersection{wxDC::\destruct{wxDC}} +\membersection{wxDC::\destruct{wxDC}}\label{wxdcdtor} \func{}{\destruct{wxDC}}{\void} @@ -336,6 +336,24 @@ Draw an icon on the display (does nothing if the device context is PostScript). This can be the simplest way of drawing bitmaps on a window. +\membersection{wxDC::DrawLabel}\label{wxdcdrawlabel} + +\func{virtual void}{DrawLabel}{\param{const wxString\&}{ text}, + \param{const wxBitmap\&}{ image}, + \param{const wxRect\&}{ rect}, + \param{int}{ alignment = wxALIGN\_LEFT | wxALIGN\_TOP}, + \param{int}{ indexAccel = -1}, + \param{wxRect *}{rectBounding = NULL}} + +\func{void}{DrawLabel}{\param{const wxString\&}{ text}, \param{const wxRect\&}{ rect}, + \param{int}{ alignment = wxALIGN\_LEFT | wxALIGN\_TOP}, + \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. + + \membersection{wxDC::DrawLine}\label{wxdcdrawline} \func{void}{DrawLine}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}} @@ -575,8 +593,6 @@ function will still return true. \membersection{wxDC::GetBackground}\label{wxdcgetbackground} -\func{wxBrush\&}{GetBackground}{\void} - \constfunc{const wxBrush\&}{GetBackground}{\void} Gets the brush used for painting the background (see \helpref{wxDC::SetBackground}{wxdcsetbackground}). @@ -595,8 +611,6 @@ Returns the current background mode: {\tt wxSOLID} or {\tt wxTRANSPARENT}. \membersection{wxDC::GetBrush}\label{wxdcgetbrush} -\func{wxBrush\&}{GetBrush}{\void} - \constfunc{const wxBrush\&}{GetBrush}{\void} Gets the current brush (see \helpref{wxDC::SetBrush}{wxdcsetbrush}). @@ -631,8 +645,6 @@ rectangle are returned as a tuple.} \membersection{wxDC::GetFont}\label{wxdcgetfont} -\func{wxFont\&}{GetFont}{\void} - \constfunc{const wxFont\&}{GetFont}{\void} Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}). @@ -652,14 +664,6 @@ Gets the current logical function (see \helpref{wxDC::SetLogicalFunction}{wxdcse Gets the {\it mapping mode} for the device context (see \helpref{wxDC::SetMapMode}{wxdcsetmapmode}). -\membersection{wxDC::GetOptimization}\label{wxdcgetoptimization} - -\func{bool}{GetOptimization}{\void} - -Returns true if device context optimization is on. -See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details. - - \membersection{wxDC::GetPartialTextExtents}\label{wxdcgetpartialtextextents} \constfunc{bool}{GetPartialTextExtents}{\param{const wxString\& }{text}, @@ -676,14 +680,14 @@ instead. \pythonnote{This method only takes the {\it text} parameter and returns a Python list of integers.} -\membersection{wxDC::GetPen}\label{wxdcgetpen} -\func{wxPen\&}{GetPen}{\void} +\membersection{wxDC::GetPen}\label{wxdcgetpen} \constfunc{const wxPen\&}{GetPen}{\void} 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}} @@ -749,8 +753,6 @@ Returns the horizontal and vertical resolution in millimetres. \membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground} -\func{wxColour\&}{GetTextBackground}{\void} - \constfunc{const wxColour\&}{GetTextBackground}{\void} Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{wxdcsettextbackground}). @@ -791,14 +793,11 @@ See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}. \membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground} -\func{wxColour\&}{GetTextForeground}{\void} - \constfunc{const wxColour\&}{GetTextForeground}{\void} Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{wxdcsettextforeground}). - \membersection{wxDC::GetUserScale}\label{wxdcgetuserscale} \func{void}{GetUserScale}{\param{double}{ *x}, \param{double}{ *y}} @@ -1052,21 +1051,6 @@ The mapping mode can be one of the following: \end{twocollist} -\membersection{wxDC::SetOptimization}\label{wxsetoptimization} - -\func{void}{SetOptimization}{\param{bool }{optimize}} - -If {\it optimize} is true (the default), this function sets optimization mode on. -This currently means that under X, the device context will not try to set a pen or brush -property if it is known to be set already. This approach can fall down -if non-wxWidgets code is using the same device context or window, for example -when the window is a panel on which the windowing system draws panel items. -The wxWidgets device context 'memory' will now be out of step with reality. - -Setting optimization off, drawing, then setting it back on again, is a trick -that must occasionally be employed. - - \membersection{wxDC::SetPalette}\label{wxdcsetpalette} \func{void}{SetPalette}{\param{const wxPalette\& }{palette}} @@ -1152,7 +1136,7 @@ No base class \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxDCClipper::wxDCClipper} +\membersection{wxDCClipper::wxDCClipper}\label{wxdcclipperctor} \func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{wxCoord }{x},\param{wxCoord }{y},\param{wxCoord }{w},\param{wxCoord }{h},} @@ -1162,7 +1146,7 @@ Constructor: sets the the clipping region for the given device context to the specified rectangle. -\membersection{wxDCClipper::\destruct{wxDCClipper}} +\membersection{wxDCClipper::\destruct{wxDCClipper}}\label{wxdcclipperdtor} \func{}{\destruct{wxDCClipper}}{\void}