docs/latex/wx/listattr.tex

   1 \section{\class{wxListItemAttr}}\label{wxListItemAttr}
   2
   3 Represents the attributes (color, font, \ldots) of a
   4 \helpref{wxListCtrl}{wxlistctrl} \helpref{wxListItem}{wxlistctrl}.
   5
   6 \wxheading{Include files}
   7
   8 <wx/listctrl.h>
   9
  10 \wxheading{See also}
  11
  12 \helpref{wxListCtrl overview}{wxlistctrloverview}, \helpref{wxListCtrl}{wxlistctrl}, \helpref{wxListItem}{wxlistitem}
  13
  14 \latexignore{\rtfignore{\wxheading{Members}}}
  15
  16 \membersection{wxListItemAttr::wxListItemAttr}\label{wxlistitemattrctor}
  17
  18 \func{}{wxListItemAttr}{\void}
  19
  20 Default constructor.
  21
  22 \func{}{wxListItemAttr}{\param{const wxColour&}{ colText}, \param{const wxColour&}{ colBack}, \param{const wxFont&}{ font}}
  23
  24 Construct a wxListItemAttr with the specified foreground and
  25 background colors and font.
  26
  27 \membersection{wxListItemAttr::GetBackgroundColour}\label{wxlistitemattrgetbackgroundcolour}
  28
  29 \constfunc{const wxColour\&}{GetBackgroundColour}{\void}
  30
  31 Returns the currently set background color.
  32
  33
  34 \membersection{wxListItemAttr::GetFont}\label{wxlistitemattrgetfont}
  35
  36 \constfunc{const wxFont\&}{GetFont}{\void}
  37
  38 Returns the currently set font.
  39
  40
  41 \membersection{wxListItemAttr::GetTextColour}\label{wxlistitemattrgettextcolour}
  42 \constfunc{const wxColour\&}{GetTextColour}{\void}
  43
  44 Returns the currently set text color.
  45
  46
  47 \membersection{wxListItemAttr::HasBackgroundColour}\label{wxlistitemattrhasbackgroundcolour}
  48
  49 \constfunc{bool}{HasBackgroundColour}{\void}
  50
  51 Returns \true if the currently set background color is valid.
  52
  53
  54 \membersection{wxListItemAttr::HasFont}\label{wxlistitemattrhasfont}
  55
  56 \constfunc{bool}{HasFont}{\void}
  57
  58 Returns \true if the currently set font is valid.
  59
  60
  61 \membersection{wxListItemAttr::HasTextColour}\label{wxlistitemattrhastextcolour}
  62
  63 \constfunc{bool}{HasTextColour}{\void}
  64
  65 Returns \true if the currently set text color is valid.
  66
  67
  68 \membersection{wxListItemAttr::SetBackgroundColour}\label{wxlistitemattrsetbackgroundcolour}
  69
  70 \func{void}{SetBackgroundColour}{\param{const wxColour\& }{colour}}
  71
  72 Sets a new background color.
  73
  74
  75 \membersection{wxListItemAttr::SetFont}\label{wxlistitemattrsetfont}
  76
  77 \func{void}{SetFont}{\param{const wxFont\& }{font}}
  78
  79 Sets a new font.
  80
  81
  82 \membersection{wxListItemAttr::SetTextColour}\label{wxlistitemattrsettextcolour}
  83 \func{void}{SetTextColour}{\param{const wxColour\& }{colour}}
  84
  85 Sets a new text color.