docs/latex/wx/gridattr.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % grid.h at 11/May/00 18:30:19
   4 %
   5
   6 \section{\class{wxGridCellAttr}}\label{wxgridcellattr}
   7
   8 This class can be used to alter the cells' appearance in
   9 the grid by changing their colour/font/... from default. An object of this
  10 class may be returned by wxGridTable::GetAttr().
  11
  12 \wxheading{Derived from}
  13
  14 No base class
  15
  16 \wxheading{Include files}
  17
  18 <wx/grid.h>
  19
  20 \latexignore{\rtfignore{\wxheading{Members}}}
  21
  22 \membersection{wxGridCellAttr::wxGridCellAttr}\label{wxgridcellattrwxgridcellattr}
  23
  24 \func{}{wxGridCellAttr}{\void}
  25
  26 Default constructor.
  27
  28 \func{}{wxGridCellAttr}{\param{const wxColour\& }{colText}, \param{const wxColour\& }{colBack}, \param{const wxFont\& }{font}, \param{int }{hAlign}, \param{int }{vAlign}}
  29
  30 VZ: considering the number of members wxGridCellAttr has now, this ctor
  31 seems to be pretty useless... may be we should just remove it?
  32
  33 \membersection{wxGridCellAttr::Clone}\label{wxgridcellattrclone}
  34
  35 \constfunc{wxGridCellAttr*}{Clone}{\void}
  36
  37 Creates a new copy of this object.
  38
  39 \membersection{wxGridCellAttr::IncRef}\label{wxgridcellattrincref}
  40
  41 \func{void}{IncRef}{\void}
  42
  43 This class is ref counted: it is created with ref count of 1, so
  44 calling DecRef() once will delete it. Calling IncRef() allows to lock
  45 it until the matching DecRef() is called
  46
  47 \membersection{wxGridCellAttr::DecRef}\label{wxgridcellattrdecref}
  48
  49 \func{void}{DecRef}{\void}
  50
  51 \membersection{wxGridCellAttr::SetTextColour}\label{wxgridcellattrsettextcolour}
  52
  53 \func{void}{SetTextColour}{\param{const wxColour\& }{colText}}
  54
  55 Sets the text colour.
  56
  57 \membersection{wxGridCellAttr::SetBackgroundColour}\label{wxgridcellattrsetbackgroundcolour}
  58
  59 \func{void}{SetBackgroundColour}{\param{const wxColour\& }{colBack}}
  60
  61 Sets the background colour.
  62
  63 \membersection{wxGridCellAttr::SetFont}\label{wxgridcellattrsetfont}
  64
  65 \func{void}{SetFont}{\param{const wxFont\& }{font}}
  66
  67 Sets the font.
  68
  69 \membersection{wxGridCellAttr::SetAlignment}\label{wxgridcellattrsetalignment}
  70
  71 \func{void}{SetAlignment}{\param{int }{hAlign}, \param{int }{vAlign}}
  72
  73 Sets the alignment.
  74
  75 \membersection{wxGridCellAttr::SetReadOnly}\label{wxgridcellattrsetreadonly}
  76
  77 \func{void}{SetReadOnly}{\param{bool }{isReadOnly = true}}
  78
  79
  80 \membersection{wxGridCellAttr::SetRenderer}\label{wxgridcellattrsetrenderer}
  81
  82 \func{void}{SetRenderer}{\param{wxGridCellRenderer* }{renderer}}
  83
  84 takes ownership of the pointer
  85
  86
  87 \membersection{wxGridCellAttr::SetEditor}\label{wxgridcellattrseteditor}
  88
  89 \func{void}{SetEditor}{\param{wxGridCellEditor* }{editor}}
  90
  91
  92 \membersection{wxGridCellAttr::HasTextColour}\label{wxgridcellattrhastextcolour}
  93
  94 \constfunc{bool}{HasTextColour}{\void}
  95
  96 accessors
  97
  98
  99 \membersection{wxGridCellAttr::HasBackgroundColour}\label{wxgridcellattrhasbackgroundcolour}
 100
 101 \constfunc{bool}{HasBackgroundColour}{\void}
 102
 103
 104 \membersection{wxGridCellAttr::HasFont}\label{wxgridcellattrhasfont}
 105
 106 \constfunc{bool}{HasFont}{\void}
 107
 108
 109 \membersection{wxGridCellAttr::HasAlignment}\label{wxgridcellattrhasalignment}
 110
 111 \constfunc{bool}{HasAlignment}{\void}
 112
 113
 114 \membersection{wxGridCellAttr::HasRenderer}\label{wxgridcellattrhasrenderer}
 115
 116 \constfunc{bool}{HasRenderer}{\void}
 117
 118
 119 \membersection{wxGridCellAttr::HasEditor}\label{wxgridcellattrhaseditor}
 120
 121 \constfunc{bool}{HasEditor}{\void}
 122
 123
 124 \membersection{wxGridCellAttr::GetTextColour}\label{wxgridcellattrgettextcolour}
 125
 126 \constfunc{const wxColour\&}{GetTextColour}{\void}
 127
 128
 129 \membersection{wxGridCellAttr::GetBackgroundColour}\label{wxgridcellattrgetbackgroundcolour}
 130
 131 \constfunc{const wxColour\&}{GetBackgroundColour}{\void}
 132
 133
 134 \membersection{wxGridCellAttr::GetFont}\label{wxgridcellattrgetfont}
 135
 136 \constfunc{const wxFont\&}{GetFont}{\void}
 137
 138
 139 \membersection{wxGridCellAttr::GetAlignment}\label{wxgridcellattrgetalignment}
 140
 141 \constfunc{void}{GetAlignment}{\param{int* }{hAlign}, \param{int* }{vAlign}}
 142
 143 \perlnote{This method takes no parameters and
 144 returns a 2-element list {\tt ( hAlign, vAlign )}.}
 145
 146 \membersection{wxGridCellAttr::GetRenderer}\label{wxgridcellattrgetrenderer}
 147
 148 \constfunc{wxGridCellRenderer*}{GetRenderer}{\param{wxGrid* }{grid}, \param{int }{row}, \param{int }{col}}
 149
 150
 151 \membersection{wxGridCellAttr::GetEditor}\label{wxgridcellattrgeteditor}
 152
 153 \constfunc{wxGridCellEditor*}{GetEditor}{\param{wxGrid* }{grid}, \param{int }{row}, \param{int }{col}}
 154
 155
 156 \membersection{wxGridCellAttr::IsReadOnly}\label{wxgridcellattrisreadonly}
 157
 158 \constfunc{bool}{IsReadOnly}{\void}
 159
 160
 161 \membersection{wxGridCellAttr::SetDefAttr}\label{wxgridcellattrsetdefattr}
 162
 163 \func{void}{SetDefAttr}{\param{wxGridCellAttr* }{defAttr}}
 164