[wxWidgets.git] / docs / latex / wx / gridattr.tex

%
% automatically generated by HelpGen from
% grid.h at 11/May/00 18:30:19
%

\section{\class{wxGridCellAttr}}\label{wxgridcellattr}

This class can be used to alter the cells' appearance in
the grid by changing their colour/font/... from default. An object of this
class may be returned by wxGridTable::GetAttr().

\wxheading{Derived from}

No base class

\wxheading{Data structures}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxGridCellAttr::wxGridCellAttr}\label{wxgridcellattrwxgridcellattr}

\func{}{wxGridCellAttr}{\void}

Default constructor.
            
\func{}{wxGridCellAttr}{\param{const wxColour\& }{colText}, \param{const wxColour\& }{colBack}, \param{const wxFont\& }{font}, \param{int }{hAlign}, \param{int }{vAlign}}

VZ: considering the number of members wxGridCellAttr has now, this ctor
seems to be pretty useless... may be we should just remove it?

\membersection{wxGridCellAttr::Clone}\label{wxgridcellattrclone}

\constfunc{wxGridCellAttr*}{Clone}{\void}

Creates a new copy of this object.

\membersection{wxGridCellAttr::IncRef}\label{wxgridcellattrincref}

\func{void}{IncRef}{\void}

This class is ref counted: it is created with ref count of 1, so
calling DecRef() once will delete it. Calling IncRef() allows to lock
it until the matching DecRef() is called

\membersection{wxGridCellAttr::DecRef}\label{wxgridcellattrdecref}

\func{void}{DecRef}{\void}

\membersection{wxGridCellAttr::SetTextColour}\label{wxgridcellattrsettextcolour}

\func{void}{SetTextColour}{\param{const wxColour\& }{colText}}

Sets the text colour.

\membersection{wxGridCellAttr::SetBackgroundColour}\label{wxgridcellattrsetbackgroundcolour}

\func{void}{SetBackgroundColour}{\param{const wxColour\& }{colBack}}

Sets the background colour.

\membersection{wxGridCellAttr::SetFont}\label{wxgridcellattrsetfont}

\func{void}{SetFont}{\param{const wxFont\& }{font}}

Sets the font.

\membersection{wxGridCellAttr::SetAlignment}\label{wxgridcellattrsetalignment}

\func{void}{SetAlignment}{\param{int }{hAlign}, \param{int }{vAlign}}

Sets the alignment.

\membersection{wxGridCellAttr::SetReadOnly}\label{wxgridcellattrsetreadonly}

\func{void}{SetReadOnly}{\param{bool }{isReadOnly = TRUE}}


\membersection{wxGridCellAttr::SetRenderer}\label{wxgridcellattrsetrenderer}

\func{void}{SetRenderer}{\param{wxGridCellRenderer* }{renderer}}

takes ownership of the pointer


\membersection{wxGridCellAttr::SetEditor}\label{wxgridcellattrseteditor}

\func{void}{SetEditor}{\param{wxGridCellEditor* }{editor}}


\membersection{wxGridCellAttr::HasTextColour}\label{wxgridcellattrhastextcolour}

\constfunc{bool}{HasTextColour}{\void}

accessors


\membersection{wxGridCellAttr::HasBackgroundColour}\label{wxgridcellattrhasbackgroundcolour}

\constfunc{bool}{HasBackgroundColour}{\void}


\membersection{wxGridCellAttr::HasFont}\label{wxgridcellattrhasfont}

\constfunc{bool}{HasFont}{\void}


\membersection{wxGridCellAttr::HasAlignment}\label{wxgridcellattrhasalignment}

\constfunc{bool}{HasAlignment}{\void}


\membersection{wxGridCellAttr::HasRenderer}\label{wxgridcellattrhasrenderer}

\constfunc{bool}{HasRenderer}{\void}


\membersection{wxGridCellAttr::HasEditor}\label{wxgridcellattrhaseditor}

\constfunc{bool}{HasEditor}{\void}


\membersection{wxGridCellAttr::GetTextColour}\label{wxgridcellattrgettextcolour}

\constfunc{const wxColour\&}{GetTextColour}{\void}


\membersection{wxGridCellAttr::GetBackgroundColour}\label{wxgridcellattrgetbackgroundcolour}

\constfunc{const wxColour\&}{GetBackgroundColour}{\void}


\membersection{wxGridCellAttr::GetFont}\label{wxgridcellattrgetfont}

\constfunc{const wxFont\&}{GetFont}{\void}


\membersection{wxGridCellAttr::GetAlignment}\label{wxgridcellattrgetalignment}

\constfunc{void}{GetAlignment}{\param{int* }{hAlign}, \param{int* }{vAlign}}

\perlnote{This method takes no parameters and
returns a 2-element list {\tt ( hAlign, vAlign )}.}

\membersection{wxGridCellAttr::GetRenderer}\label{wxgridcellattrgetrenderer}

\constfunc{wxGridCellRenderer*}{GetRenderer}{\param{wxGrid* }{grid}, \param{int }{row}, \param{int }{col}}


