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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.agw.flatmenu
.. highlight:: python
.. _wx.lib.agw.flatmenu.MenuEntryInfo:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.flatmenu.MenuEntryInfo**
==========================================================================================================================================
Internal class which holds information about a menu.
|
|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>MenuEntryInfo</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.flatmenu.MenuEntryInfo_inheritance.png" alt="Inheritance diagram of MenuEntryInfo" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.agw.flatmenu.MenuEntryInfo.html" title="wx.lib.agw.flatmenu.MenuEntryInfo" alt="" coords="5,5,256,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.flatmenu.MenuEntryInfo.__init__` Default class constructor.
:meth:`~wx.lib.agw.flatmenu.MenuEntryInfo.GetCmdId` Returns the associated menu accelerator identifier.
:meth:`~wx.lib.agw.flatmenu.MenuEntryInfo.GetMenu` Returns the associated menu.
:meth:`~wx.lib.agw.flatmenu.MenuEntryInfo.GetRect` Returns the associated menu client rectangle.
:meth:`~wx.lib.agw.flatmenu.MenuEntryInfo.GetSelectedTextBitmap` Returns the associated selected menu bitmap.
:meth:`~wx.lib.agw.flatmenu.MenuEntryInfo.GetState` Returns the associated menu state.
:meth:`~wx.lib.agw.flatmenu.MenuEntryInfo.GetTextBitmap` Returns the associated menu bitmap.
:meth:`~wx.lib.agw.flatmenu.MenuEntryInfo.GetTitle` Returns the associated menu title.
:meth:`~wx.lib.agw.flatmenu.MenuEntryInfo.SetRect` Sets the associated menu client rectangle.
:meth:`~wx.lib.agw.flatmenu.MenuEntryInfo.SetSelectedTextBitmap` Sets the associated selected menu bitmap.
:meth:`~wx.lib.agw.flatmenu.MenuEntryInfo.SetState` Sets the associated menu state.
:meth:`~wx.lib.agw.flatmenu.MenuEntryInfo.SetTextBitmap` Sets the associated menu bitmap.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: MenuEntryInfo(object)
Internal class which holds information about a menu.
.. method:: __init__(self, titleOrMenu="", menu=None, state=ControlNormal, cmd=wx.ID_ANY)
Default class constructor.
Used internally. Do not call it in your code!
:param `titleOrMenu`: if it is a string, it represents the new menu label,
otherwise it is another instance of :class:`wx.MenuEntryInfo` from which the attributes
are copied;
:param `menu`: the associated :class:`FlatMenu` object;
:param integer `state`: the menu item state. This can be one of the following:
==================== ======= ==========================
Item State Value Description
==================== ======= ==========================
``ControlPressed`` 0 The item is pressed
``ControlFocus`` 1 The item is focused
``ControlDisabled`` 2 The item is disabled
``ControlNormal`` 3 Normal state
==================== ======= ==========================
:param integer `cmd`: the menu accelerator identifier.
.. method:: GetCmdId(self)
Returns the associated menu accelerator identifier.
.. method:: GetMenu(self)
Returns the associated menu.
.. method:: GetRect(self)
Returns the associated menu client rectangle.
.. method:: GetSelectedTextBitmap(self)
Returns the associated selected menu bitmap.
.. method:: GetState(self)
Returns the associated menu state.
:see: :meth:`~MenuEntryInfo.SetState` for a list of valid menu states.
.. method:: GetTextBitmap(self)
Returns the associated menu bitmap.
.. method:: GetTitle(self)
Returns the associated menu title.
.. method:: SetRect(self, rect)
Sets the associated menu client rectangle.
:param `rect`: an instance of :class:`wx.Rect`, representing the menu client rectangle.
.. method:: SetSelectedTextBitmap(self, bmp)
Sets the associated selected menu bitmap.
:param `bmp`: a valid :class:`wx.Bitmap` object.
.. method:: SetState(self, state)
Sets the associated menu state.
:param integer `state`: the menu item state. This can be one of the following:
==================== ======= ==========================
Item State Value Description
==================== ======= ==========================
``ControlPressed`` 0 The item is pressed
``ControlFocus`` 1 The item is focused
``ControlDisabled`` 2 The item is disabled
``ControlNormal`` 3 Normal state
==================== ======= ==========================
.. method:: SetTextBitmap(self, bmp)
Sets the associated menu bitmap.
:param `bmp`: a valid :class:`wx.Bitmap` object.
|
