X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1a1498c08b07625baa087622e75637a2f15325b6..dc484d491b15355285a89da275c58c2ef247d1f4:/docs/latex/wx/pen.tex diff --git a/docs/latex/wx/pen.tex b/docs/latex/wx/pen.tex index c92c4834be..e4353792b5 100644 --- a/docs/latex/wx/pen.tex +++ b/docs/latex/wx/pen.tex @@ -76,7 +76,7 @@ data using the reference counting, are not affected. \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}}} @@ -93,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} @@ -154,12 +154,10 @@ is found in the colour database. \func{}{\destruct{wxPen}}{\void} Destructor. +See \helpref{reference-counted object destruction}{refcountdestruct} for more info. \wxheading{Remarks} -The destructor may not delete the underlying pen object of the native windowing -system, since wxBrush uses a reference counting system for efficiency. - Although all remaining pens are deleted when the application exits, the application should try to clean up all pens itself. This is because wxWidgets cannot know if a pointer to the pen object is stored in an @@ -239,9 +237,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. @@ -329,24 +327,21 @@ 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} \func{bool}{operator $==$}{\param{const wxPen\& }{pen}} -Equality operator. Two pens are equal if they contain pointers -to the same underlying pen data. It does not compare each attribute, -so two independently-created pens using the same parameters will -fail the test. +Equality operator. +See \helpref{reference-counted object comparison}{refcountequality} for more info. \membersection{wxPen::operator $!=$}\label{wxpennotequals} \func{bool}{operator $!=$}{\param{const wxPen\& }{pen}} -Inequality operator. Two pens are not equal if they contain pointers -to different underlying pen data. It does not compare each attribute. +Inequality operator. +See \helpref{reference-counted object comparison}{refcountequality} for more info. \section{\class{wxPenList}}\label{wxpenlist} @@ -390,12 +385,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}} @@ -417,9 +406,3 @@ to the pen list, and returns it. \docparam{width}{Width of pen.} \docparam{style}{Pen style. See \helpref{wxPen::wxPen}{wxpenctor} 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.