]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/gridattr.tex
ugh. Nesting the (per class) plugin sentries can require them to
[wxWidgets.git] / docs / latex / wx / gridattr.tex
... / ...
CommitLineData
1%
2% automatically generated by HelpGen from
3% grid.h at 11/May/00 18:30:19
4%
5
6\section{\class{wxGridCellAttr}}\label{wxgridcellattr}
7
8This class can be used to alter the cells' appearance in
9the grid by changing their colour/font/... from default. An object of this
10class may be returned by wxGridTable::GetAttr().
11
12\wxheading{Derived from}
13
14No base class
15
16\wxheading{Data structures}
17
18\latexignore{\rtfignore{\wxheading{Members}}}
19
20\membersection{wxGridCellAttr::wxGridCellAttr}\label{wxgridcellattrwxgridcellattr}
21
22\func{}{wxGridCellAttr}{\void}
23
24Default constructor.
25
26\func{}{wxGridCellAttr}{\param{const wxColour\& }{colText}, \param{const wxColour\& }{colBack}, \param{const wxFont\& }{font}, \param{int }{hAlign}, \param{int }{vAlign}}
27
28VZ: considering the number of members wxGridCellAttr has now, this ctor
29seems to be pretty useless... may be we should just remove it?
30
31\membersection{wxGridCellAttr::Clone}\label{wxgridcellattrclone}
32
33\constfunc{wxGridCellAttr*}{Clone}{\void}
34
35Creates a new copy of this object.
36
37\membersection{wxGridCellAttr::IncRef}\label{wxgridcellattrincref}
38
39\func{void}{IncRef}{\void}
40
41This class is ref counted: it is created with ref count of 1, so
42calling DecRef() once will delete it. Calling IncRef() allows to lock
43it until the matching DecRef() is called
44
45\membersection{wxGridCellAttr::DecRef}\label{wxgridcellattrdecref}
46
47\func{void}{DecRef}{\void}
48
49\membersection{wxGridCellAttr::SetTextColour}\label{wxgridcellattrsettextcolour}
50
51\func{void}{SetTextColour}{\param{const wxColour\& }{colText}}
52
53Sets the text colour.
54
55\membersection{wxGridCellAttr::SetBackgroundColour}\label{wxgridcellattrsetbackgroundcolour}
56
57\func{void}{SetBackgroundColour}{\param{const wxColour\& }{colBack}}
58
59Sets the background colour.
60
61\membersection{wxGridCellAttr::SetFont}\label{wxgridcellattrsetfont}
62
63\func{void}{SetFont}{\param{const wxFont\& }{font}}
64
65Sets the font.
66
67\membersection{wxGridCellAttr::SetAlignment}\label{wxgridcellattrsetalignment}
68
69\func{void}{SetAlignment}{\param{int }{hAlign}, \param{int }{vAlign}}
70
71Sets the alignment.
72
73\membersection{wxGridCellAttr::SetReadOnly}\label{wxgridcellattrsetreadonly}
74
75\func{void}{SetReadOnly}{\param{bool }{isReadOnly = TRUE}}
76
77
78\membersection{wxGridCellAttr::SetRenderer}\label{wxgridcellattrsetrenderer}
79
80\func{void}{SetRenderer}{\param{wxGridCellRenderer* }{renderer}}
81
82takes ownership of the pointer
83
84
85\membersection{wxGridCellAttr::SetEditor}\label{wxgridcellattrseteditor}
86
87\func{void}{SetEditor}{\param{wxGridCellEditor* }{editor}}
88
89
90\membersection{wxGridCellAttr::HasTextColour}\label{wxgridcellattrhastextcolour}
91
92\constfunc{bool}{HasTextColour}{\void}
93
94accessors
95
96
97\membersection{wxGridCellAttr::HasBackgroundColour}\label{wxgridcellattrhasbackgroundcolour}
98
99\constfunc{bool}{HasBackgroundColour}{\void}
100
101
102\membersection{wxGridCellAttr::HasFont}\label{wxgridcellattrhasfont}
103
104\constfunc{bool}{HasFont}{\void}
105
106
107\membersection{wxGridCellAttr::HasAlignment}\label{wxgridcellattrhasalignment}
108
109\constfunc{bool}{HasAlignment}{\void}
110
111
112\membersection{wxGridCellAttr::HasRenderer}\label{wxgridcellattrhasrenderer}
113
114\constfunc{bool}{HasRenderer}{\void}
115
116
117\membersection{wxGridCellAttr::HasEditor}\label{wxgridcellattrhaseditor}
118
119\constfunc{bool}{HasEditor}{\void}
120
121
122\membersection{wxGridCellAttr::GetTextColour}\label{wxgridcellattrgettextcolour}
123
124\constfunc{const wxColour\&}{GetTextColour}{\void}
125
126
127\membersection{wxGridCellAttr::GetBackgroundColour}\label{wxgridcellattrgetbackgroundcolour}
128
129\constfunc{const wxColour\&}{GetBackgroundColour}{\void}
130
131
132\membersection{wxGridCellAttr::GetFont}\label{wxgridcellattrgetfont}
133
134\constfunc{const wxFont\&}{GetFont}{\void}
135
136
137\membersection{wxGridCellAttr::GetAlignment}\label{wxgridcellattrgetalignment}
138
139\constfunc{void}{GetAlignment}{\param{int* }{hAlign}, \param{int* }{vAlign}}
140
141
142\membersection{wxGridCellAttr::GetRenderer}\label{wxgridcellattrgetrenderer}
143
144\constfunc{wxGridCellRenderer*}{GetRenderer}{\param{wxGrid* }{grid}, \param{int }{row}, \param{int }{col}}
145
146
147\membersection{wxGridCellAttr::GetEditor}\label{wxgridcellattrgeteditor}
148
149\constfunc{wxGridCellEditor*}{GetEditor}{\param{wxGrid* }{grid}, \param{int }{row}, \param{int }{col}}
150
151
152\membersection{wxGridCellAttr::IsReadOnly}\label{wxgridcellattrisreadonly}
153
154\constfunc{bool}{IsReadOnly}{\void}
155
156
157\membersection{wxGridCellAttr::SetDefAttr}\label{wxgridcellattrsetdefattr}
158
159\func{void}{SetDefAttr}{\param{wxGridCellAttr* }{defAttr}}
160