\membersection{wxGridCellAttr::GetEditor}\label{wxgridcellattrgeteditor}

\constfunc{wxGridCellEditor*}{GetEditor}{\param{wxGrid* }{grid}, \param{int }{row}, \param{int }{col}}


\membersection{wxGridCellAttr::IsReadOnly}\label{wxgridcellattrisreadonly}

\constfunc{bool}{IsReadOnly}{\void}


\membersection{wxGridCellAttr::SetDefAttr}\label{wxgridcellattrsetdefattr}

\func{void}{SetDefAttr}{\param{wxGridCellAttr* }{defAttr}}
Commit	Line	Data
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}
03817a5e MB	7
2eebb742	8	This class can be used to alter the cells' appearance in
03817a5e MB	9	the grid by changing their colour/font/... from default. An object of this
	10	class may be returned by wxGridTable::GetAttr().
	11
03817a5e MB	12	\wxheading{Derived from}
	13
	14	No base class
	15
	16	\wxheading{Data structures}
	17
	18	\latexignore{\rtfignore{\wxheading{Members}}}
	19
03817a5e MB	20	\membersection{wxGridCellAttr::wxGridCellAttr}\label{wxgridcellattrwxgridcellattr}
	21
	22	\func{}{wxGridCellAttr}{\void}
	23
2eebb742 JS	24	Default constructor.
2eebb742 JS	25
03817a5e MB	26	\func{}{wxGridCellAttr}{\param{const wxColour\& }{colText}, \param{const wxColour\& }{colBack}, \param{const wxFont\& }{font}, \param{int }{hAlign}, \param{int }{vAlign}}
	27
	28	VZ: considering the number of members wxGridCellAttr has now, this ctor
	29	seems to be pretty useless... may be we should just remove it?
	30
03817a5e MB	31	\membersection{wxGridCellAttr::Clone}\label{wxgridcellattrclone}
	32
	33	\constfunc{wxGridCellAttr*}{Clone}{\void}
	34
2eebb742	35	Creates a new copy of this object.
03817a5e MB	36
	37	\membersection{wxGridCellAttr::IncRef}\label{wxgridcellattrincref}
	38
	39	\func{void}{IncRef}{\void}
	40
2eebb742	41	This class is ref counted: it is created with ref count of 1, so
03817a5e MB	42	calling DecRef() once will delete it. Calling IncRef() allows to lock
	43	it until the matching DecRef() is called
	44
03817a5e MB	45	\membersection{wxGridCellAttr::DecRef}\label{wxgridcellattrdecref}
	46
	47	\func{void}{DecRef}{\void}
	48
03817a5e MB	49	\membersection{wxGridCellAttr::SetTextColour}\label{wxgridcellattrsettextcolour}
	50
	51	\func{void}{SetTextColour}{\param{const wxColour\& }{colText}}
	52
2eebb742	53	Sets the text colour.
03817a5e MB	54
	55	\membersection{wxGridCellAttr::SetBackgroundColour}\label{wxgridcellattrsetbackgroundcolour}
	56
	57	\func{void}{SetBackgroundColour}{\param{const wxColour\& }{colBack}}
	58
2eebb742	59	Sets the background colour.
03817a5e MB	60
	61	\membersection{wxGridCellAttr::SetFont}\label{wxgridcellattrsetfont}
	62
	63	\func{void}{SetFont}{\param{const wxFont\& }{font}}
	64
2eebb742	65	Sets the font.
03817a5e MB	66
	67	\membersection{wxGridCellAttr::SetAlignment}\label{wxgridcellattrsetalignment}
	68
	69	\func{void}{SetAlignment}{\param{int }{hAlign}, \param{int }{vAlign}}
	70
2eebb742	71	Sets the alignment.
03817a5e MB	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
	82	takes 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
	94	accessors
	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
9722642d MB	141	\perlnote{This method takes no parameters and
9722642d MB	142	returns a 2-element list {\tt ( hAlign, vAlign )}.}
03817a5e MB	143
	144	\membersection{wxGridCellAttr::GetRenderer}\label{wxgridcellattrgetrenderer}
	145
	146	\constfunc{wxGridCellRenderer}{GetRenderer}{\param{wxGrid }{grid}, \param{int }{row}, \param{int }{col}}
	147
	148
	149	\membersection{wxGridCellAttr::GetEditor}\label{wxgridcellattrgeteditor}
	150
	151	\constfunc{wxGridCellEditor}{GetEditor}{\param{wxGrid }{grid}, \param{int }{row}, \param{int }{col}}
	152
	153
	154	\membersection{wxGridCellAttr::IsReadOnly}\label{wxgridcellattrisreadonly}
	155
	156	\constfunc{bool}{IsReadOnly}{\void}
	157
	158
	159	\membersection{wxGridCellAttr::SetDefAttr}\label{wxgridcellattrsetdefattr}
	160
	161	\func{void}{SetDefAttr}{\param{wxGridCellAttr* }{defAttr}}
	162