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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.agw.rulerctrl
.. highlight:: python
.. _wx.lib.agw.rulerctrl.Indicator:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.rulerctrl.Indicator**
==========================================================================================================================================
This class holds all the information about a single indicator inside :class:`RulerCtrl`.
You should not call this class directly. Use::
ruler.AddIndicator(id, value)
to add an indicator to your :class:`RulerCtrl`.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>Indicator</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.agw.rulerctrl.Indicator_inheritance.png" alt="Inheritance diagram of Indicator" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.agw.rulerctrl.Indicator.html" title="wx.lib.agw.rulerctrl.Indicator" alt="" coords="5,5,200,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.rulerctrl.Indicator.__init__` Default class constructor.
:meth:`~wx.lib.agw.rulerctrl.Indicator.Draw` Actually draws the indicator.
:meth:`~wx.lib.agw.rulerctrl.Indicator.GetId` Returns the indicator id.
:meth:`~wx.lib.agw.rulerctrl.Indicator.GetImageSize` Returns the indicator bitmap size.
:meth:`~wx.lib.agw.rulerctrl.Indicator.GetPosition` Returns the position at which we should draw the indicator bitmap.
:meth:`~wx.lib.agw.rulerctrl.Indicator.GetRect` Returns the indicator client rectangle.
:meth:`~wx.lib.agw.rulerctrl.Indicator.GetValue` Returns the indicator value.
:meth:`~wx.lib.agw.rulerctrl.Indicator.RotateImage` Rotates the default indicator bitmap.
:meth:`~wx.lib.agw.rulerctrl.Indicator.SetColour` Sets the indicator colour.
:meth:`~wx.lib.agw.rulerctrl.Indicator.SetValue` Sets the indicator value.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: Indicator(object)
This class holds all the information about a single indicator inside :class:`RulerCtrl`.
You should not call this class directly. Use::
ruler.AddIndicator(id, value)
to add an indicator to your :class:`RulerCtrl`.
.. method:: __init__(self, parent, id=wx.ID_ANY, value=0)
Default class constructor.
:param `parent`: the parent window, an instance of :class:`RulerCtrl`;
:param `id`: the indicator identifier;
:param `value`: the initial value of the indicator.
.. method:: Draw(self, dc)
Actually draws the indicator.
:param `dc`: an instance of :class:`wx.DC`.
.. method:: GetId(self)
Returns the indicator id.
.. method:: GetImageSize(self)
Returns the indicator bitmap size.
.. method:: GetPosition(self)
Returns the position at which we should draw the indicator bitmap.
.. method:: GetRect(self)
Returns the indicator client rectangle.
.. method:: GetValue(self)
Returns the indicator value.
.. method:: RotateImage(self, img=None)
Rotates the default indicator bitmap.
:param `img`: if not ``None``, the indicator image.
.. method:: SetColour(self, colour)
Sets the indicator colour.
:param `colour`: the new indicator colour, an instance of :class:`wx.Colour`.
:note: Requires PIL (Python Imaging Library), which can be downloaded from
http://www.pythonware.com/products/pil/
.. method:: SetValue(self, value)
Sets the indicator value.
:param `value`: the new indicator value.
|
