File: wx.FindDialogEvent.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 (204 lines) | stat: -rw-r--r-- 6,008 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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
.. 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.FindDialogEvent:

==========================================================================================================================================
|phoenix_title|  **wx.FindDialogEvent**
==========================================================================================================================================

:ref:`wx.FindReplaceDialog`  events.          







.. _FindDialogEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`wx.FindDialogEvent` parameter.

Event macros: 

- EVT_FIND: Find button was pressed in the dialog.  
- EVT_FIND_NEXT: Find next button was pressed in the dialog.  
- EVT_FIND_REPLACE: Replace button was pressed in the dialog.  
- EVT_FIND_REPLACE_ALL: Replace all button was pressed in the dialog.  
- EVT_FIND_CLOSE: The dialog is being destroyed, any pointers to it cannot be used any longer.  










|

|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>FindDialogEvent</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.FindDialogEvent_inheritance.png" alt="Inheritance diagram of FindDialogEvent" 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.Event.html" title="wx.Event" alt="" coords="38,83,116,112"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="5,160,149,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="36,5,117,35"/> <area shape="rect" id="node4" href="wx.FindDialogEvent.html" title="wx.FindDialogEvent" alt="" coords="6,237,148,267"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~wx.FindDialogEvent.__init__`                                             Constructor used by wxWidgets only.
:meth:`~wx.FindDialogEvent.GetDialog`                                            Return the pointer to the dialog which generated this event.
:meth:`~wx.FindDialogEvent.GetFindString`                                        Return the string to find (never empty).
:meth:`~wx.FindDialogEvent.GetFlags`                                             Get the currently selected flags: this is the combination of the :ref:`wx.FindReplaceFlags`  enumeration values.
:meth:`~wx.FindDialogEvent.GetReplaceString`                                     Return the string to replace the search string with (only for replace and replace all events).
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.FindDialogEvent.Dialog`                                               See :meth:`~wx.FindDialogEvent.GetDialog`
:attr:`~wx.FindDialogEvent.FindString`                                           See :meth:`~wx.FindDialogEvent.GetFindString`
:attr:`~wx.FindDialogEvent.Flags`                                                See :meth:`~wx.FindDialogEvent.GetFlags`
:attr:`~wx.FindDialogEvent.ReplaceString`                                        See :meth:`~wx.FindDialogEvent.GetReplaceString`
================================================================================ ================================================================================


|


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


.. class:: wx.FindDialogEvent(CommandEvent)

   **Possible constructors**::

       FindDialogEvent(commandType=wxEVT_NULL, id=0)
       
   
   FindReplaceDialog events.



   .. method:: __init__(self, commandType=wxEVT_NULL, id=0)

      Constructor used by wxWidgets only.                  


      :param `commandType`: 
      :type `commandType`: wx.EventType
      :param `id`: 
      :type `id`: int







   .. method:: GetDialog(self)

      Return the pointer to the dialog which generated this event.                  

      :rtype: :ref:`wx.FindReplaceDialog`








   .. method:: GetFindString(self)

      Return the string to find (never empty).                  

      :rtype: `string`








   .. method:: GetFlags(self)

      Get the currently selected flags: this is the combination of the :ref:`wx.FindReplaceFlags`  enumeration values.                  

      :rtype: `int`








   .. method:: GetReplaceString(self)

      Return the string to replace the search string with (only for replace and replace all events).                  

      :rtype: `string`








   .. attribute:: Dialog

      See :meth:`~wx.FindDialogEvent.GetDialog`


   .. attribute:: FindString

      See :meth:`~wx.FindDialogEvent.GetFindString`


   .. attribute:: Flags

      See :meth:`~wx.FindDialogEvent.GetFlags`


   .. attribute:: ReplaceString

      See :meth:`~wx.FindDialogEvent.GetReplaceString`