/////////////////////////////////////////////////////////////////////////////
// Name: renderer.h
-// Purpose: documentation for wxSplitterRenderParams class
+// Purpose: interface of wxSplitterRenderParams
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
public:
/**
const wxCoord border
-
The width of the border drawn by the splitter inside it, may be 0.
*/
/**
const bool isHotSensitive
-
@true if the sash changes appearance when the mouse passes over it, @false
otherwise.
*/
/**
const wxCoord widthSash
-
The width of the splitter sash.
*/
};
+
/**
@class wxDelegateRendererNative
@wxheader{renderer.h}
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.
-
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.
*/
};
+
/**
@class wxRendererNative
@wxheader{renderer.h}
/**
Draw a check box (used by wxDataViewCtrl).
-
- @e flags may have the @c wxCONTROL_CHECKED, @c wxCONTROL_CURRENT or
+ @a flags may have the @c wxCONTROL_CHECKED, @c wxCONTROL_CURRENT or
@c wxCONTROL_UNDETERMINED bit set.
*/
- void DrawCheckBox(wxWindow * win, wxDC& dc, const wxRect& rect,
+ 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.
-
- @e 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.
*/
- void DrawComboBoxDropButton(wxWindow * win, wxDC& dc,
+ 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.
-
- @e rect is not entirely filled by the arrow. Instead, you should use bounding
+ @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.
- @e 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.
*/
- void DrawDropArrow(wxWindow * win, wxDC& dc, const wxRect& rect,
+ void DrawDropArrow(wxWindow* win, wxDC& dc, const wxRect& rect,
int flags);
/**
/**
Draw the header control button (used, for example, by
wxListCtrl). Depending on platforms the
- @e flags parameter may support the @c wxCONTROL_SELECTED
+ @a flags parameter may support the @c wxCONTROL_SELECTED
@c wxCONTROL_DISABLED and @c wxCONTROL_CURRENT bits.
- The @e sortArrow parameter can be one of
+ 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
int DrawHeaderButton(wxWindow* win, wxDC& dc, const wxRect& rect,
int flags = 0,
wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
- wxHeaderButtonParams* params = @NULL);
+ wxHeaderButtonParams* params = NULL);
/**
Draw a selection rectangle underneath the text as used e.g. in a
- wxListCtrl. The supported @e flags are
+ 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
/**
Draw a blank push button that looks very similar to wxButton.
-
- @e flags may have the @c wxCONTROL_PRESSED, @c wxCONTROL_CURRENT or
+ @a flags may have the @c wxCONTROL_PRESSED, @c wxCONTROL_CURRENT or
@c wxCONTROL_ISDEFAULT bit set.
*/
- void DrawPushButton(wxWindow * win, wxDC& dc, const wxRect& rect,
+ void DrawPushButton(wxWindow* win, wxDC& dc, const wxRect& rect,
int flags);
/**
int flags = 0);
/**
- Draw a sash. The @e orient parameter defines whether the sash should be
- vertical or horizontal and how the @e position should be interpreted.
+ 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,
/**
Draw the expanded/collapsed icon for a tree control item. To draw an expanded
- button the @e flags parameter must contain @c wxCONTROL_EXPANDED bit.
+ button the @a flags parameter must contain @c wxCONTROL_EXPANDED bit.
*/
void DrawTreeItemButton(wxWindow* win, wxDC& dc,
const wxRect& rect,
/**
Return the currently used renderer.
*/
-#define wxRendererNative Get() /* implementation is private */
+ wxRendererNative Get();
/**
Return the default (native) implementation for this platform -- this is also
This function is used for version checking: Load()
refuses to load any shared libraries implementing an older or incompatible
version.
-
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.
*/
- wxRendererVersion GetVersion();
+ 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 @e name should be just the base name of the renderer and not the full
+ 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)
on different systems.
/**
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.
*/
-#define wxRendererNative* Set(wxRendererNative* renderer) /* implementation is private */
+ wxRendererNative* Set(wxRendererNative* renderer);
};
+
/**
@class wxRendererVersion
@wxheader{renderer.h}
each time a new virtual method is added and so, at least for the compilers
using a common C++ object model, the calling program is compatible with any
renderer which has the age greater or equal to its age. This verification is
- done by IsCompatible method.
+ done by IsCompatible() method.
@library{wxbase}
@category{FIXME}
/**
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
renderer can be used.
/**
const int age
-
The age component.
*/
/**
const int version
-
The version component.
*/
};
+
projects / wxWidgets.git / blobdiff