]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/gridattr.tex
Wine fixes
[wxWidgets.git] / docs / latex / wx / gridattr.tex
index 600dee811bea9d5c70d183876483ce890305666c..2606e27aabe2dd5892409ffd47fdd23580f757db 100644 (file)
@@ -3,52 +3,45 @@
 % grid.h at 11/May/00 18:30:19
 %
 
 % grid.h at 11/May/00 18:30:19
 %
 
-
 \section{\class{wxGridCellAttr}}\label{wxgridcellattr}
 
 \section{\class{wxGridCellAttr}}\label{wxgridcellattr}
 
-
-
-wxGridCellAttr: this class can be used to alter the cells appearance in
+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().
 
 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{Derived from}
 
 No base class
 
-\wxheading{Data structures}
+\wxheading{Include files}
 
 
-\latexignore{\rtfignore{\wxheading{Members}}}
+<wx/grid.h>
 
 
+\latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellAttr::wxGridCellAttr}\label{wxgridcellattrwxgridcellattr}
 
 \func{}{wxGridCellAttr}{\void}
 
 
 \membersection{wxGridCellAttr::wxGridCellAttr}\label{wxgridcellattrwxgridcellattr}
 
 \func{}{wxGridCellAttr}{\void}
 
-ctors
-
-
-\membersection{wxGridCellAttr::wxGridCellAttr}\label{wxgridcellattrwxgridcellattr}
+Default constructor.
 
 \func{}{wxGridCellAttr}{\param{const wxColour\& }{colText}, \param{const wxColour\& }{colBack}, \param{const wxFont\& }{font}, \param{int }{hAlign}, \param{int }{vAlign}}
 
 
 \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?
+Constructor specifying some of the often used attributes.
 
 
 \membersection{wxGridCellAttr::Clone}\label{wxgridcellattrclone}
 
 \constfunc{wxGridCellAttr*}{Clone}{\void}
 
 
 
 \membersection{wxGridCellAttr::Clone}\label{wxgridcellattrclone}
 
 \constfunc{wxGridCellAttr*}{Clone}{\void}
 
-creates a new copy of this object
+Creates a new copy of this object.
 
 
 \membersection{wxGridCellAttr::IncRef}\label{wxgridcellattrincref}
 
 \func{void}{IncRef}{\void}
 
 
 
 \membersection{wxGridCellAttr::IncRef}\label{wxgridcellattrincref}
 
 \func{void}{IncRef}{\void}
 
-this class is ref counted: it is created with ref count of 1, so
+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
 
 calling DecRef() once will delete it. Calling IncRef() allows to lock
 it until the matching DecRef() is called
 
@@ -57,32 +50,39 @@ it until the matching DecRef() is called
 
 \func{void}{DecRef}{\void}
 
 
 \func{void}{DecRef}{\void}
 
-
 \membersection{wxGridCellAttr::SetTextColour}\label{wxgridcellattrsettextcolour}
 
 \func{void}{SetTextColour}{\param{const wxColour\& }{colText}}
 
 \membersection{wxGridCellAttr::SetTextColour}\label{wxgridcellattrsettextcolour}
 
 \func{void}{SetTextColour}{\param{const wxColour\& }{colText}}
 
-setters
+Sets the text colour.
 
 
 \membersection{wxGridCellAttr::SetBackgroundColour}\label{wxgridcellattrsetbackgroundcolour}
 
 \func{void}{SetBackgroundColour}{\param{const wxColour\& }{colBack}}
 
 
 
 \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}}
 
 
 \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}}
 
 
 \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}
 
 
 \membersection{wxGridCellAttr::SetReadOnly}\label{wxgridcellattrsetreadonly}
 
-\func{void}{SetReadOnly}{\param{bool }{isReadOnly = TRUE}}
+\func{void}{SetReadOnly}{\param{bool }{isReadOnly = true}}
 
 
 \membersection{wxGridCellAttr::SetRenderer}\label{wxgridcellattrsetrenderer}
 
 
 \membersection{wxGridCellAttr::SetRenderer}\label{wxgridcellattrsetrenderer}
@@ -148,6 +148,11 @@ accessors
 
 \constfunc{void}{GetAlignment}{\param{int* }{hAlign}, \param{int* }{vAlign}}
 
 
 \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}
 
 
 \membersection{wxGridCellAttr::GetRenderer}\label{wxgridcellattrgetrenderer}