summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxGridCellBoolEditor.xml
blob: 1ab8bc689e1ba00fbec907fe85cbd4125aa74942 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<?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>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxGridCellBoolEditor</title>
</header>
<module>wxGridCellBoolEditor</module>
<modulesummary>Functions for wxGridCellBoolEditor class</modulesummary>
<description><p>Grid cell editor for boolean data.
      </p><p>See: <seeerl marker="wxGridCellEditor"><c>wxGridCellEditor</c></seeerl>, <c>wxGridCellAutoWrapStringEditor</c> (not implemented in wx), <seeerl marker="wxGridCellChoiceEditor"><c>wxGridCellChoiceEditor</c></seeerl>, <c>wxGridCellEnumEditor</c> (not implemented in wx), <seeerl marker="wxGridCellFloatEditor"><c>wxGridCellFloatEditor</c></seeerl>, <seeerl marker="wxGridCellNumberEditor"><c>wxGridCellNumberEditor</c></seeerl>, <seeerl marker="wxGridCellTextEditor"><c>wxGridCellTextEditor</c></seeerl>, <c>wxGridCellDateEditor</c> (not implemented in wx)
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxGridCellEditor"><c>wxGridCellEditor</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_grid_cell_bool_editor.html">wxGridCellBoolEditor</url></p>
  </description>
<datatypes><datatype><name name="wxGridCellBoolEditor"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default constructor. </fsummary>
    <desc><p>Default constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="isTrueValue" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if the given <c>value</c> is equal to the string representation of the truth value we currently use (see <c>useStringValues/1</c>). </fsummary>
    <desc><p>Returns true if the given <c>value</c> is equal to the string representation of the truth value we currently use (see <seemfa marker="#useStringValues/1"><c>useStringValues/1</c></seemfa>). 
      </p></desc>
  </func>
  
  <func>
    <name name="useStringValues" arity="0" clause_i="1" since=""/>
    <fsummary>See: <c>useStringValues/1</c></fsummary>
  </func>
  
  <func>
    <name name="useStringValues" arity="1" clause_i="1" since=""/>
    <fsummary>This method allows you to customize the values returned by <c>wxGridCellNumberEditor:getValue/1</c> for the cell using this editor. </fsummary>
    <desc><p>This method allows you to customize the values returned by <seemfa marker="wxGridCellNumberEditor#getValue/1"><c>wxGridCellNumberEditor:getValue/1</c></seemfa> for the cell using this editor. 
      </p><p>By default, the default values of the arguments are used, i.e. <c>"1"</c> is returned if the cell is checked and an empty string otherwise. 
      </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>