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
|
.. 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
.. _wx.NonOwnedWindow:
==========================================================================================================================================
|phoenix_title| **wx.NonOwnedWindow**
==========================================================================================================================================
Common base class for all non-child windows.
This is the common base class of :ref:`wx.TopLevelWindow` and :ref:`wx.PopupWindow` and is not used directly.
Currently the only additional functionality it provides, compared to base :ref:`wx.Window` class, is the ability to set the window shape.
.. versionadded:: 2.9.3
|
|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>NonOwnedWindow</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.NonOwnedWindow_inheritance.png" alt="Inheritance diagram of NonOwnedWindow" 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.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node3" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node2" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node4" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="25,237,183,267"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.PopupWindow`, :ref:`wx.TopLevelWindow`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.NonOwnedWindow.SetShape` If the platform supports it, sets the shape of the window to that depicted by `region`.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.NonOwnedWindow(Window)
Common base class for all non-child windows.
.. method:: SetShape(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**SetShape** `(self, region)`
If the platform supports it, sets the shape of the window to that depicted by `region`.
The system will not display or respond to any mouse event for the pixels that lie outside of the region. To reset the window to the normal rectangular shape simply call :meth:`SetShape` again with an empty :ref:`wx.Region`. Returns ``True`` if the operation is successful.
This method is available in this class only since wxWidgets 2.9.3, previous versions only provided it in :ref:`wx.TopLevelWindow`.
:param `region`:
:type `region`: wx.Region
:rtype: `bool`
**~~~**
**SetShape** `(self, path)`
Set the window shape to the given path.
Set the window shape to the interior of the given path and also draw the window border along the specified path.
For example, to make a clock-like circular window you could use ::
size = self.GetSize()
path = wx.GraphicsRenderer.GetDefaultRenderer().CreatePath()
path.AddCircle(size.x/2, size.y/2, 30)
self.SetShape(path)
As the overload above, this method is not guaranteed to work on all platforms but currently does work in wxMSW, OSX/Cocoa and wxGTK (with the appropriate but almost always present X11 extensions) ports.
:param `path`:
:type `path`: wx.GraphicsPath
:rtype: `bool`
.. versionadded:: 2.9.3
**~~~**
|
