Document wxKill(wxSIGTERM) reliance on having an open window in wxMSW.

[wxWidgets.git] / include / wx / preferences.h

diff --git a/include/wx/preferences.h b/include/wx/preferences.h
index ab1e0a2c99cd081e3de0299231f85c00f6dabb71..f93472e4f297476b9d3fb5695ffbe6563fb296ca 100644 (file)
--- a/include/wx/preferences.h
+++ b/include/wx/preferences.h
@@ -12,6 +12,9 @@
 #define _WX_PREFERENCES_H_
 
 #include "wx/defs.h"
+
+#if wxUSE_PREFERENCES_EDITOR
+
 #include "wx/bitmap.h"
 #include "wx/vector.h"
 
@@ -93,7 +96,9 @@ class WXDLLIMPEXP_CORE wxPreferencesEditor
 public:
     // Ctor creates an empty editor, use AddPage() to add controls to it.
     wxPreferencesEditor(const wxString& title = wxString());
-    ~wxPreferencesEditor();
+
+    // Dtor destroys the dialog if still shown.
+    virtual ~wxPreferencesEditor();
 
     // Add a new page to the editor. The editor takes ownership of the page
     // and won't delete it until it is destroyed itself.
@@ -104,8 +109,7 @@ public:
     // platform, i.e. depending on whether the dialog is modal or not.
     virtual void Show(wxWindow* parent);
 
-    // Hide the currently shown dialog, if any. This doesn't do anything on the
-    // platforms using modal preferences dialogs but should be called to
+    // Hide the currently shown dialog, if any. This is typically used to
     // dismiss the dialog if the object whose preferences it is editing was
     // closed.
     void Dismiss();
@@ -137,4 +141,6 @@ private:
     wxDECLARE_NO_COPY_CLASS(wxPreferencesEditor);
 };
 
+#endif // wxUSE_PREFERENCES_EDITOR
+
 #endif // _WX_PREFERENCES_H_