libyui  3.3.1
YDialogSpy.h
1 /*
2  Copyright (C) 2000-2012 Novell, Inc
3  This library is free software; you can redistribute it and/or modify
4  it under the terms of the GNU Lesser General Public License as
5  published by the Free Software Foundation; either version 2.1 of the
6  License, or (at your option) version 3.0 of the License. This library
7  is distributed in the hope that it will be useful, but WITHOUT ANY
8  WARRANTY; without even the implied warranty of MERCHANTABILITY or
9  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
10  License for more details. You should have received a copy of the GNU
11  Lesser General Public License along with this library; if not, write
12  to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
13  Floor, Boston, MA 02110-1301 USA
14 */
15 
16 
17 /*-/
18 
19  File: YDialogSpy.h
20 
21  Author: Stefan Hundhammer <sh@suse.de>
22 
23 /-*/
24 
25 
26 #ifndef YDialogSpy_h
27 #define YDialogSpy_h
28 
29 #include "ImplPtr.h"
30 
31 class YWidget;
32 class YDialog;
33 class YDialogSpyPrivate;
34 
35 
36 /**
37  * An interactive dialog debugger: Show the structure and content of a dialog
38  * and its widgets.
39  *
40  * This can be invoked by special key combinations:
41  * Ctrl-Alt-Shift-Y in the Qt UI
42  **/
44 {
45 public:
46  /**
47  * Show a YDialogSpy for the specified dialog. 0 means "use the topmost
48  * dialog".
49  * This will return only when the user closes the YDialogSpy dialog.
50  **/
51  static void showDialogSpy( YDialog * dialog = 0 );
52 
53  /**
54  * Show the "Properties" sub-window.
55  **/
56  void showProperties();
57 
58  /**
59  * Hide the "Properties" sub-window.
60  **/
61  void hideProperties();
62 
63  /**
64  * Return 'true' if the "Properties" sub-window is currently shown,
65  * 'false' if not.
66  **/
67  bool propertiesShown() const;
68 
69 protected:
70  /**
71  * Constructor: Create a YDialogSpy for the specified dialog. 0 means "use
72  * the topmost dialog".
73  *
74  * In most cases it is more useful to use the static showDialogSpy() method
75  * rather than create this dialog directly.
76  **/
77  YDialogSpy( YDialog * dialog = 0 );
78 
79  /**
80  * Destructor.
81  **/
82  virtual ~YDialogSpy();
83 
84  /**
85  * Execute the event loop. This will only return when the user closes the
86  * YDialogSpy dialog.
87  **/
88  void exec();
89 
90  /**
91  * Show the properties of the specified widget if the "Properties"
92  * sub-window is currently shown.
93  **/
94  void showProperties( YWidget * widget );
95 
96 private:
97 
99 };
100 
101 
102 #endif // YDialogSpy_h
void hideProperties()
Hide the "Properties" sub-window.
void showProperties()
Show the "Properties" sub-window.
An interactive dialog debugger: Show the structure and content of a dialog and its widgets...
Definition: YDialogSpy.h:43
virtual ~YDialogSpy()
Destructor.
Definition: YDialogSpy.cc:324
YDialogSpy(YDialog *dialog=0)
Constructor: Create a YDialogSpy for the specified dialog.
Definition: YDialogSpy.cc:205
static void showDialogSpy(YDialog *dialog=0)
Show a YDialogSpy for the specified dialog.
Definition: YDialogSpy.cc:534
void exec()
Execute the event loop.
Definition: YDialogSpy.cc:487
bool propertiesShown() const
Return &#39;true&#39; if the "Properties" sub-window is currently shown, &#39;false&#39; if not.
A window in the desktop environment.
Definition: YDialog.h:47
Abstract base class of all UI widgets.
Definition: YWidget.h:54