]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/gridattr.tex
use 'neither ... nor ...' instead of 'neither ... or ...' in wxFinite documentation
[wxWidgets.git] / docs / latex / wx / gridattr.tex
CommitLineData
03817a5e
MB
1%
2% automatically generated by HelpGen from
3% grid.h at 11/May/00 18:30:19
4%
5
03817a5e
MB
6\section{\class{wxGridCellAttr}}\label{wxgridcellattr}
7
2eebb742 8This class can be used to alter the cells' appearance in
03817a5e
MB
9the grid by changing their colour/font/... from default. An object of this
10class may be returned by wxGridTable::GetAttr().
11
03817a5e
MB
12\wxheading{Derived from}
13
14No base class
15
0e10e38d
VZ
16\wxheading{Include files}
17
18<wx/grid.h>
03817a5e
MB
19
20\latexignore{\rtfignore{\wxheading{Members}}}
21
03817a5e
MB
22\membersection{wxGridCellAttr::wxGridCellAttr}\label{wxgridcellattrwxgridcellattr}
23
24\func{}{wxGridCellAttr}{\void}
25
2eebb742 26Default constructor.
095e0f91 27
03817a5e
MB
28\func{}{wxGridCellAttr}{\param{const wxColour\& }{colText}, \param{const wxColour\& }{colBack}, \param{const wxFont\& }{font}, \param{int }{hAlign}, \param{int }{vAlign}}
29
933c79ec
VZ
30Constructor specifying some of the often used attributes.
31
03817a5e 32
03817a5e
MB
33\membersection{wxGridCellAttr::Clone}\label{wxgridcellattrclone}
34
35\constfunc{wxGridCellAttr*}{Clone}{\void}
36
2eebb742 37Creates a new copy of this object.
03817a5e 38
933c79ec 39
03817a5e
MB
40\membersection{wxGridCellAttr::IncRef}\label{wxgridcellattrincref}
41
42\func{void}{IncRef}{\void}
43
2eebb742 44This class is ref counted: it is created with ref count of 1, so
03817a5e
MB
45calling DecRef() once will delete it. Calling IncRef() allows to lock
46it until the matching DecRef() is called
47
933c79ec 48
03817a5e
MB
49\membersection{wxGridCellAttr::DecRef}\label{wxgridcellattrdecref}
50
51\func{void}{DecRef}{\void}
52
03817a5e
MB
53\membersection{wxGridCellAttr::SetTextColour}\label{wxgridcellattrsettextcolour}
54
55\func{void}{SetTextColour}{\param{const wxColour\& }{colText}}
56
2eebb742 57Sets the text colour.
03817a5e 58
933c79ec 59
03817a5e
MB
60\membersection{wxGridCellAttr::SetBackgroundColour}\label{wxgridcellattrsetbackgroundcolour}
61
62\func{void}{SetBackgroundColour}{\param{const wxColour\& }{colBack}}
63
2eebb742 64Sets the background colour.
03817a5e 65
933c79ec 66
03817a5e
MB
67\membersection{wxGridCellAttr::SetFont}\label{wxgridcellattrsetfont}
68
69\func{void}{SetFont}{\param{const wxFont\& }{font}}
70
2eebb742 71Sets the font.
03817a5e 72
933c79ec 73
03817a5e
MB
74\membersection{wxGridCellAttr::SetAlignment}\label{wxgridcellattrsetalignment}
75
76\func{void}{SetAlignment}{\param{int }{hAlign}, \param{int }{vAlign}}
77
933c79ec
VZ
78Sets the alignment. \arg{hAlign} can be one of \texttt{wxALIGN\_LEFT},
79\texttt{wxALIGN\_CENTRE} or \texttt{wxALIGN\_RIGHT} and \arg{vAlign} can be one
80of \texttt{wxALIGN\_TOP}, \texttt{wxALIGN\_CENTRE} or \texttt{wxALIGN\_BOTTOM}.
81
03817a5e
MB
82
83\membersection{wxGridCellAttr::SetReadOnly}\label{wxgridcellattrsetreadonly}
84
cc81d32f 85\func{void}{SetReadOnly}{\param{bool }{isReadOnly = true}}
03817a5e
MB
86
87
88\membersection{wxGridCellAttr::SetRenderer}\label{wxgridcellattrsetrenderer}
89
90\func{void}{SetRenderer}{\param{wxGridCellRenderer* }{renderer}}
91
92takes ownership of the pointer
93
94
95\membersection{wxGridCellAttr::SetEditor}\label{wxgridcellattrseteditor}
96
97\func{void}{SetEditor}{\param{wxGridCellEditor* }{editor}}
98
99
100\membersection{wxGridCellAttr::HasTextColour}\label{wxgridcellattrhastextcolour}
101
102\constfunc{bool}{HasTextColour}{\void}
103
104accessors
105
106
107\membersection{wxGridCellAttr::HasBackgroundColour}\label{wxgridcellattrhasbackgroundcolour}
108
109\constfunc{bool}{HasBackgroundColour}{\void}
110
111
112\membersection{wxGridCellAttr::HasFont}\label{wxgridcellattrhasfont}
113
114\constfunc{bool}{HasFont}{\void}
115
116
117\membersection{wxGridCellAttr::HasAlignment}\label{wxgridcellattrhasalignment}
118
119\constfunc{bool}{HasAlignment}{\void}
120
121
122\membersection{wxGridCellAttr::HasRenderer}\label{wxgridcellattrhasrenderer}
123
124\constfunc{bool}{HasRenderer}{\void}
125
126
127\membersection{wxGridCellAttr::HasEditor}\label{wxgridcellattrhaseditor}
128
129\constfunc{bool}{HasEditor}{\void}
130
131
132\membersection{wxGridCellAttr::GetTextColour}\label{wxgridcellattrgettextcolour}
133
134\constfunc{const wxColour\&}{GetTextColour}{\void}
135
136
137\membersection{wxGridCellAttr::GetBackgroundColour}\label{wxgridcellattrgetbackgroundcolour}
138
139\constfunc{const wxColour\&}{GetBackgroundColour}{\void}
140
141
142\membersection{wxGridCellAttr::GetFont}\label{wxgridcellattrgetfont}
143
144\constfunc{const wxFont\&}{GetFont}{\void}
145
146
147\membersection{wxGridCellAttr::GetAlignment}\label{wxgridcellattrgetalignment}
148
149\constfunc{void}{GetAlignment}{\param{int* }{hAlign}, \param{int* }{vAlign}}
150
9722642d
MB
151\perlnote{This method takes no parameters and
152returns a 2-element list {\tt ( hAlign, vAlign )}.}
03817a5e 153
933c79ec
VZ
154See \helpref{SetAlignment}{wxgridcellattrsetalignment} for the returned values.
155
156
03817a5e
MB
157\membersection{wxGridCellAttr::GetRenderer}\label{wxgridcellattrgetrenderer}
158
159\constfunc{wxGridCellRenderer*}{GetRenderer}{\param{wxGrid* }{grid}, \param{int }{row}, \param{int }{col}}
160
161
162\membersection{wxGridCellAttr::GetEditor}\label{wxgridcellattrgeteditor}
163
164\constfunc{wxGridCellEditor*}{GetEditor}{\param{wxGrid* }{grid}, \param{int }{row}, \param{int }{col}}
165
166
167\membersection{wxGridCellAttr::IsReadOnly}\label{wxgridcellattrisreadonly}
168
169\constfunc{bool}{IsReadOnly}{\void}
170
171
172\membersection{wxGridCellAttr::SetDefAttr}\label{wxgridcellattrsetdefattr}
173
174\func{void}{SetDefAttr}{\param{wxGridCellAttr* }{defAttr}}
175