document what exactly SetAlignment() expects (bug 1232727) + other minor corrections

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@42374 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/gridattr.tex b/docs/latex/wx/gridattr.tex
index 9611caf848408299222aaa80d9f834779abf5e09..2606e27aabe2dd5892409ffd47fdd23580f757db 100644 (file)
--- a/docs/latex/wx/gridattr.tex
+++ b/docs/latex/wx/gridattr.tex
@@ -27,8 +27,8 @@ 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}
 
 
 \membersection{wxGridCellAttr::Clone}\label{wxgridcellattrclone}
 


@@ -36,6 +36,7 @@ seems to be pretty useless... may be we should just remove it?
 
 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}


@@ -44,6 +45,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
 
 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::DecRef}\label{wxgridcellattrdecref}
 
 \func{void}{DecRef}{\void}


@@ -54,23 +56,29 @@ it until the matching DecRef() is called
 
 Sets the text colour.
 
 
 Sets the text colour.
 

+

 \membersection{wxGridCellAttr::SetBackgroundColour}\label{wxgridcellattrsetbackgroundcolour}
 
 \func{void}{SetBackgroundColour}{\param{const wxColour\& }{colBack}}
 
 Sets the background 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::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.
+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}
 


@@ -143,6 +151,9 @@ accessors
 \perlnote{This method takes no parameters and
 returns a 2-element list {\tt ( hAlign, 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::GetRenderer}\label{wxgridcellattrgetrenderer}
 
 \constfunc{wxGridCellRenderer*}{GetRenderer}{\param{wxGrid* }{grid}, \param{int }{row}, \param{int }{col}}