X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a91225b27b4416488d299ef10053bb822e6a9bf4..302511a3ca8d831ee26c7dfc47c928e8fed8fef6:/docs/latex/wx/pen.tex?ds=inline diff --git a/docs/latex/wx/pen.tex b/docs/latex/wx/pen.tex index 8f39b78099..afe96443c1 100644 --- a/docs/latex/wx/pen.tex +++ b/docs/latex/wx/pen.tex @@ -24,6 +24,10 @@ colour, a width and a style. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Predefined objects} Objects: @@ -59,10 +63,11 @@ get a pointer to a pen by using the global list of pens {\bf wxThePenList}, and calling the member function {\bf FindOrCreatePen}. See the entry for \helpref{wxPenList}{wxpenlist}. -wxPen uses a reference counting system, so assignments between brushes are very -cheap. You can therefore use actual wxPen objects instead of pointers without -efficiency problems. Once one wxPen object changes its data it will create its -own pen data internally so that other pens, which previously shared the +This class uses \helpref{reference counting and copy-on-write}{trefcount} +internally so that assignments between two instances of this class are very +cheap. You can therefore use actual objects instead of pointers without +efficiency problems. If an instance of this class is changed it will create +its own data internally so that other instances, which previously shared the data using the reference counting, are not affected. %TODO: an overview for wxPen. @@ -154,12 +159,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 @@ -335,17 +338,19 @@ Assignment operator, using \helpref{reference counting}{trefcount}. \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. + + + +%% wxPenList \section{\class{wxPenList}}\label{wxpenlist} @@ -380,6 +385,18 @@ backward compatibility with earlier versions of wxWidgets. \helpref{wxPen}{wxpen} +\wxheading{Derived from} + +No base class + +\wxheading{Include files} + + + +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxPenList::wxPenList}\label{wxpenlistctor} @@ -410,3 +427,4 @@ 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.} +