File: wx.lib.agw.flatmenu.FMRendererMgr.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 (99 lines) | stat: -rw-r--r-- 3,591 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
.. 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.FMRendererMgr:

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

This class represents a manager that handles all the renderers defined.
Every instance of this class will share the same state, so everyone can
instantiate their own and a call to :meth:`FMRendererMgr.SetTheme() <FMRendererMgr.SetTheme>` anywhere will affect everyone.



|

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

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.agw.flatmenu.FMRendererMgr.__init__`                              Default class constructor.
:meth:`~wx.lib.agw.flatmenu.FMRendererMgr.AddRenderer`                           Adds a user defined custom renderer.
:meth:`~wx.lib.agw.flatmenu.FMRendererMgr.GetRenderer`                           Returns the current theme's renderer.
:meth:`~wx.lib.agw.flatmenu.FMRendererMgr.SetTheme`                              Sets the current theme.
================================================================================ ================================================================================


|


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


.. class:: FMRendererMgr(object)

   This class represents a manager that handles all the renderers defined.
   Every instance of this class will share the same state, so everyone can
   instantiate their own and a call to :meth:`FMRendererMgr.SetTheme() <FMRendererMgr.SetTheme>` anywhere will affect everyone.

   .. method:: __init__(self)

      Default class constructor. 


   .. method:: AddRenderer(self, renderer)

      Adds a user defined custom renderer.
      
      :param `renderer`: a class derived from :class:`FMRenderer`.


   .. method:: GetRenderer(self)

      Returns the current theme's renderer. 


   .. method:: SetTheme(self, theme)

      Sets the current theme.
      
      :param `theme`: an integer specifying the theme to use.