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