<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </legalnotice>
  <title>wxGridCellAttr</title>
</header>
<module>wxGridCellAttr</module>
<modulesummary>Functions for wxGridCellAttr class</modulesummary>
<description><p>This class can be used to alter the cells' appearance in the grid by changing their attributes from the defaults. An object of this class may be returned by <c>wxGridTableBase::GetAttr()</c> (not implemented in wx).
      </p><p>Note that objects of this class are reference-counted and it's recommended to use wxGridCellAttrPtr smart pointer class when working with them to avoid memory leaks.
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_grid_cell_attr.html">wxGridCellAttr</url></p>
  </description>
<datatypes><datatype><name name="wxGridCellAttr"/></datatype></datatypes>

<funcs>
  <func>
    <name name="setTextColour" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the text colour. </fsummary>
    <desc><p>Sets the text colour. 
      </p></desc>
  </func>
  
  <func>
    <name name="setBackgroundColour" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the background colour. </fsummary>
    <desc><p>Sets the background colour. 
      </p></desc>
  </func>
  
  <func>
    <name name="setFont" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the font. </fsummary>
    <desc><p>Sets the font. 
      </p></desc>
  </func>
  
  <func>
    <name name="setAlignment" arity="3" clause_i="1" since=""/>
    <fsummary>Sets the alignment. </fsummary>
    <desc><p>Sets the alignment. 
      </p><p><c>hAlign</c> can be one of <c>wxALIGN_LEFT</c>, <c>wxALIGN_CENTRE</c> or <c>wxALIGN_RIGHT</c> and <c>vAlign</c> can be one of <c>wxALIGN_TOP</c>, <c>wxALIGN_CENTRE</c> or <c>wxALIGN_BOTTOM</c>. 
      </p></desc>
  </func>
  
  <func>
    <name name="setReadOnly" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>setReadOnly/2</c></fsummary>
  </func>
  
  <func>
    <name name="setReadOnly" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the cell as read-only. </fsummary>
    <desc><p>Sets the cell as read-only. 
      </p></desc>
  </func>
  
  <func>
    <name name="setRenderer" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the renderer to be used for cells with this attribute. </fsummary>
    <desc><p>Sets the renderer to be used for cells with this attribute. 
      </p><p>Takes ownership of the pointer. 
      </p></desc>
  </func>
  
  <func>
    <name name="setEditor" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the editor to be used with the cells with this attribute. </fsummary>
    <desc><p>Sets the editor to be used with the cells with this attribute. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasTextColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if this attribute has a valid text colour set. </fsummary>
    <desc><p>Returns true if this attribute has a valid text colour set. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasBackgroundColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if this attribute has a valid background colour set. </fsummary>
    <desc><p>Returns true if this attribute has a valid background colour set. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasFont" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if this attribute has a valid font set. </fsummary>
    <desc><p>Returns true if this attribute has a valid font set. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasAlignment" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if this attribute has a valid alignment set. </fsummary>
    <desc><p>Returns true if this attribute has a valid alignment set. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasRenderer" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if this attribute has a valid cell renderer set. </fsummary>
    <desc><p>Returns true if this attribute has a valid cell renderer set. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasEditor" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if this attribute has a valid cell editor set. </fsummary>
    <desc><p>Returns true if this attribute has a valid cell editor set. 
      </p></desc>
  </func>
  
  <func>
    <name name="getTextColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the text colour. </fsummary>
    <desc><p>Returns the text colour. 
      </p></desc>
  </func>
  
  <func>
    <name name="getBackgroundColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the background colour. </fsummary>
    <desc><p>Returns the background colour. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFont" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the font. </fsummary>
    <desc><p>Returns the font. 
      </p></desc>
  </func>
  
  <func>
    <name name="getAlignment" arity="1" clause_i="1" since=""/>
    <fsummary>Get the alignment to use for the cell with the given attribute. </fsummary>
    <desc><p>Get the alignment to use for the cell with the given attribute. 
      </p><p>If this attribute doesn't specify any alignment, the default attribute alignment is used (which can be changed using <seemfa marker="wxGrid#setDefaultCellAlignment/3"><c>wxGrid:setDefaultCellAlignment/3</c></seemfa> but is left and top by default).
      </p><p>Notice that <c>hAlign</c> and <c>vAlign</c> values are always overwritten by this function, use <c>GetNonDefaultAlignment()</c> (not implemented in wx) if this is not desirable.
      </p></desc>
  </func>
  
  <func>
    <name name="getRenderer" arity="4" clause_i="1" since=""/>
    <fsummary>Returns the cell renderer. </fsummary>
    <desc><p>Returns the cell renderer. 
      </p><p>The caller is responsible for calling <c>DecRef()</c> (not implemented in wx) on the returned pointer, use <c>GetRendererPtr()</c> (not implemented in wx) to do it automatically. 
      </p></desc>
  </func>
  
  <func>
    <name name="getEditor" arity="4" clause_i="1" since=""/>
    <fsummary>Returns the cell editor. </fsummary>
    <desc><p>Returns the cell editor. 
      </p><p>The caller is responsible for calling <c>DecRef()</c> (not implemented in wx) on the returned pointer, use <c>GetEditorPtr()</c> (not implemented in wx) to do it automatically. 
      </p></desc>
  </func>
  
  <func>
    <name name="isReadOnly" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if this cell is set as read-only. </fsummary>
    <desc><p>Returns true if this cell is set as read-only. 
      </p></desc>
  </func>
  
  <func>
    <name name="setDefAttr" arity="2" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  </funcs>
</erlref>
