1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/////////////////////////////////////////////////////////////////////////////
// Name: wx/itemattr.h
// Purpose: wxItemAttr documentation
// Author: Vadim Zeitlin
// Copyright: (c) 2016 Vadim Zeitlin <vadim@wxwidgets.org>
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxItemAttr
Represents the attributes (colour, font, ...) of an item of a control with
multiple items such as e.g. wxListCtrl.
@library{wxcore}
@category{data}
@see @ref overview_listctrl
@since 3.1.1 (previous versions had a similar wxListItemAttr class)
*/
class wxItemAttr
{
public:
/**
Default Constructor.
*/
wxItemAttr();
/**
Construct a wxItemAttr with the specified foreground and
background colours and font.
*/
wxItemAttr(const wxColour& colText,
const wxColour& colBack,
const wxFont& font);
/**
Compare two item attributes for equality.
*/
bool operator==(const wxItemAttr& other) const;
/**
Compare two item attributes for inequality.
*/
bool operator!=(const wxItemAttr& other) const;
/**
Returns the currently set background colour.
*/
const wxColour& GetBackgroundColour() const;
/**
Returns the currently set font.
*/
const wxFont& GetFont() const;
/**
Returns the currently set text colour.
*/
const wxColour& GetTextColour() const;
/**
Returns @true if the currently set background colour is valid.
*/
bool HasBackgroundColour() const;
/**
Returns @true if either text or background colour is set.
@see HasBackgroundColour(), HasTextColour()
*/
bool HasColours() const;
/**
Returns @true if the currently set font is valid.
*/
bool HasFont() const;
/**
Returns @true if the currently set text colour is valid.
*/
bool HasTextColour() const;
/**
Returns @true if this object has no custom attributes set.
*/
bool IsDefault() const;
/**
Sets a new background colour.
*/
void SetBackgroundColour(const wxColour& colour);
/**
Sets a new font.
*/
void SetFont(const wxFont& font);
/**
Sets a new text colour.
*/
void SetTextColour(const wxColour& colour);
};
|
