git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

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