1wxGridCellAttr(3)          Erlang Module Definition          wxGridCellAttr(3)
2
3
4

NAME

6       wxGridCellAttr - Functions for wxGridCellAttr class
7

DESCRIPTION

9       This  class  can  be used to alter the cells' appearance in the grid by
10       changing their attributes from the defaults. An object  of  this  class
11       may be returned by wxGridTableBase::GetAttr() (not implemented in wx).
12
13       Note  that  objects of this class are reference-counted and it's recom‐
14       mended to use wxGridCellAttrPtr smart pointer class when  working  with
15       them to avoid memory leaks.
16
17       wxWidgets docs: wxGridCellAttr
18

DATA TYPES

20       wxGridCellAttr() = wx:wx_object()
21

EXPORTS

23       setTextColour(This, ColText) -> ok
24
25              Types:
26
27                 This = wxGridCellAttr()
28                 ColText = wx:wx_colour()
29
30              Sets the text colour.
31
32       setBackgroundColour(This, ColBack) -> ok
33
34              Types:
35
36                 This = wxGridCellAttr()
37                 ColBack = wx:wx_colour()
38
39              Sets the background colour.
40
41       setFont(This, Font) -> ok
42
43              Types:
44
45                 This = wxGridCellAttr()
46                 Font = wxFont:wxFont()
47
48              Sets the font.
49
50       setAlignment(This, HAlign, VAlign) -> ok
51
52              Types:
53
54                 This = wxGridCellAttr()
55                 HAlign = VAlign = integer()
56
57              Sets the alignment.
58
59              hAlign  can  be  one  of  wxALIGN_LEFT,  wxALIGN_CENTRE  or  wx‐
60              ALIGN_RIGHT and vAlign can be one of wxALIGN_TOP, wxALIGN_CENTRE
61              or wxALIGN_BOTTOM.
62
63       setReadOnly(This) -> ok
64
65              Types:
66
67                 This = wxGridCellAttr()
68
69       setReadOnly(This, Options :: [Option]) -> ok
70
71              Types:
72
73                 This = wxGridCellAttr()
74                 Option = {isReadOnly, boolean()}
75
76              Sets the cell as read-only.
77
78       setRenderer(This, Renderer) -> ok
79
80              Types:
81
82                 This = wxGridCellAttr()
83                 Renderer = wxGridCellRenderer:wxGridCellRenderer()
84
85              Sets the renderer to be used for cells with this attribute.
86
87              Takes ownership of the pointer.
88
89       setEditor(This, Editor) -> ok
90
91              Types:
92
93                 This = wxGridCellAttr()
94                 Editor = wxGridCellEditor:wxGridCellEditor()
95
96              Sets the editor to be used with the cells with this attribute.
97
98       hasTextColour(This) -> boolean()
99
100              Types:
101
102                 This = wxGridCellAttr()
103
104              Returns true if this attribute has a valid text colour set.
105
106       hasBackgroundColour(This) -> boolean()
107
108              Types:
109
110                 This = wxGridCellAttr()
111
112              Returns  true  if  this  attribute has a valid background colour
113              set.
114
115       hasFont(This) -> boolean()
116
117              Types:
118
119                 This = wxGridCellAttr()
120
121              Returns true if this attribute has a valid font set.
122
123       hasAlignment(This) -> boolean()
124
125              Types:
126
127                 This = wxGridCellAttr()
128
129              Returns true if this attribute has a valid alignment set.
130
131       hasRenderer(This) -> boolean()
132
133              Types:
134
135                 This = wxGridCellAttr()
136
137              Returns true if this attribute has a valid cell renderer set.
138
139       hasEditor(This) -> boolean()
140
141              Types:
142
143                 This = wxGridCellAttr()
144
145              Returns true if this attribute has a valid cell editor set.
146
147       getTextColour(This) -> wx:wx_colour4()
148
149              Types:
150
151                 This = wxGridCellAttr()
152
153              Returns the text colour.
154
155       getBackgroundColour(This) -> wx:wx_colour4()
156
157              Types:
158
159                 This = wxGridCellAttr()
160
161              Returns the background colour.
162
163       getFont(This) -> wxFont:wxFont()
164
165              Types:
166
167                 This = wxGridCellAttr()
168
169              Returns the font.
170
171       getAlignment(This) -> {HAlign :: integer(), VAlign :: integer()}
172
173              Types:
174
175                 This = wxGridCellAttr()
176
177              Get the alignment to use for the cell with the given attribute.
178
179              If this attribute doesn't specify any alignment, the default at‐
180              tribute  alignment  is  used  (which  can  be  changed using wx‐
181              Grid:setDefaultCellAlignment/3 but is left and top by default).
182
183              Notice that hAlign and vAlign values are always  overwritten  by
184              this  function, use GetNonDefaultAlignment() (not implemented in
185              wx) if this is not desirable.
186
187       getRenderer(This, Grid, Row, Col) ->
188                      wxGridCellRenderer:wxGridCellRenderer()
189
190              Types:
191
192                 This = wxGridCellAttr()
193                 Grid = wxGrid:wxGrid()
194                 Row = Col = integer()
195
196              Returns the cell renderer.
197
198              The caller is responsible for calling DecRef() (not  implemented
199              in wx) on the returned pointer, use GetRendererPtr() (not imple‐
200              mented in wx) to do it automatically.
201
202       getEditor(This, Grid, Row, Col) ->
203                    wxGridCellEditor:wxGridCellEditor()
204
205              Types:
206
207                 This = wxGridCellAttr()
208                 Grid = wxGrid:wxGrid()
209                 Row = Col = integer()
210
211              Returns the cell editor.
212
213              The caller is responsible for calling DecRef() (not  implemented
214              in  wx)  on the returned pointer, use GetEditorPtr() (not imple‐
215              mented in wx) to do it automatically.
216
217       isReadOnly(This) -> boolean()
218
219              Types:
220
221                 This = wxGridCellAttr()
222
223              Returns true if this cell is set as read-only.
224
225       setDefAttr(This, DefAttr) -> ok
226
227              Types:
228
229                 This = DefAttr = wxGridCellAttr()
230
231
232
233wxWidgets team.                     wx 2.1                   wxGridCellAttr(3)