Mirrors_UI_SDK/wxWidgets
1
0
Fork 0
mirror of https://github.com/wxWidgets/wxWidgets.git synced 2026-09-25 08:54:19 +08:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Finished initial review of [q-r] by Utensil Candel also making the enumeration lists more readable (one per line).

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54308 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-06-21 02:38:44 +00:00
parent b8c57d7f0e
commit bbc5b7f897
7 changed files with 568 additions and 204 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/doxygen/Doxyfile_inc
+1 -1
View File
@@ -270,7 +270,7 @@ GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
ENUM_VALUES_PER_LINE = 1
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
docs/doxygen/mainpages/platdetails.h
+2 -2
View File
@@ -94,7 +94,7 @@ in the distribution.
@section page_port_wxmac wxCocoa
@section page_port_wxcocoa wxCocoa
@htmlonly
<img src="osxleopard_logo.png" alt="Mac OS X (Leopard) logo"
@@ -153,7 +153,7 @@ as the underlying graphics backend. wxX11 draws its widgets
using the wxUniversal widget set which is now part of wxWidgets.
wxX11 is well-suited for a number of special applications such
as those running on systems with few resources (PDAs) or for
applications which need to use a special themed look.
applications which need to use a special themed look.
In order to configure wxWidgets to compile wxX11 you will
need to type:
interface/config.h
+1 -1
View File
@@ -34,7 +34,7 @@
platform.
@li @c <wx/confbase.h> - Base config class.
@li @c <wx/fileconf.h> - wxFileConfig class.
@li @c <wx/msw/regconf.h> - wxRegConfig class.
@li @c <wx/msw/regconf.h> - wxRegConfig class, see also wxRegKey.
@section configbase_example Example
interface/msw/registry.h
+81 -33
View File
@@ -8,7 +8,7 @@
/**
@class wxRegKey
@headerfile registry.h wx/msw/registry.h
@wxheader{msw/registry.h}
wxRegKey is a class representing the Windows registry (it is only available
under Windows). One can create, query and delete registry keys using this
@@ -17,37 +17,80 @@
The Windows registry is easy to understand. There are five registry keys,
namely:
HKEY_CLASSES_ROOT (HKCR)
HKEY_CURRENT_USER (HKCU)
HKEY_LOCAL_MACHINE (HKLM)
HKEY_CURRENT_CONFIG (HKCC)
HKEY_USERS (HKU)
@li HKEY_CLASSES_ROOT (HKCR)
@li HKEY_CURRENT_USER (HKCU)
@li HKEY_LOCAL_MACHINE (HKLM)
@li HKEY_CURRENT_CONFIG (HKCC)
@li HKEY_USERS (HKU)
After creating a key, it can hold a value. The values can be:
String Value
Binary Value
DWORD Value
Multi String Value
Expandable String Value
@li String Value
@li Binary Value
@li DWORD Value
@li Multi String Value
@li Expandable String Value
@onlyfor{wxmsw}
@library{wxbase}
@category{FIXME}
@category{misc}
@b Example:
@code
wxRegKey *key = new wxRegKey("HKEY_LOCAL_MACHINE\\Software\\MyKey");
// Create the key if it does not exist.
if( !key->Exists() )
key->Create();
// Create a new value "MYVALUE" and set it to 12.
key->SetValue("MYVALUE", 12);
// Read the value back.
long value;
key->QueryValue("MYVALUE", &value);
wxMessageBox(wxString::Format("%d", value), "Registry Value", wxOK);
// Get the number of subkeys and enumerate them.
size_t subkeys;
key->GetKeyInfo(&subkeys, NULL, NULL, NULL);
wxString key_name;
key->GetFirstKey(key_name, 1);
for(int i = 0; i < subkeys; i++)
{
wxMessageBox(key_name, "Subkey Name", wxOK);
key->GetNextKey(key_name, 1);
}
@endcode
*/
class wxRegKey
{
public:
//@{
/**
Default constructor, initializes to HKCR.
*/
wxRegKey();
/**
The constructor to set the full name of the key.
*/
wxRegKey(const wxString& strKey);
/**
The constructor to set the full name of the key under a previously created
parent.
*/
wxRegKey();
wxRegKey(const wxString& strKey);
wxRegKey(const wxRegKey& keyParent, const wxString& strKey);
//@}
/**
Access modes for wxRegKey.
*/
enum AccessMode
{
Read, ///< Read-only
Write ///< Read and Write
};
/**
Closes the key.
@@ -78,7 +121,7 @@ public:
/**
Returns @true if the key exists.
*/
static bool Exists() const;
bool Exists() const;
/**
Gets the first key.
@@ -102,8 +145,8 @@ public:
@param pnMaxValueLen
The maximum length of a value.
*/
bool GetKeyInfo(size_t* pnSubKeys, size_t* pnValues,
size_t* pnMaxValueLen) const;
bool GetKeyInfo(size_t* pnSubKeys, size_t* pnMaxKeyLen,
size_t* pnValues, size_t* pnMaxValueLen) const;
/**
Gets the name of the registry key.
@@ -152,18 +195,20 @@ public:
/**
Explicitly opens the key. This method also allows the key to be opened in
read-only mode by passing @c Read() instead of default
@c Write() parameter.
read-only mode by passing wxRegKey::Read instead of default
wxRegKey::Write parameter.
*/
bool Open(AccessMode mode = Write);
//@{
/**
Retrieves the string value.
*/
bool QueryValue(const wxChar* szValue, wxString& strValue) const;
/**
Retrieves the numeric value.
*/
bool QueryValue(const wxChar* szValue, wxString& strValue) const;
const bool QueryValue(const wxChar* szValue, long* plValue) const;
//@}
/**
Renames the key.
@@ -176,16 +221,19 @@ public:
bool RenameValue(const wxChar* szValueOld,
const wxChar* szValueNew);
//@{
/**
Sets the given @a szValue which must be numeric, string or binary depending
on the overload used. If the value doesn't exist, it is created.
Sets the given @a szValue which must be numeric.
If the value doesn't exist, it is created.
*/
bool SetValue(const wxChar* szValue, long lValue);
bool SetValue(const wxChar* szValue,
const wxString& strValue);
bool SetValue(const wxChar* szValue,
const wxMemoryBuffer& buf);
//@}
/**
Sets the given @a szValue which must be string.
If the value doesn't exist, it is created.
*/
bool SetValue(const wxChar* szValue, const wxString& strValue);
/**
Sets the given @a szValue which must be binary.
If the value doesn't exist, it is created.
*/
bool SetValue(const wxChar* szValue, const wxMemoryBuffer& buf);
};
interface/regex.h
+10 -6
View File
@@ -7,6 +7,8 @@
/////////////////////////////////////////////////////////////////////////////
/**
@anchor wxRE_FLAGS
Flags for regex compilation to be used with Compile().
*/
enum
@@ -38,6 +40,8 @@ enum
};
/**
@anchor wxRE_NOT_FLAGS
Flags for regex matching to be used with Matches().
These flags are mainly useful when doing several matches in a long string
to prevent erroneous matches for ¡¯¡¯ and ¡¯$¡¯:
@@ -120,7 +124,7 @@ public:
Create and compile the regular expression, use
IsValid() to test for compilation errors.
@todo Add referece to the flag enum.
As for the flags, please see @ref wxRE_FLAGS.
*/
wxRegEx(const wxString& expr, int flags = wxRE_DEFAULT);
@@ -134,7 +138,7 @@ public:
Compile the string into regular expression, return @true if ok or @false
if string has a syntax error.
@todo Add referece to the flag enum.
As for the flags, please see @ref wxRE_FLAGS.
*/
bool Compile(const wxString& pattern, int flags = wxRE_DEFAULT);
@@ -179,8 +183,8 @@ public:
Matches the precompiled regular expression against the string @a text,
returns @true if matches and @false otherwise.
@e Flags may be combination of @c wxRE_NOTBOL and @c wxRE_NOTEOL.
@todo Add referece to the flag enum.
@e Flags may be combination of @c wxRE_NOTBOL and @c wxRE_NOTEOL, see
@ref wxRE_NOT_FLAGS.
Some regex libraries assume that the text given is null terminated, while
others require the length be given as a separate parameter. Therefore for
@@ -202,8 +206,8 @@ public:
Matches the precompiled regular expression against the string @a text,
returns @true if matches and @false otherwise.
@e Flags may be combination of @c wxRE_NOTBOL and @c wxRE_NOTEOL.
@todo Add referece to the flag enum.
@e Flags may be combination of @c wxRE_NOTBOL and @c wxRE_NOTEOL, see
@ref wxRE_NOT_FLAGS.
May only be called after successful call to Compile().
*/
interface/region.h
+209 -50
View File
@@ -6,6 +6,31 @@
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
Types of results returned from a call to wxRegion::Contains().
*/
enum wxRegionContain
{
/** The specified value is not contained within this region. */
wxOutRegion = 0,
/**
The specified value is partially contained within this region.
On Windows, this result is not supported. ::wxInRegion will be returned
instead.
*/
wxPartRegion = 1,
/**
The specified value is fully contained within this region.
On Windows, this result will be returned even if only part of the specified
value is contained in this region.
*/
wxInRegion = 2
};
/**
@class wxRegionIterator
@wxheader{region.h}
@@ -30,16 +55,17 @@
class wxRegionIterator : public wxObject
{
public:
//@{
/**
Default constructor.
*/
wxRegionIterator();
/**
Creates an iterator object given a region.
*/
wxRegionIterator();
wxRegionIterator(const wxRegion& region);
//@}
/**
An alias for GetHeight.
An alias for GetHeight().
*/
wxCoord GetH() const;
@@ -54,7 +80,7 @@ public:
wxRect GetRect() const;
/**
An alias for GetWidth.
An alias for GetWidth().
*/
wxCoord GetW() const;
@@ -78,22 +104,29 @@ public:
*/
bool HaveRects() const;
//@{
/**
Resets the iterator to the beginning of the rectangles.
*/
void Reset();
/**
Resets the iterator to the given region.
*/
void Reset();
void Reset(const wxRegion& region);
//@}
/**
Increment operator. Increments the iterator to the next region.
@beginWxPythonOnly
A wxPython alias for this operator is called Next.
@endWxPythonOnly
*/
void operator ++();
/**
Returns @true if there are still some rectangles; otherwise returns @false.
You can use this to test the iterator object as if it were of type bool.
You can use this to test the iterator object as if it were of type @c bool.
*/
operator bool() const;
};
@@ -106,13 +139,16 @@ public:
A wxRegion represents a simple or complex region on a device context or window.
This class uses @ref overview_trefcount "reference counting and copy-on-write"
This class uses @ref overview_refcount "reference counting and copy-on-write"
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.
@stdobjects
- ::wxNullRegion
@library{wxcore}
@category{data,gdi}
@@ -121,26 +157,47 @@ public:
class wxRegion : public wxGDIObject
{
public:
//@{
/**
Default constructor.
*/
wxRegion();
/**
Constructs a rectangular region with the given position and size.
*/
wxRegion(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
/**
Constructs a rectangular region from the top left point and the bottom right
point.
*/
wxRegion(const wxPoint& topLeft, const wxPoint& bottomRight);
/**
Constructs a rectangular region a wxRect object.
*/
wxRegion(const wxRect& rect);
/**
Copy constructor, uses @ref overview_refcount.
*/
wxRegion(const wxRegion& region);
/**
Constructs a region corresponding to the polygon made of @a n points
in the provided array.
@a fillStyle parameter may have values @c wxWINDING_RULE or @c wxODDEVEN_RULE.
*/
wxRegion(size_t n, const wxPoint* points, int fillStyle = wxWINDING_RULE);
/**
Constructs a region using a bitmap. See Union() for more details.
*/
wxRegion(const wxBitmap& bmp);
/**
Constructs a region using the non-transparent pixels of a bitmap. See
Union() for more details.
*/
wxRegion();
wxRegion(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
wxRegion(const wxPoint& topLeft, const wxPoint& bottomRight);
wxRegion(const wxRect& rect);
wxRegion(const wxRegion& region);
wxRegion(size_t n, const wxPoint points,
int fillStyle = wxWINDING_RULE);
wxRegion(const wxBitmap& bmp);
wxRegion(const wxBitmap& bmp, const wxColour& transColour,
int tolerance = 0);
//@}
/**
Destructor.
See @ref overview_refcountdestruct "reference-counted object destruction" for
See @ref overview_refcount_destruct "reference-counted object destruction" for
more info.
*/
~wxRegion();
@@ -150,21 +207,40 @@ public:
*/
void Clear();
//@{
/**
Returns a value indicating whether the given point is contained within the region.
@return The return value is one of @c wxOutRegion and @c wxInRegion.
*/
wxRegionContain Contains(long& x, long& y) const;
/**
Returns a value indicating whether the given point is contained within the region.
@return The return value is one of @c wxOutRegion and @c wxInRegion.
*/
wxRegionContain Contains(const wxPoint& pt) const;
/**
Returns a value indicating whether the given rectangle is contained within the
region.
@return The return value is one of wxOutRegion, wxPartRegion and
wxInRegion.
@return One of ::wxOutRegion, ::wxPartRegion or ::wxInRegion.
@note On Windows, only ::wxOutRegion and ::wxInRegion are returned; a value
::wxInRegion then indicates that all or some part of the region is
contained in this region.
*/
wxRegionContain Contains(long& x, long& y) const;
const wxRegionContain Contains(const wxPoint& pt) const;
const wxRegionContain Contains(long& x, long& y,
long& width,
long& height) const;
const wxRegionContain Contains(const wxRect& rect) const;
//@}
wxRegionContain Contains(long& x, long& y, long& width, long& height) const;
/**
Returns a value indicating whether the given rectangle is contained within the
region.
@return One of ::wxOutRegion, ::wxPartRegion or ::wxInRegion.
@note On Windows, only ::wxOutRegion and ::wxInRegion are returned; a value
::wxInRegion then indicates that all or some part of the region is
contained in this region.
*/
wxRegionContain Contains(const wxRect& rect) const;
/**
Convert the region to a black and white bitmap with the white pixels
@@ -181,9 +257,9 @@ public:
const wxRect GetBox() const;
//@}
//@{
/**
Finds the intersection of this region and another region.
Finds the intersection of this region and another, rectangular region,
specified using position and size.
@return @true if successful, @false otherwise.
@@ -193,9 +269,26 @@ public:
*/
bool Intersect(wxCoord x, wxCoord y, wxCoord width,
wxCoord height);
/**
Finds the intersection of this region and another, rectangular region.
@return @true if successful, @false otherwise.
@remarks Creates the intersection of the two regions, that is, the parts
which are in both regions. The result is stored in this
region.
*/
bool Intersect(const wxRect& rect);
/**
Finds the intersection of this region and another region.
@return @true if successful, @false otherwise.
@remarks Creates the intersection of the two regions, that is, the parts
which are in both regions. The result is stored in this
region.
*/
bool Intersect(const wxRegion& region);
//@}
/**
Returns @true if the region is empty, @false otherwise.
@@ -204,8 +297,10 @@ public:
/**
Returns @true if the region is equal to, i.e. covers the same area as,
another one. Note that if both this region and @a region are invalid, they
are considered to be equal.
another one.
@note If both this region and @a region are invalid, they are
considered to be equal.
*/
bool IsEqual(const wxRegion& region) const;
@@ -221,7 +316,16 @@ public:
bool Offset(const wxPoint& pt);
//@}
//@{
/**
Subtracts a rectangular region from this region.
@return @true if successful, @false otherwise.
@remarks This operation combines the parts of 'this' region that are not
part of the second region. The result is stored in this
region.
*/
bool Subtract(const wxRect& rect);
/**
Subtracts a region from this region.
@@ -231,16 +335,11 @@ public:
part of the second region. The result is stored in this
region.
*/
bool Subtract(const wxRect& rect);
bool Subtract(const wxRegion& region);
//@}
//@{
/**
Finds the union of this region and the non-transparent pixels of a
bitmap. Colour to be treated as transparent is specified in the
@a transColour argument, along with an
optional colour tolerance value.
Finds the union of this region and another, rectangular region, specified using
position and size.
@return @true if successful, @false otherwise.
@@ -249,14 +348,73 @@ public:
region.
*/
bool Union(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
/**
Finds the union of this region and another, rectangular region.
@return @true if successful, @false otherwise.
@remarks This operation creates a region that combines all of this region
and the second region. The result is stored in this
region.
*/
bool Union(const wxRect& rect);
/**
Finds the union of this region and another region.
@return @true if successful, @false otherwise.
@remarks This operation creates a region that combines all of this region
and the second region. The result is stored in this
region.
*/
bool Union(const wxRegion& region);
/**
Finds the union of this region and the non-transparent pixels of a
bitmap. The bitmap's mask is used to determine transparency. If the
bitmap doesn't have a mask, the bitmap's full dimensions are used.
@return @true if successful, @false otherwise.
@remarks This operation creates a region that combines all of this region
and the second region. The result is stored in this
region.
*/
bool Union(const wxBitmap& bmp);
/**
Finds the union of this region and the non-transparent pixels of a
bitmap. Colour to be treated as transparent is specified in the
@a transColour argument, along with an optional colour tolerance value.
@return @true if successful, @false otherwise.
@remarks This operation creates a region that combines all of this region
and the second region. The result is stored in this
region.
*/
bool Union(const wxBitmap& bmp, const wxColour& transColour,
int tolerance = 0);
//@}
//@{
/**
Finds the Xor of this region and another, rectangular region, specified using
position and size.
@return @true if successful, @false otherwise.
@remarks This operation creates a region that combines all of this region
and the second region, except for any overlapping
areas. The result is stored in this region.
*/
bool Xor(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
/**
Finds the Xor of this region and another, rectangular region.
@return @true if successful, @false otherwise.
@remarks This operation creates a region that combines all of this region
and the second region, except for any overlapping
areas. The result is stored in this region.
*/
bool Xor(const wxRect& rect);
/**
Finds the Xor of this region and another region.
@@ -266,14 +424,15 @@ public:
and the second region, except for any overlapping
areas. The result is stored in this region.
*/
bool Xor(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
bool Xor(const wxRect& rect);
bool Xor(const wxRegion& region);
//@}
/**
Assignment operator, using @ref overview_trefcount "reference counting".
Assignment operator, using @ref overview_refcount.
*/
void operator =(const wxRegion& region);
};
/**
An empty region.
*/
wxRegion wxNullRegion;
interface/renderer.h
+264 -111
View File
File diff suppressed because it is too large Load Diff