sorting support for generic version (patch 1765087 from Bo)

[wxWidgets.git] / docs / latex / wx / region.tex

diff --git a/docs/latex/wx/region.tex b/docs/latex/wx/region.tex
index f12a867b8f94ec396cc9b692301958214b1b1eb1..060b19f31a35f9c2a32cc3accc76ef55b415ba98 100644 (file)
--- 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}
 
@@ -12,6 +28,10 @@ reference counting, so copying and assignment operations are fast.
 
 <wx/region.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxRegionIterator}{wxregioniterator}
@@ -47,8 +67,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 +83,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}
@@ -282,6 +301,10 @@ See \helpref{wxPaintEvent}{wxpaintevent} for an example of use.
 
 <wx/region.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxPaintEvent}{wxpaintevent}