<?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>wxTextAttr</title>
</header>
<module>wxTextAttr</module>
<modulesummary>Functions for wxTextAttr class</modulesummary>
<description><p><seeerl marker="wxTextAttr"><c>wxTextAttr</c></seeerl> represents the character and paragraph attributes, or style, for a range of text in a <seeerl marker="wxTextCtrl"><c>wxTextCtrl</c></seeerl> or <c>wxRichTextCtrl</c> (not implemented in wx).
      </p><p>When setting up a <seeerl marker="wxTextAttr"><c>wxTextAttr</c></seeerl> object, pass a bitlist mask to <seemfa marker="#setFlags/2"><c>setFlags/2</c></seemfa> to indicate which style elements should be changed. As a convenience, when you call a setter such as SetFont, the relevant bit will be set.
      </p><p>See: <seeerl marker="wxTextCtrl"><c>wxTextCtrl</c></seeerl>, <c>wxRichTextCtrl</c> (not implemented in wx)
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_text_attr.html">wxTextAttr</url></p>
  </description>
<datatypes><datatype><name name="wxTextAttr"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Constructors. </fsummary>
    <desc><p>Constructors. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
  
    <name name="new" arity="1" clause_i="2" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="getAlignment" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the alignment flags. </fsummary>
    <desc><p>Returns the alignment flags. 
      </p><p>See ?wxTextAttrAlignment for a list of available styles. 
      </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>Creates and returns a font specified by the font attributes in the <c>wxTextAttr</c> object. </fsummary>
    <desc><p>Creates and returns a font specified by the font attributes in the <seeerl marker="wxTextAttr"><c>wxTextAttr</c></seeerl> object. 
      </p><p>Note that <seeerl marker="wxTextAttr"><c>wxTextAttr</c></seeerl> does not store a <seeerl marker="wxFont"><c>wxFont</c></seeerl> object, so this is only a temporary font.
      </p><p>For greater efficiency, access the font attributes directly. 
      </p></desc>
  </func>
  
  <func>
    <name name="getLeftIndent" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the left indent in tenths of a millimetre. </fsummary>
    <desc><p>Returns the left indent in tenths of a millimetre. 
      </p></desc>
  </func>
  
  <func>
    <name name="getLeftSubIndent" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the left sub-indent in tenths of a millimetre. </fsummary>
    <desc><p>Returns the left sub-indent in tenths of a millimetre. 
      </p></desc>
  </func>
  
  <func>
    <name name="getRightIndent" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the right indent in tenths of a millimeter. </fsummary>
    <desc><p>Returns the right indent in tenths of a millimeter. 
      </p></desc>
  </func>
  
  <func>
    <name name="getTabs" arity="1" clause_i="1" since=""/>
    <fsummary>Returns an array of tab stops, each expressed in tenths of a millimeter. </fsummary>
    <desc><p>Returns an array of tab stops, each expressed in tenths of a millimeter. 
      </p><p>Each stop is measured from the left margin and therefore each value must be larger than the last. 
      </p></desc>
  </func>
  
  <func>
    <name name="getTextColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the text foreground colour. </fsummary>
    <desc><p>Returns the text foreground colour. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasBackgroundColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the attribute object specifies a background colour. </fsummary>
    <desc><p>Returns true if the attribute object specifies a background colour. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasFont" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the attribute object specifies any font attributes. </fsummary>
    <desc><p>Returns true if the attribute object specifies any font attributes. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasTextColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the attribute object specifies a text foreground colour. </fsummary>
    <desc><p>Returns true if the attribute object specifies a text foreground colour. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFlags" arity="1" clause_i="1" since=""/>
    <fsummary>Returns flags indicating which attributes are applicable. </fsummary>
    <desc><p>Returns flags indicating which attributes are applicable. 
      </p><p>See <seemfa marker="#setFlags/2"><c>setFlags/2</c></seemfa> for a list of available flags. 
      </p></desc>
  </func>
  
  <func>
    <name name="isDefault" arity="1" clause_i="1" since=""/>
    <fsummary>Returns false if we have any attributes set, true otherwise. </fsummary>
    <desc><p>Returns false if we have any attributes set, true otherwise. 
      </p></desc>
  </func>
  
  <func>
    <name name="setAlignment" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the paragraph alignment. </fsummary>
    <desc><p>Sets the paragraph alignment. 
      </p><p>See ?wxTextAttrAlignment enumeration values.
      </p><p>Of these, wxTEXT_ALIGNMENT_JUSTIFIED is unimplemented. In future justification may be supported when printing or previewing, only. 
      </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="setFlags" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the flags determining which styles are being specified. </fsummary>
    <desc><p>Sets the flags determining which styles are being specified. 
      </p><p>The ?wxTextAttrFlags values can be passed in a bitlist. 
      </p></desc>
  </func>
  
  <func>
    <name name="setFont" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>setFont/3</c></fsummary>
  </func>
  
  <func>
    <name name="setFont" arity="3" clause_i="1" since=""/>
    <fsummary>Sets the attributes for the given font. </fsummary>
    <desc><p>Sets the attributes for the given font. 
      </p><p>Note that <seeerl marker="wxTextAttr"><c>wxTextAttr</c></seeerl> does not store an actual <seeerl marker="wxFont"><c>wxFont</c></seeerl> object. 
      </p></desc>
  </func>
  
  <func>
    <name name="setLeftIndent" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>setLeftIndent/3</c></fsummary>
  </func>
  
  <func>
    <name name="setLeftIndent" arity="3" clause_i="1" since=""/>
    <fsummary>Sets the left indent and left subindent in tenths of a millimetre. </fsummary>
    <desc><p>Sets the left indent and left subindent in tenths of a millimetre. 
      </p><p>The sub-indent is an offset from the left of the paragraph, and is used for all but the first line in a paragraph.
      </p><p>A positive value will cause the first line to appear to the left of the subsequent lines, and a negative value will cause the first line to be indented relative to the subsequent lines.
      </p><p><c>wxRichTextBuffer</c> (not implemented in wx) uses indentation to render a bulleted item. The left indent is the distance between the margin and the bullet. The content of the paragraph, including the first line, starts at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the left of the actual paragraph is leftSubIndent. 
      </p></desc>
  </func>
  
  <func>
    <name name="setRightIndent" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the right indent in tenths of a millimetre. </fsummary>
    <desc><p>Sets the right indent in tenths of a millimetre. 
      </p></desc>
  </func>
  
  <func>
    <name name="setTabs" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the tab stops, expressed in tenths of a millimetre. </fsummary>
    <desc><p>Sets the tab stops, expressed in tenths of a millimetre. 
      </p><p>Each stop is measured from the left margin and therefore each value must be larger than the last. 
      </p></desc>
  </func>
  
  <func>
    <name name="setTextColour" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the text foreground colour. </fsummary>
    <desc><p>Sets the text foreground colour. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor</fsummary>
    <desc><p>Destroys the object.</p></desc>
  </func>
  </funcs>
</erlref>
