Added EVT_MOVE_START, EVT_MOVE_END (wxMSW only for now)

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

diff --git a/docs/latex/wx/gridattr.tex b/docs/latex/wx/gridattr.tex
index 600dee811bea9d5c70d183876483ce890305666c..7cc7eade1a4372721bbda49510314604eb31b6bb 100644 (file)
--- a/docs/latex/wx/gridattr.tex
+++ b/docs/latex/wx/gridattr.tex
@@ -3,52 +3,49 @@
 % grid.h at 11/May/00 18:30:19
 %
 
-
 \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().
 
-
 \wxheading{Derived from}
 
 No base class
 
-\wxheading{Data structures}
+\wxheading{Include files}
 
-\latexignore{\rtfignore{\wxheading{Members}}}
+<wx/grid.h>
 
+\wxheading{Library}
 
-\membersection{wxGridCellAttr::wxGridCellAttr}\label{wxgridcellattrwxgridcellattr}
+\helpref{wxAdv}{librarieslist}
 
-\func{}{wxGridCellAttr}{\void}
+\latexignore{\rtfignore{\wxheading{Members}}}
 
-ctors
+\membersection{wxGridCellAttr::wxGridCellAttr}\label{wxgridcellattrwxgridcellattr}
 
+\func{}{wxGridCellAttr}{\void}
 
-\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}}
 
-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}
 
-creates a new copy of this object
+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
+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
 
@@ -57,32 +54,39 @@ it until the matching DecRef() is called
 
 \func{void}{DecRef}{\void}
 
-
 \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}}
 
+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}}
+\func{void}{SetReadOnly}{\param{bool }{isReadOnly = true}}
 
 
 \membersection{wxGridCellAttr::SetRenderer}\label{wxgridcellattrsetrenderer}
@@ -148,6 +152,11 @@ accessors
 
 \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}