]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/gridattr.tex
remove C++ comment
[wxWidgets.git] / docs / latex / wx / gridattr.tex
index ca95c4c5a2b60e405e6854547a9203350014966f..7cc7eade1a4372721bbda49510314604eb31b6bb 100644 (file)
@@ -13,7 +13,13 @@ class may be returned by wxGridTable::GetAttr().
 
 No base class
 
-\wxheading{Data structures}
+\wxheading{Include files}
+
+<wx/grid.h>
+
+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -22,11 +28,11 @@ No base class
 \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?
+Constructor specifying some of the often used attributes.
+
 
 \membersection{wxGridCellAttr::Clone}\label{wxgridcellattrclone}
 
@@ -34,6 +40,7 @@ seems to be pretty useless... may be we should just remove it?
 
 Creates a new copy of this object.
 
+
 \membersection{wxGridCellAttr::IncRef}\label{wxgridcellattrincref}
 
 \func{void}{IncRef}{\void}
@@ -42,6 +49,7 @@ 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}
@@ -52,27 +60,33 @@ it until the matching DecRef() is called
 
 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.
+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}
@@ -138,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}