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

[wxWidgets.git] / include / wx / generic / wizard.h

diff --git a/include/wx/generic/wizard.h b/include/wx/generic/wizard.h
index be0b991c387792d4cbf4b4fb8e36c1537a1be93f..43e210c5adc88a62dbd405b2254d436bd32e0b49 100644 (file)
--- a/include/wx/generic/wizard.h
+++ b/include/wx/generic/wizard.h
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        generic/wizard.h
+// Name:        wx/generic/wizard.h

 // Purpose:     declaration of generic wxWizard class
 // Author:      Vadim Zeitlin
 // Modified by: Robert Vazan (sizers)
 // Purpose:     declaration of generic wxWizard class
 // Author:      Vadim Zeitlin
 // Modified by: Robert Vazan (sizers)


@@ -9,19 +9,18 @@
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 

+#ifndef _WX_GENERIC_WIZARD_H_
+#define _WX_GENERIC_WIZARD_H_
+

 // ----------------------------------------------------------------------------
 // wxWizard
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxWizard
 // ----------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "wizardg.h"
-#endif
-
-class WXDLLEXPORT wxButton;
-class WXDLLEXPORT wxStaticBitmap;
-class WXDLLIMPEXP_ADV wxWizardEvent;
-class WXDLLEXPORT wxBoxSizer;
-class WXDLLIMPEXP_ADV wxWizardSizer;
+class WXDLLIMPEXP_FWD_CORE wxButton;
+class WXDLLIMPEXP_FWD_CORE wxStaticBitmap;
+class WXDLLIMPEXP_FWD_ADV wxWizardEvent;
+class WXDLLIMPEXP_FWD_CORE wxBoxSizer;
+class WXDLLIMPEXP_FWD_ADV wxWizardSizer;

 
 class WXDLLIMPEXP_ADV wxWizard : public wxWizardBase
 {
 
 class WXDLLIMPEXP_ADV wxWizard : public wxWizardBase
 {


@@ -29,7 +28,7 @@ public:
     // ctor
     wxWizard() { Init(); }
     wxWizard(wxWindow *parent,
     // ctor
     wxWizard() { Init(); }
     wxWizard(wxWindow *parent,

-             int id = -1,
+             int id = wxID_ANY,

              const wxString& title = wxEmptyString,
              const wxBitmap& bitmap = wxNullBitmap,
              const wxPoint& pos = wxDefaultPosition,
              const wxString& title = wxEmptyString,
              const wxBitmap& bitmap = wxNullBitmap,
              const wxPoint& pos = wxDefaultPosition,


@@ -39,12 +38,13 @@ public:
         Create(parent, id, title, bitmap, pos, style);
     }
     bool Create(wxWindow *parent,
         Create(parent, id, title, bitmap, pos, style);
     }
     bool Create(wxWindow *parent,

-             int id = -1,
+             int id = wxID_ANY,

              const wxString& title = wxEmptyString,
              const wxBitmap& bitmap = wxNullBitmap,
              const wxPoint& pos = wxDefaultPosition,
              long style = wxDEFAULT_DIALOG_STYLE);
     void Init();
              const wxString& title = wxEmptyString,
              const wxBitmap& bitmap = wxNullBitmap,
              const wxPoint& pos = wxDefaultPosition,
              long style = wxDEFAULT_DIALOG_STYLE);
     void Init();

+    virtual ~wxWizard();

 
     // implement base class pure virtuals
     virtual bool RunWizard(wxWizardPage *firstPage);
 
     // implement base class pure virtuals
     virtual bool RunWizard(wxWizardPage *firstPage);


@@ -55,6 +55,10 @@ public:
     virtual wxSizer *GetPageAreaSizer() const;
     virtual void SetBorder(int border);
 
     virtual wxSizer *GetPageAreaSizer() const;
     virtual void SetBorder(int border);
 

+    /// set/get bitmap
+    const wxBitmap& GetBitmap() const { return m_bitmap; }
+    void SetBitmap(const wxBitmap& bitmap);
+

     // implementation only from now on
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------
 


@@ -62,15 +66,42 @@ public:
     bool IsRunning() const { return m_page != NULL; }
 
     // show the prev/next page, but call TransferDataFromWindow on the current
     bool IsRunning() const { return m_page != NULL; }
 
     // show the prev/next page, but call TransferDataFromWindow on the current

-    // page first and return FALSE without changing the page if
-    // TransferDataFromWindow() returns FALSE - otherwise, returns TRUE
-    bool ShowPage(wxWizardPage *page, bool goingForward = TRUE);
+    // page first and return false without changing the page if
+    // TransferDataFromWindow() returns false - otherwise, returns true
+    virtual bool ShowPage(wxWizardPage *page, bool goingForward = true);

 
     // do fill the dialog with controls
     // this is app-overridable to, for example, set help and tooltip text
     virtual void DoCreateControls();
 
 
     // do fill the dialog with controls
     // this is app-overridable to, for example, set help and tooltip text
     virtual void DoCreateControls();
 

-private:
+    // Do the adaptation
+    virtual bool DoLayoutAdaptation();
+
+    // Set/get bitmap background colour
+    void SetBitmapBackgroundColour(const wxColour& colour) { m_bitmapBackgroundColour = colour; }
+    const wxColour& GetBitmapBackgroundColour() const { return m_bitmapBackgroundColour; }
+
+    // Set/get bitmap placement (centred, tiled etc.)
+    void SetBitmapPlacement(int placement) { m_bitmapPlacement = placement; }
+    int GetBitmapPlacement() const { return m_bitmapPlacement; }
+
+    // Set/get minimum bitmap width
+    void SetMinimumBitmapWidth(int w) { m_bitmapMinimumWidth = w; }
+    int GetMinimumBitmapWidth() const { return m_bitmapMinimumWidth; }
+
+    // Tile bitmap
+    static bool TileBitmap(const wxRect& rect, wxDC& dc, const wxBitmap& bitmap);
+
+protected:
+    // for compatibility only, doesn't do anything any more
+    void FinishLayout() { }
+
+    // Do fit, and adjust to screen size if necessary
+    virtual void DoWizardLayout();
+
+    // Resize bitmap if necessary
+    virtual bool ResizeBitmap(wxBitmap& bmp);
+

     // was the dialog really created?
     bool WasCreated() const { return m_btnPrev != NULL; }
 
     // was the dialog really created?
     bool WasCreated() const { return m_btnPrev != NULL; }
 


@@ -86,10 +117,6 @@ private:
     void AddBackNextPair(wxBoxSizer *buttonRow);
     void AddButtonRow(wxBoxSizer *mainColumn);
 
     void AddBackNextPair(wxBoxSizer *buttonRow);
     void AddButtonRow(wxBoxSizer *mainColumn);
 

-    void FinishLayout();
-    
-    wxSize GetManualPageSize() const;
-    

     // the page size requested by user
     wxSize m_sizePage;
 
     // the page size requested by user
     wxSize m_sizePage;
 


@@ -105,24 +132,38 @@ private:
                 *m_btnNext;     // the "Next>" or "Finish" button
     wxStaticBitmap *m_statbmp;  // the control for the bitmap
 
                 *m_btnNext;     // the "Next>" or "Finish" button
     wxStaticBitmap *m_statbmp;  // the control for the bitmap
 

-    // Whether user called SetBorder()
-    bool m_calledSetBorder;

     // Border around page area sizer requested using SetBorder()
     int m_border;
     // Border around page area sizer requested using SetBorder()
     int m_border;

-    
+

     // Whether RunWizard() was called
     bool m_started;
     // Whether RunWizard() was called
     bool m_started;

-    
+
+    // Whether was modal (modeless has to be destroyed on finish or cancel)
+    bool m_wasModal;
+
+    // True if pages are laid out using the sizer
+    bool m_usingSizer;
+

     // Page area sizer will be inserted here with padding
     wxBoxSizer *m_sizerBmpAndPage;
     // Page area sizer will be inserted here with padding
     wxBoxSizer *m_sizerBmpAndPage;

-    
+

     // Actual position and size of pages
     wxWizardSizer *m_sizerPage;
     // Actual position and size of pages
     wxWizardSizer *m_sizerPage;

-    
+
+    // Bitmap background colour if resizing bitmap
+    wxColour    m_bitmapBackgroundColour;
+
+    // Bitmap placement flags
+    int         m_bitmapPlacement;
+
+    // Minimum bitmap width
+    int         m_bitmapMinimumWidth;
+

     friend class wxWizardSizer;
     friend class wxWizardSizer;

-    
+

     DECLARE_DYNAMIC_CLASS(wxWizard)
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxWizard)
     DECLARE_EVENT_TABLE()

-    DECLARE_NO_COPY_CLASS(wxWizard)
+    wxDECLARE_NO_COPY_CLASS(wxWizard);

 };
 
 };
 

+#endif // _WX_GENERIC_WIZARD_H_