Documented wxListItemAttr.

Clarified that item data is asociated with a wxListCtrl
item and not with subitems.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@34760 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Mattia Barbon
2005-06-26 13:51:29 +00:00
parent 93599ac045
commit af90bd4880
3 changed files with 90 additions and 2 deletions

View File

@@ -200,6 +200,7 @@
\input listctrl.tex
\input listevt.tex
\input listitem.tex
\input listattr.tex
\input listview.tex
\input locale.tex
\input log.tex

View File

@@ -0,0 +1,85 @@
\section{\class{wxListItemAttr}}\label{wxListItemAttr}
Represents the attributes (color, font, \ldots) of a
\helpref{wxListCtrl}{wxlistctrl} \helpref{wxListItem}{wxlistctrl}.
\wxheading{Include files}
<wx/listctrl.h>
\wxheading{See also}
\helpref{wxListCtrl overview}{wxlistctrloverview}, \helpref{wxListCtrl}{wxlistctrl}, \helpref{wxListItem}{wxlistitem}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxListItemAttr::wxListItemAttr}\label{wxlistitemattrctor}
\func{}{wxListItemAttr}{\void}
Default constructor.
\func{}{wxListItemAttr}{\param{const wxColour&}{ colText}, \param{const wxColour&}{ colBack}, \param{const wxFont&}{ font}}
Construct a wxListItemAttr with the specified foreground and
background colors and font.
\membersection{wxListItemAttr::GetBackgroundColour}\label{wxlistitemattrgetbackgroundcolour}
\constfunc{const wxColour\&}{GetBackgroundColour}{\void}
Returns the currently set background color.
\membersection{wxListItemAttr::GetFont}\label{wxlistitemattrgetfont}
\constfunc{const wxFont\&}{GetFont}{\void}
Returns the currently set font.
\membersection{wxListItemAttr::GetTextColour}\label{wxlistitemattrgettextcolour}
\constfunc{const wxColour\&}{GetTextColour}{\void}
Returns the currently set text color.
\membersection{wxListItemAttr::HasBackgroundColour}\label{wxlistitemattrhasbackgroundcolour}
\constfunc{bool}{HasBackgroundColour}{\void}
Returns \true if the currently set background color is valid.
\membersection{wxListItemAttr::HasFont}\label{wxlistitemattrhasfont}
\constfunc{bool}{HasFont}{\void}
Returns \true if the currently set font is valid.
\membersection{wxListItemAttr::HasTextColour}\label{wxlistitemattrhastextcolour}
\constfunc{bool}{HasTextColour}{\void}
Returns \true if the currently set text color is valid.
\membersection{wxListItemAttr::SetBackgroundColour}\label{wxlistitemattrsetbackgroundcolour}
\func{void}{SetBackgroundColour}{\param{const wxColour\& }{colour}}
Sets a new background color.
\membersection{wxListItemAttr::SetFont}\label{wxlistitemattrsetfont}
\func{void}{SetFont}{\param{const wxFont\& }{font}}
Sets a new font.
\membersection{wxListItemAttr::SetTextColour}\label{wxlistitemattrsettextcolour}
\func{void}{SetTextColour}{\param{const wxColour\& }{colour}}
Sets a new text color.

View File

@@ -47,7 +47,8 @@ Returns the zero-based column; meaningful only in report mode.
\constfunc{long}{GetData}{\void}
Returns client data associated with the control.
Returns client data associated with the control. Please note that
client data is associated with the item and not with subitems.
\membersection{wxListItem::GetFont}\label{wxlistitemgetfont}
@@ -144,7 +145,8 @@ Sets the zero-based column. Meaningful only in report mode.
\func{void}{SetData}{\param{void* }{data}}
Sets client data for the item.
Sets client data for the item. Please note that
client data is associated with the item and not with subitems.
\membersection{wxListItem::SetFont}\label{wxlistitemsetfont}