wxWidgets/interface/wx/systhemectrl.h
Tobias Taschner 2fff3cd29f Add wxSystemThemedControl and use it in wxMSW
wxSystemThemedControl allows to use the "system theme" (i.e. the theme used by
the system applications such as file manager and which can, surprisingly, be
different from the default one). Currently it is only implemented for wxMSW
and does nothing under the other platforms.

Use wxSystemThemedControl for wxDataViewCtrl, wxListCtrl and, optionally, if
wxTR_TWIST_BUTTONS style is specified, wxTreeCtrl to give them more native
appearance under MSW.

Closes #16414.
2015-09-17 14:49:13 +02:00

71 lines
2.4 KiB
C++

/////////////////////////////////////////////////////////////////////////////
// Name: wx/systhemectrl.h
// Purpose: Documentation for wxSystemThemedControl
// Author: Tobias Taschner
// Created: 2014-08-15
// Copyright: (c) 2014 wxWidgets development team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
A helper class making it possible to use system theme for any control.
Under MSW, there an alternative theme available for the list and list-like
controls since Windows Vista. This theme us used by Windows Explorer list
and tree view and so is arguably more familiar to the users than the standard
appearance of these controls.
This class is used in wxWidgets to enable this system theme in wxTreeCtrl,
wxListCtrl and wxDataViewCtrl and thus give them the same, familiar look.
It can also be used as a helper for implementing custom controls with the same
appearance. Notice that when using this class it is especially important
to use wxRendererNative::DrawItemSelectionRect() and
wxRendererNative::DrawItemText() to draw the control items to ensure that
they appear correctly under all platforms and Windows versions.
The following example shows implementation of a system theme enabled wxVListBox:
@code
#include <wx/systhemectrl.h>
class MyListCtrl : public wxSystemThemedControl<wxVListBox>
{
public:
MyListCtrl(wxWindow* parent)
{
...
EnableSystemTheme();
}
void OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const wxOVERRIDE
{
wxRendererNative::GetDefault().DrawItemText(this, dc, "Item #x", rect);
}
};
@endcode
On non-MSW platforms this class currently does nothing but is still
available, so that it can be used in portable code without any conditional
compilation directives.
@category{miscwnd}
@see wxTreeCtrl, wxListCtrl, wxDataViewCtrl, wxRendererNative
@since 3.1.0
*/
template <class C>
class wxSystemThemedControl : public C
{
public:
/// Trival default constructor.
wxSystemThemedControl();
/**
This method may be called to disable the system theme of controls
using it by default.
*/
void EnableSystemTheme(bool enable = true);
};