X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc2171bd4c660b8554dae2a1cbf34ff09f3032a6..ddca12cfd9c965963eb63751252000d03a12d9da:/docs/latex/wx/pen.tex diff --git a/docs/latex/wx/pen.tex b/docs/latex/wx/pen.tex index 8d356c4208..ae9677b3ba 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,7 +72,7 @@ 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} @@ -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} @@ -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} @@ -372,19 +383,13 @@ backward compatibility with earlier versions of wxWidgets. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxPenList::wxPenList} +\membersection{wxPenList::wxPenList}\label{wxpenlistctor} \func{void}{wxPenList}{\void} 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 +410,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.}