File: wx.lib.agw.pybusyinfo.PyInfoFrame.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 (113 lines) | stat: -rw-r--r-- 4,836 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
.. 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.pybusyinfo

.. highlight:: python



.. _wx.lib.agw.pybusyinfo.PyInfoFrame:

==========================================================================================================================================
|phoenix_title|  **wx.lib.agw.pybusyinfo.PyInfoFrame**
==========================================================================================================================================

Base class for :class:`PyBusyInfo`. 



|

|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>PyInfoFrame</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.pybusyinfo.PyInfoFrame_inheritance.png" alt="Inheritance diagram of PyInfoFrame" 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.pybusyinfo.PyInfoFrame.html" title="wx.lib.agw.pybusyinfo.PyInfoFrame" alt="" coords="5,547,243,576"/> <area shape="rect" id="node2" href="wx.Frame.html" title="wx.Frame" alt="" coords="83,469,164,499"/> <area shape="rect" id="node3" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="16,5,117,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="68,83,179,112"/> <area shape="rect" id="node6" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="63,160,184,189"/> <area shape="rect" id="node5" href="wx.Object.html" title="wx.Object" alt="" coords="141,5,223,35"/> <area shape="rect" id="node7" href="wx.Window.html" title="wx.Window" alt="" coords="79,237,168,267"/> <area shape="rect" id="node9" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="45,315,203,344"/> <area shape="rect" id="node8" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="53,392,195,421"/> </map> 
   </p>

|


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

:class:`wx.Frame`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.agw.pybusyinfo.PyInfoFrame.__init__`                              Default class constructor.
:meth:`~wx.lib.agw.pybusyinfo.PyInfoFrame.OnErase`                               Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`PyInfoFrame`.
:meth:`~wx.lib.agw.pybusyinfo.PyInfoFrame.OnPaint`                               Handles the ``wx.EVT_PAINT`` event for :class:`PyInfoFrame`.
:meth:`~wx.lib.agw.pybusyinfo.PyInfoFrame.SetBusyShape`                          Sets :class:`PyInfoFrame` shape using the region created from the bitmap.
================================================================================ ================================================================================


|


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


.. class:: PyInfoFrame(wx.Frame)

   Base class for :class:`PyBusyInfo`. 

   .. method:: __init__(self, parent, message, title, icon)

      Default class constructor.
      
      :param `parent`: the frame parent;
      :param `message`: the message to display in the :class:`PyBusyInfo`;
      :param `title`: the main :class:`PyBusyInfo` title;
      :param `icon`: an icon to draw as the frame icon, an instance of :class:`wx.Bitmap`.


   .. method:: OnErase(self, event)

      Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`PyInfoFrame`.
      
      :param `event`: a :class:`EraseEvent` event to be processed.
      
      :note: This method is intentionally empty to reduce flicker.


   .. method:: OnPaint(self, event)

      Handles the ``wx.EVT_PAINT`` event for :class:`PyInfoFrame`.
      
      :param `event`: a :class:`PaintEvent` to be processed.


   .. method:: SetBusyShape(self, event=None)

      Sets :class:`PyInfoFrame` shape using the region created from the bitmap.
      
      :param `event`: a :class:`wx.WindowCreateEvent` event (GTK only, as GTK supports setting
       the window shape only during window creation).