/**
@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
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:
- //@{
/**
- The constructor to set the full name of the key under a previously created
- parent.
+ 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(const wxRegKey& keyParent, const wxString& strKey);
- //@}
+
+ /**
+ Access modes for wxRegKey.
+ */
+ enum AccessMode
+ {
+ Read, ///< Read-only
+ Write ///< Read and Write
+ };
/**
Closes the key.
/**
Returns @true if the key exists.
*/
- static bool Exists() const;
+ bool Exists() const;
/**
Gets the first key.
@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.
/**
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 numeric value.
+ Retrieves the string value.
*/
bool QueryValue(const wxChar* szValue, wxString& strValue) const;
+
+ /**
+ Retrieves the numeric value.
+ */
const bool QueryValue(const wxChar* szValue, long* plValue) const;
- //@}
/**
Renames the key.
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);
};
-
// 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}
class wxRegionIterator : public wxObject
{
public:
- //@{
/**
- Creates an iterator object given a region.
+ Default constructor.
*/
wxRegionIterator();
+ /**
+ Creates an iterator object given a region.
+ */
wxRegionIterator(const wxRegion& region);
- //@}
/**
- An alias for GetHeight.
+ An alias for GetHeight().
*/
wxCoord GetH() const;
wxRect GetRect() const;
/**
- An alias for GetWidth.
+ An alias for GetWidth().
*/
wxCoord GetW() const;
*/
bool HaveRects() const;
- //@{
/**
- Resets the iterator to the given region.
+ Resets the iterator to the beginning of the rectangles.
*/
void Reset();
+
+ /**
+ Resets the iterator to the given region.
+ */
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;
};
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}
class wxRegion : public wxGDIObject
{
public:
- //@{
/**
- Constructs a region using the non-transparent pixels of a bitmap. See
- Union() for more details.
+ 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);
- wxRegion(size_t n, const wxPoint points,
- int fillStyle = wxWINDING_RULE);
+ /**
+ 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(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();
*/
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
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.
*/
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.
/**
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;
bool Offset(const wxPoint& pt);
//@}
- //@{
/**
- Subtracts a region from this region.
+ Subtracts a rectangular region from this region.
@return @true if successful, @false otherwise.
region.
*/
bool Subtract(const wxRect& rect);
+ /**
+ Subtracts a 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 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.
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 region.
+ Finds the Xor of this region and another, rectangular region, specified using
+ position and size.
@return @true if successful, @false otherwise.
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.
+
+ @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 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;
/////////////////////////////////////////////////////////////////////////////
// Name: renderer.h
-// Purpose: interface of wxSplitterRenderParams
+// Purpose: interface of wxRendererNative
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
- @class wxSplitterRenderParams
+ @anchor wxCONTROL_FLAGS
+
+ The following rendering flags are defined for wxRendererNative:
+*/
+enum
+{
+ /** Control is disabled. */
+ wxCONTROL_DISABLED = 0x00000001,
+
+ /** Currently has keyboard focus. */
+ wxCONTROL_FOCUSED = 0x00000002,
+
+ /** (Button) is pressed. */
+ wxCONTROL_PRESSED = 0x00000004,
+
+ /** Control-specific bit. */
+ wxCONTROL_SPECIAL = 0x00000008,
+
+ /** Only for the buttons. */
+ wxCONTROL_ISDEFAULT = wxCONTROL_SPECIAL,
+
+ /** Only for the menu items. */
+ wxCONTROL_ISSUBMENU = wxCONTROL_SPECIAL,
+
+ /** Only for the tree items. */
+ wxCONTROL_EXPANDED = wxCONTROL_SPECIAL,
+
+ /** Only for the status bar panes. */
+ wxCONTROL_SIZEGRIP = wxCONTROL_SPECIAL,
+
+ /** Checkboxes only: flat border. */
+ wxCONTROL_FLAT = wxCONTROL_SPECIAL,
+
+ /** Mouse is currently over the control. */
+ wxCONTROL_CURRENT = 0x00000010,
+
+ /** Selected item in e.g. listbox. */
+ wxCONTROL_SELECTED = 0x00000020,
+
+ /** (Check/radio button) is checked. */
+ wxCONTROL_CHECKED = 0x00000040,
+
+ /** (Menu) item can be checked. */
+ wxCONTROL_CHECKABLE = 0x00000080,
+
+ /** (Check) undetermined state. */
+ wxCONTROL_UNDETERMINED = wxCONTROL_CHECKABLE
+};
+
+/**
+ @struct wxSplitterRenderParams
@wxheader{renderer.h}
This is just a simple @c struct used as a return value of
- wxRendererNative::GetSplitterParams.
+ wxRendererNative::GetSplitterParams().
- It doesn't have any methods and all of its fields are constant and so can be
- only examined but not modified.
+ It doesn't have any methods and all of its fields are constant, so they can
+ only be examined but not modified.
@library{wxbase}
- @category{FIXME}
+ @category{gdi}
*/
-class wxSplitterRenderParams
+struct wxSplitterRenderParams
{
-public:
/**
- const wxCoord border
- The width of the border drawn by the splitter inside it, may be 0.
+ The only way to initialize this struct is by using this ctor.
*/
+ wxSplitterRenderParams(wxCoord widthSash_, wxCoord border_, bool isSens_);
+ /**
+ The width of the border drawn by the splitter inside it, may be 0.
+ */
+ const wxCoord border;
/**
- const bool isHotSensitive
@true if the sash changes appearance when the mouse passes over it, @false
otherwise.
*/
-
+ const bool isHotSensitive;
/**
- const wxCoord widthSash
The width of the splitter sash.
*/
+ const wxCoord widthSash;
+};
+
+/**
+ @struct wxHeaderButtonParams
+ @wxheader{renderer.h}
+
+ This @c struct can optionally be used with
+ wxRendererNative::DrawHeaderButton() to specify custom values used to draw
+ the text or bitmap label.
+
+ @library{wxbase}
+ @category{gdi}
+*/
+struct wxHeaderButtonParams
+{
+ wxHeaderButtonParams();
+
+ wxColour m_arrowColour;
+ wxColour m_selectionColour;
+ wxString m_labelText;
+ wxFont m_labelFont;
+ wxColour m_labelColour;
+ wxBitmap m_labelBitmap;
+ int m_labelAlignment;
+};
+
+/**
+ Used to specify the type of sort arrow used with
+ wxRendererNative::DrawHeaderButton().
+*/
+enum wxHeaderSortIconType
+{
+ wxHDR_SORT_ICON_NONE, ///< Don't draw a sort arrow.
+ wxHDR_SORT_ICON_UP, ///< Draw a sort arrow icon pointing up.
+ wxHDR_SORT_ICON_DOWN ///< Draw a sort arrow icon pointing down.
};
be a real renderer which does the drawing.
@library{wxcore}
- @category{FIXME}
+ @category{gdi}
+
+ @see wxRendererNative
*/
class wxDelegateRendererNative : public wxRendererNative
{
public:
- //@{
/**
The default constructor does the same thing as the other one except that it
- uses the @ref wxRendererNative::getgeneric "generic renderer" instead of the
- user-specified @e rendererNative.
+ uses the @ref wxRendererNative::GetGeneric() "generic renderer" instead of the
+ user-specified @a rendererNative.
+
In any case, this sets up the delegate renderer object to follow all calls to
the specified real renderer.
- Note that this object does not take ownership of (i.e. won't delete)
- @e rendererNative.
*/
wxDelegateRendererNative();
- wxDelegateRendererNative(wxRendererNative& rendererNative);
- //@}
-
/**
- This class also provides all the virtual methods of
- wxRendererNative, please refer to that class
- documentation for the details.
+ This constructor uses the user-specified @a rendererNative to set up the delegate
+ renderer object to follow all calls to the specified real renderer.
+
+ @note
+ This object does not take ownership of (i.e. won't delete) @a rendererNative.
*/
- DrawXXX(...);
+ wxDelegateRendererNative(wxRendererNative& rendererNative);
+
+ // The rest of these functions inherit the documentation from wxRendererNative
+
+ virtual int DrawHeaderButton(wxWindow *win, wxDC& dc,
+ const wxRect& rect, int flags = 0,
+ wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
+ wxHeaderButtonParams* params = NULL);
+
+ virtual int DrawHeaderButtonContents(wxWindow *win, wxDC& dc,
+ const wxRect& rect, int flags = 0,
+ wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
+ wxHeaderButtonParams* params = NULL);
+
+ virtual int GetHeaderButtonHeight(wxWindow *win);
+
+ virtual void DrawTreeItemButton(wxWindow *win, wxDC& dc,
+ const wxRect& rect, int flags = 0);
+
+ virtual void DrawSplitterBorder(wxWindow *win, wxDC& dc,
+ const wxRect& rect, int flags = 0);
+
+ virtual void DrawSplitterSash(wxWindow *win, wxDC& dc,
+ const wxSize& size, wxCoord position,
+ wxOrientation orient, int flags = 0);
+
+ virtual void DrawComboBoxDropButton(wxWindow *win, wxDC& dc,
+ const wxRect& rect, int flags = 0);
+
+ virtual void DrawDropArrow(wxWindow *win, wxDC& dc,
+ const wxRect& rect, int flags = 0);
+
+ virtual void DrawCheckBox(wxWindow *win, wxDC& dc,
+ const wxRect& rect, int flags = 0 );
+
+ virtual void DrawPushButton(wxWindow *win, wxDC& dc,
+ const wxRect& rect, int flags = 0 );
+
+ virtual void DrawItemSelectionRect(wxWindow *win, wxDC& dc,
+ const wxRect& rect, int flags = 0 );
+
+ virtual void DrawFocusRect(wxWindow* win, wxDC& dc,
+ const wxRect& rect, int flags = 0);
+
+ virtual wxSplitterRenderParams GetSplitterParams(const wxWindow *win);
+
+ virtual wxRendererVersion GetVersion() const;
};
@class wxRendererNative
@wxheader{renderer.h}
- First, a brief introduction to wxRenderer and why it is needed.
+ First, a brief introduction to wxRendererNative and why it is needed.
Usually wxWidgets uses the underlying low level GUI system to draw all the
controls - this is what we mean when we say that it is a "native" framework.
appearance is different under different platforms while the lines are always
drawn in the same way.
- This is why we have renderers: wxRenderer is a class which virtualizes the
+ This is why we have renderers: wxRendererNative is a class which virtualizes the
drawing, i.e. it abstracts the drawing operations and allows you to draw say, a
button, without caring about exactly how this is done. Of course, as we
can draw the button differently in different renderers, this also allows us to
So the renderers work by exposing a large set of high-level drawing functions
which are used by the generic controls. There is always a default global
renderer but it may be changed or extended by the user, see
- @ref overview_samplerender "Render sample".
+ @ref page_samples_render.
All drawing functions take some standard parameters:
- @e win is the window being drawn. It is normally not used and when
+ @li @a win - The window being drawn. It is normally not used and when
it is it should only be used as a generic wxWindow
(in order to get its low level handle, for example), but you should
not assume that it is of some given type as the same renderer
function may be reused for drawing different kinds of control.
- @e dc is the wxDC to draw on. Only this device
+ @li @a dc - The wxDC to draw on. Only this device
context should be used for drawing. It is not necessary to restore
pens and brushes for it on function exit but, on the other hand, you
shouldn't assume that it is in any specific state on function entry:
the rendering functions should always prepare it.
- @e rect the bounding rectangle for the element to be drawn.
- @e flags the optional flags (none by default) which can be a
- combination of the @c wxCONTROL_XXX constants below.
+ @li @a rect - The bounding rectangle for the element to be drawn.
+ @li @a flags - The optional flags (none by default) which can be a
+ combination of the @ref wxCONTROL_FLAGS.
Note that each drawing function restores the wxDC attributes if
it changes them, so it is safe to assume that the same pen, brush and colours
/**
Draw a check box (used by wxDataViewCtrl).
+
@a flags may have the @c wxCONTROL_CHECKED, @c wxCONTROL_CURRENT or
- @c wxCONTROL_UNDETERMINED bit set.
+ @c wxCONTROL_UNDETERMINED bit set, see @ref wxCONTROL_FLAGS.
*/
- void DrawCheckBox(wxWindow* win, wxDC& dc, const wxRect& rect,
- int flags);
+ virtual void DrawCheckBox(wxWindow* win, wxDC& dc,
+ const wxRect& rect, int flags);
/**
Draw a button like the one used by wxComboBox to show a
drop down window. The usual appearance is a downwards pointing arrow.
- @a flags may have the @c wxCONTROL_PRESSED or @c wxCONTROL_CURRENT bit set.
+
+ @a flags may have the @c wxCONTROL_PRESSED or @c wxCONTROL_CURRENT bit set,
+ see @ref wxCONTROL_FLAGS.
*/
- void DrawComboBoxDropButton(wxWindow* win, wxDC& dc,
+ virtual void DrawComboBoxDropButton(wxWindow* win, wxDC& dc,
const wxRect& rect,
int flags);
/**
Draw a drop down arrow that is suitable for use outside a combo box. Arrow will
- have
- transparent background.
+ have transparent background.
+
@a rect is not entirely filled by the arrow. Instead, you should use bounding
rectangle of a drop down button which arrow matches the size you need.
- @a flags may have the @c wxCONTROL_PRESSED or @c wxCONTROL_CURRENT bit set.
+
+ @a flags may have the @c wxCONTROL_PRESSED or @c wxCONTROL_CURRENT bit set,
+ see @ref wxCONTROL_FLAGS.
*/
- void DrawDropArrow(wxWindow* win, wxDC& dc, const wxRect& rect,
+ virtual void DrawDropArrow(wxWindow* win, wxDC& dc, const wxRect& rect,
int flags);
/**
Draw a focus rectangle using the specified rectangle.
- wxListCtrl. The only supported flags is
- @c wxCONTROL_SELECTED for items which are selected.
+ wxListCtrl.
+
+ The only supported flags is @c wxCONTROL_SELECTED for items which are selected.
+ see @ref wxCONTROL_FLAGS.
*/
- void DrawFocusRect(wxWindow* win, wxDC& dc, const wxRect& rect,
+ virtual void DrawFocusRect(wxWindow* win, wxDC& dc, const wxRect& rect,
int flags = 0);
/**
- Draw the header control button (used, for example, by
- wxListCtrl). Depending on platforms the
- @a flags parameter may support the @c wxCONTROL_SELECTED
- @c wxCONTROL_DISABLED and @c wxCONTROL_CURRENT bits.
- The @a sortArrow parameter can be one of
- @c wxHDR_SORT_ICON_NONE, @c wxHDR_SORT_ICON_UP, or
- @c wxHDR_SORT_ICON_DOWN. Additional values controlling the
- drawing of a text or bitmap label can be passed in @e params. The
- value returned is the optimal width to contain the the unabreviated
- label text or bitmap, the sort arrow if present, and internal margins.
+ Draw the header control button (used, for example, by wxListCtrl).
+
+ Depending on platforms the @a flags parameter may support the @c wxCONTROL_SELECTED
+ @c wxCONTROL_DISABLED and @c wxCONTROL_CURRENT bits, see @ref wxCONTROL_FLAGS.
+
+ @return
+ The optimal width to contain the the unabreviated label text or
+ bitmap, the sort arrow if present, and internal margins.
*/
- int DrawHeaderButton(wxWindow* win, wxDC& dc, const wxRect& rect,
- int flags = 0,
- wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
- wxHeaderButtonParams* params = NULL);
+ virtual int DrawHeaderButton(wxWindow* win, wxDC& dc,
+ const wxRect& rect, int flags = 0,
+ wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
+ wxHeaderButtonParams* params = NULL);
+
+ /**
+ Draw the contents of a header control button (label, sort arrows,
+ etc.). This function is normally only called by DrawHeaderButton().
+
+ Depending on platforms the @a flags parameter may support the @c wxCONTROL_SELECTED
+ @c wxCONTROL_DISABLED and @c wxCONTROL_CURRENT bits, see @ref wxCONTROL_FLAGS.
+
+ @return
+ The optimal width to contain the the unabreviated label text or
+ bitmap, the sort arrow if present, and internal margins.
+ */
+ virtual int DrawHeaderButtonContents(wxWindow *win, wxDC& dc,
+ const wxRect& rect, int flags = 0,
+ wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
+ wxHeaderButtonParams* params = NULL);
/**
Draw a selection rectangle underneath the text as used e.g. in a
- wxListCtrl. The supported @a flags are
- @c wxCONTROL_SELECTED for items which are selected (e.g. often a blue
- rectangle) and @c wxCONTROL_CURRENT for the item that has the focus
- (often a dotted line around the item's text). @c wxCONTROL_FOCUSED may
- be used to indicate if the control has the focus (othewise the the selection
- rectangle is e.g. often grey and not blue). This may be ignored by the renderer
- or deduced by the code directly from the @e win.
+ wxListCtrl.
+
+ The supported @a flags are @c wxCONTROL_SELECTED for items
+ which are selected (e.g. often a blue rectangle) and @c wxCONTROL_CURRENT
+ for the item that has the focus (often a dotted line around the item's text).
+ @c wxCONTROL_FOCUSED may be used to indicate if the control has the focus
+ (othewise the the selection rectangle is e.g. often grey and not blue).
+ This may be ignored by the renderer or deduced by the code directly from
+ the @a win.
*/
- void DrawItemSelectionRect(wxWindow* win, wxDC& dc,
- const wxRect& rect,
- int flags = 0);
+ virtual void DrawItemSelectionRect(wxWindow* win, wxDC& dc,
+ const wxRect& rect, int flags = 0);
/**
Draw a blank push button that looks very similar to wxButton.
+
@a flags may have the @c wxCONTROL_PRESSED, @c wxCONTROL_CURRENT or
- @c wxCONTROL_ISDEFAULT bit set.
+ @c wxCONTROL_ISDEFAULT bit set, see @ref wxCONTROL_FLAGS.
*/
- void DrawPushButton(wxWindow* win, wxDC& dc, const wxRect& rect,
- int flags);
+ virtual void DrawPushButton(wxWindow* win, wxDC& dc,
+ const wxRect& rect, int flags);
/**
Draw the border for sash window: this border must be such that the sash
- drawn by @ref drawsplittersash() DrawSash blends into it
- well.
+ drawn by DrawSplitterSash() blends into it well.
*/
- void DrawSplitterBorder(wxWindow* win, wxDC& dc,
- const wxRect& rect,
- int flags = 0);
+ virtual void DrawSplitterBorder(wxWindow* win, wxDC& dc,
+ const wxRect& rect, int flags = 0);
/**
Draw a sash. The @a orient parameter defines whether the sash should be
vertical or horizontal and how the @a position should be interpreted.
*/
- void DrawSplitterSash(wxWindow* win, wxDC& dc,
- const wxSize& size,
- wxCoord position,
- wxOrientation orient,
- int flags = 0);
+ virtual void DrawSplitterSash(wxWindow* win, wxDC& dc,
+ const wxSize& size, wxCoord position,
+ wxOrientation orient, int flags = 0);
/**
- Draw the expanded/collapsed icon for a tree control item. To draw an expanded
- button the @a flags parameter must contain @c wxCONTROL_EXPANDED bit.
+ Draw the expanded/collapsed icon for a tree control item.
+
+ To draw an expanded button the @a flags parameter must contain @c wxCONTROL_EXPANDED bit,
+ see @ref wxCONTROL_FLAGS.
*/
- void DrawTreeItemButton(wxWindow* win, wxDC& dc,
- const wxRect& rect,
- int flags = 0);
+ virtual void DrawTreeItemButton(wxWindow* win, wxDC& dc,
+ const wxRect& rect, int flags = 0);
/**
Return the currently used renderer.
*/
- wxRendererNative Get();
+ static wxRendererNative Get();
/**
Return the default (native) implementation for this platform -- this is also
Set() in which case the return value of this
method may be different from the return value of Get().
*/
- wxRendererNative GetDefault();
+ static wxRendererNative GetDefault();
/**
Return the generic implementation of the renderer. Under some platforms, this
is the default renderer implementation, others have platform-specific default
renderer which can be retrieved by calling GetDefault().
*/
- wxRendererNative GetGeneric();
+ static wxRendererNative GetGeneric();
/**
Returns the height of a header button, either a fixed platform height if
available, or a
generic height based on the window's font.
*/
- int GetHeaderButtonHeight(const wxWindow* win);
+ virtual int GetHeaderButtonHeight(wxWindow* win);
/**
Get the splitter parameters, see
wxSplitterRenderParams.
*/
- wxSplitterRenderParams GetSplitterParams(const wxWindow* win);
+ virtual wxSplitterRenderParams GetSplitterParams(const wxWindow* win);
/**
This function is used for version checking: Load()
refuses to load any shared libraries implementing an older or incompatible
version.
+
+ @remarks
The implementation of this method is always the same in all renderers (simply
- construct wxRendererVersion using the
- @c wxRendererVersion::Current_XXX values), but it has to be in the derived,
- not base, class, to detect mismatches between the renderers versions and so you
- have to implement it anew in all renderers.
+ construct wxRendererVersion using the @c wxRendererVersion::Current_XXX values),
+ but it has to be in the derived, not base, class, to detect mismatches between
+ the renderers versions and so you have to implement it anew in all renderers.
*/
- wxRendererVersion GetVersion() const;
+ virtual wxRendererVersion GetVersion() const;
/**
Load the renderer from the specified DLL, the returned pointer must be
deleted by caller if not @NULL when it is not used any more.
+
The @a name should be just the base name of the renderer and not the full
name of the DLL file which is constructed differently (using
- wxDynamicLibrary::CanonicalizePluginName)
+ wxDynamicLibrary::CanonicalizePluginName())
on different systems.
*/
- wxRendererNative* Load(const wxString& name);
+ static wxRendererNative* Load(const wxString& name);
/**
Set the renderer to use, passing @NULL reverts to using the default
renderer (the global renderer must always exist).
+
Return the previous renderer used with Set() or @NULL if none.
*/
- wxRendererNative* Set(wxRendererNative* renderer);
+ static wxRendererNative* Set(wxRendererNative* renderer);
};
/**
- @class wxRendererVersion
+ @struct wxRendererVersion
@wxheader{renderer.h}
This simple struct represents the wxRendererNative
interface version and is only used as the return value of
- wxRendererNative::GetVersion.
+ wxRendererNative::GetVersion().
The version has two components: the version itself and the age. If the main
program and the renderer have different versions they are never compatible with
done by IsCompatible() method.
@library{wxbase}
- @category{FIXME}
+ @category{gdi}
*/
-class wxRendererVersion
+struct wxRendererVersion
{
-public:
/**
Checks if the main program is compatible with the renderer having the version
@e ver, returns @true if it is and @false otherwise.
- This method is used by
- wxRendererNative::Load to determine whether a
+
+ This method is used by wxRendererNative::Load() to determine whether a
renderer can be used.
*/
static bool IsCompatible(const wxRendererVersion& ver);
/**
- const int age
The age component.
*/
-
+ const int age;
/**
- const int version
The version component.
*/
+ const int version;
};
projects / wxWidgets.git / commitdiff
