X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/392751754e224616f01ce454830177b7a2b24b2b..5c35d5c1d984f46d33e8181c907936e96160d795:/docs/latex/wx/pen.tex diff --git a/docs/latex/wx/pen.tex b/docs/latex/wx/pen.tex index 58f8aa6724..8f39b78099 100644 --- a/docs/latex/wx/pen.tex +++ b/docs/latex/wx/pen.tex @@ -1,8 +1,19 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: pen.tex +%% Purpose: wxPen docs +%% Author: +%% Modified by: +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxPen}}\label{wxpen} A pen is a drawing tool for drawing outlines. It is used for drawing lines and painting the outline of rectangles, ellipses, etc. It has a -colour, a width and a style. +colour, a width and a style. \wxheading{Derived from} @@ -61,11 +72,11 @@ data using the reference counting, are not affected. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxPen::wxPen}\label{wxpenconstr} +\membersection{wxPen::wxPen}\label{wxpenctor} \func{}{wxPen}{\void} -Default constructor. The pen will be uninitialised, and \helpref{wxPen::Ok}{wxpenok} will +Default constructor. The pen will be uninitialised, and \helpref{wxPen:IsOk}{wxpenisok} will return false. \func{}{wxPen}{\param{const wxColour\&}{ colour}, \param{int}{ width = $1$}, \param{int}{ style = {\tt wxSOLID}}} @@ -82,7 +93,7 @@ Constructs a stippled pen from a stipple bitmap and a width. \func{}{wxPen}{\param{const wxPen\&}{ pen}} -Copy constructor. This uses reference counting so is a cheap operation. +Copy constructor, uses \helpref{reference counting}{trefcount}. \wxheading{Parameters} @@ -138,7 +149,7 @@ is found in the colour database. \end{itemize} } -\membersection{wxPen::\destruct{wxPen}} +\membersection{wxPen::\destruct{wxPen}}\label{wxpendtor} \func{}{\destruct{wxPen}}{\void} @@ -216,7 +227,7 @@ Returns the pen style. \wxheading{See also} -\helpref{wxPen::wxPen}{wxpenconstr}, \helpref{wxPen::SetStyle}{wxpensetstyle} +\helpref{wxPen::wxPen}{wxpenctor}, \helpref{wxPen::SetStyle}{wxpensetstyle} \membersection{wxPen::GetWidth}\label{wxpengetwidth} @@ -228,9 +239,9 @@ Returns the pen width. \helpref{wxPen::SetWidth}{wxpensetwidth} -\membersection{wxPen::Ok}\label{wxpenok} +\membersection{wxPen::IsOk}\label{wxpenisok} -\constfunc{bool}{Ok}{\void} +\constfunc{bool}{IsOk}{\void} Returns true if the pen is initialised. @@ -251,7 +262,7 @@ Sets the pen cap style, which may be one of {\bf wxCAP\_ROUND}, {\bf wxCAP\_PROJ \func{void}{SetColour}{\param{const wxString\& }{colourName}} -\func{void}{SetColour}{\param{int}{ red}, \param{int}{ green}, \param{int}{ blue}} +\func{void}{SetColour}{\param{unsigned char}{ red}, \param{unsigned char}{ green}, \param{unsigned char}{ blue}} The pen's colour is changed to the given colour. @@ -302,7 +313,7 @@ Set the pen style. \wxheading{See also} -\helpref{wxPen::wxPen}{wxpenconstr} +\helpref{wxPen::wxPen}{wxpenctor} \membersection{wxPen::SetWidth}\label{wxpensetwidth} @@ -318,8 +329,7 @@ Sets the pen width. \func{wxPen\&}{operator $=$}{\param{const wxPen\& }{pen}} -Assignment operator, using reference counting. Returns a reference -to `this'. +Assignment operator, using \helpref{reference counting}{trefcount}. \membersection{wxPen::operator $==$}\label{wxpenequals} @@ -379,12 +389,6 @@ backward compatibility with earlier versions of wxWidgets. Constructor. The application should not construct its own pen list: use the object pointer {\bf wxThePenList}. -\membersection{wxPenList::AddPen}\label{wxpenlistaddpen} - -\func{void}{AddPen}{\param{wxPen*}{ pen}} - -Used internally by wxWidgets to add a pen to the list. - \membersection{wxPenList::FindOrCreatePen}\label{wxpenlistfindorcreatepen} \func{wxPen*}{FindOrCreatePen}{\param{const wxColour\& }{colour}, \param{int}{ width}, \param{int}{ style}} @@ -405,12 +409,4 @@ to the pen list, and returns it. \docparam{width}{Width of pen.} -\docparam{style}{Pen style. See \helpref{wxPen::wxPen}{wxpenconstr} for a list of styles.} - -\membersection{wxPenList::RemovePen}\label{wxpenlistremovepen} - -\func{void}{RemovePen}{\param{wxPen*}{ pen}} - -Used by wxWidgets to remove a pen from the list. - - +\docparam{style}{Pen style. See \helpref{wxPen::wxPen}{wxpenctor} for a list of styles.}