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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.pydocview
.. highlight:: python
.. _wx.lib.pydocview.DocOptionsService:
==========================================================================================================================================
|phoenix_title| **wx.lib.pydocview.DocOptionsService**
==========================================================================================================================================
A service that implements an options menu item and an options dialog with
notebook tabs. New tabs can be added by other services by calling the
"AddOptionsPanel" method.
|
|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>DocOptionsService</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.pydocview.DocOptionsService_inheritance.png" alt="Inheritance diagram of DocOptionsService" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.pydocview.DocOptionsService.html" title="wx.lib.pydocview.DocOptionsService" alt="" coords="5,237,267,267"/> <area shape="rect" id="node2" href="wx.lib.pydocview.DocService.html" title="wx.lib.pydocview.DocService" alt="" coords="31,160,241,189"/> <area shape="rect" id="node3" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="77,83,195,112"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="33,5,119,35"/> <area shape="rect" id="node5" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="144,5,251,35"/> </map>
</p>
</div>
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.pydocview.DocService`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.pydocview.DocOptionsService.__init__` Initializes the options service with the option of suppressing the default
:meth:`~wx.lib.pydocview.DocOptionsService.AddOptionsPanel` Adds an options panel to the options dialog.
:meth:`~wx.lib.pydocview.DocOptionsService.ClearOptionsPanels` Clears all of the options panels that have been added into the
:meth:`~wx.lib.pydocview.DocOptionsService.GetSupportedModes` Return the modes supported by the application. Use docview.DOC_SDI and
:meth:`~wx.lib.pydocview.DocOptionsService.InstallControls` Installs a "Tools" menu with an "Options" menu item.
:meth:`~wx.lib.pydocview.DocOptionsService.OnOptions` Shows the options dialog, called when the "Options" menu item is selected.
:meth:`~wx.lib.pydocview.DocOptionsService.ProcessEvent` Checks to see if the "Options" menu item has been selected.
:meth:`~wx.lib.pydocview.DocOptionsService.SetSupportedModes` Sets the modes supported by the application. Use docview.DOC_SDI and
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: DocOptionsService(DocService)
A service that implements an options menu item and an options dialog with
notebook tabs. New tabs can be added by other services by calling the
"AddOptionsPanel" method.
.. method:: __init__(self, showGeneralOptions=True, supportedModes=wx.lib.docview.DOC_SDI & wx.lib.docview.DOC_MDI)
Initializes the options service with the option of suppressing the default
general options pane that is included with the options service by setting
showGeneralOptions to False. It allowModeChanges is set to False, the
default general options pane will allow users to change the document
interface mode between SDI and MDI modes.
.. method:: AddOptionsPanel(self, optionsPanel)
Adds an options panel to the options dialog.
.. method:: ClearOptionsPanels(self)
Clears all of the options panels that have been added into the
options dialog.
.. method:: GetSupportedModes(self)
Return the modes supported by the application. Use docview.DOC_SDI and
docview.DOC_MDI flags to check if SDI and/or MDI modes are supported.
.. method:: InstallControls(self, frame, menuBar=None, toolBar=None, statusBar=None, document=None)
Installs a "Tools" menu with an "Options" menu item.
.. method:: OnOptions(self, event)
Shows the options dialog, called when the "Options" menu item is selected.
.. method:: ProcessEvent(self, event)
Checks to see if the "Options" menu item has been selected.
.. method:: SetSupportedModes(self, _supportedModessupportedModes)
Sets the modes supported by the application. Use docview.DOC_SDI and
docview.DOC_MDI flags to set if SDI and/or MDI modes are supported.
|
