File: wx.lib.agw.flatmenu.FMRendererMSOffice2007.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 (166 lines) | stat: -rw-r--r-- 6,263 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
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
.. 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.FMRendererMSOffice2007:

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

Windows Office 2007 style. 



|

|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>FMRendererMSOffice2007</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.FMRendererMSOffice2007_inheritance.png" alt="Inheritance diagram of FMRendererMSOffice2007" 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.FMRendererMSOffice2007.html" title="wx.lib.agw.flatmenu.FMRendererMSOffice2007" alt="" coords="5,83,317,112"/> <area shape="rect" id="node2" href="wx.lib.agw.flatmenu.FMRenderer.html" title="wx.lib.agw.flatmenu.FMRenderer" alt="" coords="49,5,272,35"/> </map> 
   </p>

|


|sub_classes| Known Subclasses
==============================

:class:`wx.lib.agw.flatmenu.FMRendererVista`

|


|super_classes| Known Superclasses
==================================

:class:`wx.lib.agw.flatmenu.FMRenderer`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.agw.flatmenu.FMRendererMSOffice2007.__init__`                     Default class constructor.
:meth:`~wx.lib.agw.flatmenu.FMRendererMSOffice2007.DrawButton`                   Draws a button using the Office 2007 theme.
:meth:`~wx.lib.agw.flatmenu.FMRendererMSOffice2007.DrawButtonColour`             Draws a button using the Office 2007 theme.
:meth:`~wx.lib.agw.flatmenu.FMRendererMSOffice2007.DrawLeftMargin`               Draws the menu left margin.
:meth:`~wx.lib.agw.flatmenu.FMRendererMSOffice2007.DrawMenuBarBackground`        Draws the menu bar background according to the active theme.
:meth:`~wx.lib.agw.flatmenu.FMRendererMSOffice2007.DrawMenuBarButton`            Draws the highlight on a :class:`FlatMenuBar`.
:meth:`~wx.lib.agw.flatmenu.FMRendererMSOffice2007.DrawMenuButton`               Draws the highlight on a :class:`FlatMenu`.
:meth:`~wx.lib.agw.flatmenu.FMRendererMSOffice2007.DrawToolBarBg`                Draws the toolbar background according to the active theme.
:meth:`~wx.lib.agw.flatmenu.FMRendererMSOffice2007.GetTextColourEnable`          Returns the colour used for text colour when enabled.
================================================================================ ================================================================================


|


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


.. class:: FMRendererMSOffice2007(FMRenderer)

   Windows Office 2007 style. 

   .. method:: __init__(self)

      Default class constructor. 


   .. method:: DrawButton(self, dc, rect, state, colour=None)

      Draws a button using the Office 2007 theme.
      
      :param `dc`: an instance of :class:`wx.DC`;
      :param `rect`: an instance of :class:`wx.Rect`, representing the button client rectangle;
      :param integer `state`: the button state;
      :param `colour`: if not ``None``, an instance of :class:`wx.Colour` to be used to draw
       the :class:`FlatMenuItem` background.


   .. method:: DrawButtonColour(self, dc, rect, state, colour)

      Draws a button using the Office 2007 theme.
      
      :param `dc`: an instance of :class:`wx.DC`;
      :param `rect`: an instance of :class:`wx.Rect`, representing the button client rectangle;
      :param integer `state`: the button state;
      :param `colour`: a valid :class:`wx.Colour` instance.


   .. method:: DrawLeftMargin(self, item, dc, menuRect)

      Draws the menu left margin.
      
      :param `item`: the :class:`FlatMenuItem` to paint;
      :param `dc`: an instance of :class:`wx.DC`;
      :param `menuRect`: an instance of :class:`wx.Rect`, representing the menu client rectangle.


   .. method:: DrawMenuBarBackground(self, dc, rect)

      Draws the menu bar background according to the active theme.
      
      :param `dc`: an instance of :class:`wx.DC`;
      :param `rect`: an instance of :class:`wx.Rect`, representing the menubar client rectangle.


   .. method:: DrawMenuBarButton(self, dc, rect, state)

      Draws the highlight on a :class:`FlatMenuBar`.
      
      :param `dc`: an instance of :class:`wx.DC`;
      :param `rect`: an instance of :class:`wx.Rect`, representing the button client rectangle;
      :param integer `state`: the button state.


   .. method:: DrawMenuButton(self, dc, rect, state)

      Draws the highlight on a :class:`FlatMenu`.
      
      :param `dc`: an instance of :class:`wx.DC`;
      :param `rect`: an instance of :class:`wx.Rect`, representing the button client rectangle;
      :param integer `state`: the button state.


   .. method:: DrawToolBarBg(self, dc, rect)

      Draws the toolbar background according to the active theme.
      
      :param `dc`: an instance of :class:`wx.DC`;
      :param `rect`: an instance of :class:`wx.Rect`, representing the toolbar client rectangle.


   .. method:: GetTextColourEnable(self)

      Returns the colour used for text colour when enabled.