wxWidgets/docs/latex/wx/gridattr.tex

180 lines
4.7 KiB
TeX
Raw Normal View History

%
% 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{Include files}
<wx/grid.h>
\wxheading{Library}
\helpref{wxAdv}{librarieslist}
\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}}
Constructor specifying some of the often used attributes.
\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. \arg{hAlign} can be one of \texttt{wxALIGN\_LEFT},
\texttt{wxALIGN\_CENTRE} or \texttt{wxALIGN\_RIGHT} and \arg{vAlign} can be one
of \texttt{wxALIGN\_TOP}, \texttt{wxALIGN\_CENTRE} or \texttt{wxALIGN\_BOTTOM}.
\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 )}.}
See \helpref{SetAlignment}{wxgridcellattrsetalignment} for the returned values.
\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}}