summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxAuiDockArt.xml
blob: 5a4f8b52cb73383a332b07c961bbb75bb946bb9a (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
63
64
65
66
67
68
69
70
71
72
73
74
<?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>wxAuiDockArt</title>
</header>
<module>wxAuiDockArt</module>
<modulesummary>Functions for wxAuiDockArt class</modulesummary>
<description><p><seeerl marker="wxAuiDockArt"><c>wxAuiDockArt</c></seeerl> is part of the wxAUI class framework. See also overview_aui.
      </p><p><seeerl marker="wxAuiDockArt"><c>wxAuiDockArt</c></seeerl> is the art provider: provides all drawing functionality to the wxAui dock manager. This allows the dock manager to have a pluggable look-and-feel.
      </p><p>By default, a <seeerl marker="wxAuiManager"><c>wxAuiManager</c></seeerl> uses an instance of this class called <c>wxAuiDefaultDockArt</c> (not implemented in wx) which provides bitmap art and a colour scheme that is adapted to the major platforms' look. You can either derive from that class to alter its behaviour or write a completely new dock art class. Call <seemfa marker="wxAuiManager#setArtProvider/2"><c>wxAuiManager:setArtProvider/2</c></seemfa> to force wxAUI to use your new dock art provider.
      </p><p>See: <seeerl marker="wxAuiManager"><c>wxAuiManager</c></seeerl>, <seeerl marker="wxAuiPaneInfo"><c>wxAuiPaneInfo</c></seeerl>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_aui_dock_art.html">wxAuiDockArt</url></p>
  </description>
<datatypes><datatype><name name="wxAuiDockArt"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getColour" arity="2" clause_i="1" since=""/>
    <fsummary>Get the colour of a certain setting. </fsummary>
    <desc><p>Get the colour of a certain setting. 
      </p><p><c>id</c> can be one of the colour values of <c>wxAuiPaneDockArtSetting</c>. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFont" arity="2" clause_i="1" since=""/>
    <fsummary>Get a font setting. </fsummary>
    <desc><p>Get a font setting. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMetric" arity="2" clause_i="1" since=""/>
    <fsummary>Get the value of a certain setting. </fsummary>
    <desc><p>Get the value of a certain setting. 
      </p><p><c>id</c> can be one of the size values of <c>wxAuiPaneDockArtSetting</c>. 
      </p></desc>
  </func>
  
  <func>
    <name name="setColour" arity="3" clause_i="1" since=""/>
    <fsummary>Set a certain setting with the value <c>colour</c>. </fsummary>
    <desc><p>Set a certain setting with the value <c>colour</c>. 
      </p><p><c>id</c> can be one of the colour values of <c>wxAuiPaneDockArtSetting</c>. 
      </p></desc>
  </func>
  
  <func>
    <name name="setFont" arity="3" clause_i="1" since=""/>
    <fsummary>Set a font setting. </fsummary>
    <desc><p>Set a font setting. 
      </p></desc>
  </func>
  
  <func>
    <name name="setMetric" arity="3" clause_i="1" since=""/>
    <fsummary>Set a certain setting with the value <c>new_val</c>. </fsummary>
    <desc><p>Set a certain setting with the value <c>new_val</c>. 
      </p><p><c>id</c> can be one of the size values of <c>wxAuiPaneDockArtSetting</c>. 
      </p></desc>
  </func>
  </funcs>
</erlref>