File: wx.lib.agw.flatmenu.FlatMenuItemGroup.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (111 lines) | stat: -rw-r--r-- 3,620 bytes parent folder | download
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
.. 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.flatmenu

.. highlight:: python



.. _wx.lib.agw.flatmenu.FlatMenuItemGroup:

==========================================================================================================================================
|phoenix_title|  **wx.lib.agw.flatmenu.FlatMenuItemGroup**
==========================================================================================================================================

A class that manages a group of radio menu items.



|

|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>FlatMenuItemGroup</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.FlatMenuItemGroup_inheritance.png" alt="Inheritance diagram of FlatMenuItemGroup" 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.flatmenu.FlatMenuItemGroup.html" title="wx.lib.agw.flatmenu.FlatMenuItemGroup" alt="" coords="5,5,280,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.agw.flatmenu.FlatMenuItemGroup.__init__`                          Default class constructor.
:meth:`~wx.lib.agw.flatmenu.FlatMenuItemGroup.Add`                               Adds a new item to the group.
:meth:`~wx.lib.agw.flatmenu.FlatMenuItemGroup.Exist`                             Checks if an item is in the group.
:meth:`~wx.lib.agw.flatmenu.FlatMenuItemGroup.GetSelectedItem`                   Returns the selected item.
:meth:`~wx.lib.agw.flatmenu.FlatMenuItemGroup.Remove`                            Removes a particular item.
:meth:`~wx.lib.agw.flatmenu.FlatMenuItemGroup.SetSelection`                      Selects a particular item.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: FlatMenuItemGroup(object)

   A class that manages a group of radio menu items.

   .. method:: __init__(self)

      Default class constructor. 


   .. method:: Add(self, item)

      Adds a new item to the group.
      
      :param `item`: an instance of :class:`FlatMenu`.


   .. method:: Exist(self, item)

      Checks if an item is in the group.
      
      :param `item`: an instance of :class:`FlatMenu`.


   .. method:: GetSelectedItem(self)

      Returns the selected item. 


   .. method:: Remove(self, item)

      Removes a particular item.
      
      :param `item`: an instance of :class:`FlatMenu`.


   .. method:: SetSelection(self, item)

      Selects a particular item.
      
      :param `item`: an instance of :class:`FlatMenu`.