X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8a16d7370e3cdc7d583a6f14ab11b3a1d27b73df..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/region.tex diff --git a/docs/latex/wx/region.tex b/docs/latex/wx/region.tex index 4cc3310907..11df532caf 100644 --- a/docs/latex/wx/region.tex +++ b/docs/latex/wx/region.tex @@ -1,7 +1,23 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: region.tex +%% Purpose: wxRegion documentation +%% Author: wxTeam +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxTeam +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxRegion}}\label{wxregion} -A wxRegion represents a simple or complex region on a device context or window. It uses -reference counting, so copying and assignment operations are fast. +A wxRegion represents a simple or complex region on a device context or window. + +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. \wxheading{Derived from} @@ -39,7 +55,7 @@ Constructs a rectangular region a wxRect object. \func{}{wxRegion}{\param{const wxRegion\&}{ region}} -Constructs a region by copying another region. +Copy constructor, uses \helpref{reference counting}{trefcount}. \func{}{wxRegion}{\param{size\_t}{ n}, \param{const wxPoint }{*points}, \param{int }{fillStyle = wxWINDING\_RULE}} @@ -47,8 +63,6 @@ Constructs a region corresponding to the polygon made of {\it n} points in the provided array. {\it fillStyle} parameter may have values {\tt wxWINDING\_RULE} or {\tt wxODDEVEN\_RULE}. -{\bf NB:} This constructor is only implemented for Win32 and GTK+ wxWidgets ports. - \func{}{wxRegion}{\param{const wxBitmap\&}{ bmp}} \func{}{wxRegion}{\param{const wxBitmap\&}{ bmp}, @@ -65,6 +79,7 @@ Constructs a region using the non-transparent pixels of a bitmap. See \func{}{\destruct{wxRegion}}{\void} Destructor. +See \helpref{reference-counted object destruction}{refcountdestruct} for more info. \membersection{wxRegion::Clear}\label{wxregionclear} @@ -260,7 +275,9 @@ for any overlapping areas. The result is stored in this region. \func{void}{operator $=$}{\param{const wxRegion\&}{ region}} -Copies {\it region} by reference counting. +Assignment operator, using \helpref{reference counting}{trefcount}. + + \section{\class{wxRegionIterator}}\label{wxregioniterator}