]> git.saurik.com Git - wxWidgets.git/blame - include/wx/univ/theme.h
Typos and other fixes
[wxWidgets.git] / include / wx / univ / theme.h
CommitLineData
1e6feb95
VZ
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/univ/theme.h
3// Purpose: wxTheme class manages all configurable aspects of the
4// application including the look (wxRenderer), feel
5// (wxInputHandler) and the colours (wxColourScheme)
6// Author: Vadim Zeitlin
7// Modified by:
8// Created: 06.08.00
9// RCS-ID: $Id$
442b35b5 10// Copyright: (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)
1e6feb95
VZ
11// Licence: wxWindows license
12///////////////////////////////////////////////////////////////////////////////
13
14#ifndef _WX_UNIV_THEME_H_
15#define _WX_UNIV_THEME_H_
16
17#ifdef __GNUG__
18 #pragma interface "theme.h"
19#endif
20
21// ----------------------------------------------------------------------------
22// wxTheme
23// ----------------------------------------------------------------------------
24
25class WXDLLEXPORT wxRenderer;
26class WXDLLEXPORT wxColourScheme;
27class WXDLLEXPORT wxInputHandler;
28struct WXDLLEXPORT wxThemeInfo;
29
30class WXDLLEXPORT wxTheme
31{
32public:
33 // static methods
34 // --------------
35
36 // create the default theme
37 static bool CreateDefault();
38
39 // create the theme by name (will return NULL if not found)
40 static wxTheme *Create(const wxString& name);
41
42 // change the current scheme
43 static wxTheme *Set(wxTheme *theme);
44
45 // get the current theme (never NULL)
46 static wxTheme *Get() { return ms_theme; }
47
48 // the theme methods
49 // -----------------
50
51 // get the renderer implementing all the control-drawing operations in
52 // this theme
53 virtual wxRenderer *GetRenderer() = 0;
54
55 // get the input handler of the given type
56 virtual wxInputHandler *GetInputHandler(const wxString& handlerType) = 0;
57
58 // get the colour scheme for the control with this name
59 virtual wxColourScheme *GetColourScheme() = 0;
60
61 // implementation only from now on
62 // -------------------------------
63
64 virtual ~wxTheme();
65
66private:
67 // the list of descriptions of all known themes
68 static wxThemeInfo *ms_allThemes;
69
70 // the current theme
71 static wxTheme *ms_theme;
3ad252c9 72 friend struct WXDLLEXPORT wxThemeInfo;
1e6feb95
VZ
73};
74
75// ----------------------------------------------------------------------------
76// dynamic theme creation helpers
77// ----------------------------------------------------------------------------
78
79struct WXDLLEXPORT wxThemeInfo
80{
81 typedef wxTheme *(*Constructor)();
82
83 // theme name and (user readable) description
84 wxString name, desc;
85
86 // the function to create a theme object
87 Constructor ctor;
88
89 // next node in the linked list or NULL
90 wxThemeInfo *next;
91
92 // constructor for the struct itself
93 wxThemeInfo(Constructor ctor, const wxChar *name, const wxChar *desc);
94};
95
96// ----------------------------------------------------------------------------
97// macros
98// ----------------------------------------------------------------------------
99
100// to use a standard theme insert this macro into one of the application files:
101// without it, an over optimizing linker may discard the object module
102// containing the theme implementation entirely
103#define WX_USE_THEME(themename) \
603fd221 104 WXDLLEXPORT_DATA(extern bool) wxThemeUse##themename; \
1e6feb95
VZ
105 static struct wxThemeUserFor##themename \
106 { \
107 wxThemeUserFor##themename() { wxThemeUse##themename = TRUE; } \
108 } wxThemeDoUse##themename
109
110// to declare a new theme, this macro must be used in the class declaration
111#define WX_DECLARE_THEME(themename) \
112 private: \
113 static wxThemeInfo ms_info##themename; \
114 public: \
115 const wxThemeInfo *GetThemeInfo() const \
116 { return &ms_info##themename; }
117
118// and this one must be inserted in the source file
119#define WX_IMPLEMENT_THEME(classname, themename, themedesc) \
603fd221 120 WXDLLEXPORT_DATA(bool) wxThemeUse##themename = TRUE; \
1e6feb95
VZ
121 wxTheme *wxCtorFor##themename() { return new classname; } \
122 wxThemeInfo classname::ms_info##themename(wxCtorFor##themename, \
f63e248e 123 wxT( #themename ), themedesc)
1e6feb95
VZ
124
125#endif // _WX_UNIV_THEME_H_
126