X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9f3a38fcd5f464e46bf842ddc13d7f85f8773c57..4627af27d499cd8aca708ca06e8fad19dd61ca26:/include/wx/dialog.h?ds=inline diff --git a/include/wx/dialog.h b/include/wx/dialog.h index a14930b5b0..1dd7535bc0 100644 --- a/include/wx/dialog.h +++ b/include/wx/dialog.h @@ -1,62 +1,158 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: wx/dialog.h +// Purpose: wxDialogBase class +// Author: Vadim Zeitlin +// Modified by: +// Created: 29.06.99 +// RCS-ID: $Id$ +// Copyright: (c) Vadim Zeitlin +// Licence: wxWindows licence +///////////////////////////////////////////////////////////////////////////// + #ifndef _WX_DIALOG_H_BASE_ #define _WX_DIALOG_H_BASE_ #include "wx/defs.h" -#include "wx/panel.h" +#include "wx/containr.h" +#include "wx/toplevel.h" + +class WXDLLEXPORT wxSizer; +class WXDLLEXPORT wxStdDialogButtonSizer; + +#define wxDIALOG_NO_PARENT 0x0001 // Don't make owned by apps top window + +#ifdef __WXWINCE__ +#define wxDEFAULT_DIALOG_STYLE (wxCAPTION | wxMAXIMIZE | wxCLOSE_BOX | wxNO_BORDER) +#else +#define wxDEFAULT_DIALOG_STYLE (wxCAPTION | wxSYSTEM_MENU | wxCLOSE_BOX) +#endif + +extern WXDLLEXPORT_DATA(const wxChar) wxDialogNameStr[]; -class WXDLLEXPORT wxDialogBase : public wxPanel +class WXDLLEXPORT wxDialogBase : public wxTopLevelWindow { +public: + enum + { + // all flags allowed in wxDialogBase::CreateButtonSizer() + ButtonSizerFlags = wxOK|wxCANCEL|wxYES|wxNO|wxHELP|wxNO_DEFAULT + }; + + wxDialogBase() { Init(); } + virtual ~wxDialogBase() { } + + // define public wxDialog methods to be implemented by the derived classes + virtual int ShowModal() = 0; + virtual void EndModal(int retCode) = 0; + virtual bool IsModal() const = 0; + + + // Modal dialogs have a return code - usually the id of the last + // pressed button + void SetReturnCode(int returnCode) { m_returnCode = returnCode; } + int GetReturnCode() const { return m_returnCode; } + + // Set the identifier for the affirmative button: this button will close + // the dialog after validating data and calling TransferDataFromWindow() + void SetAffirmativeId(int affirmativeId); + int GetAffirmativeId() const { return m_affirmativeId; } + + // Set identifier for Esc key translation: the button with this id will + // close the dialog without doing anything else; special value wxID_NONE + // means to not handle Esc at all while wxID_ANY means to map Esc to + // wxID_CANCEL if present and GetAffirmativeId() otherwise + void SetEscapeId(int escapeId); + int GetEscapeId() const { return m_escapeId; } + +#if wxUSE_STATTEXT // && wxUSE_TEXTCTRL + // splits text up at newlines and places the + // lines into a vertical wxBoxSizer + wxSizer *CreateTextSizer( const wxString &message ); +#endif // wxUSE_STATTEXT // && wxUSE_TEXTCTRL + + // places buttons into a horizontal wxBoxSizer + wxSizer *CreateButtonSizer( long flags, + bool separated = false, + wxCoord distance = 0 ); +#if wxUSE_BUTTON + wxStdDialogButtonSizer *CreateStdDialogButtonSizer( long flags ); +#endif // wxUSE_BUTTON + protected: - // functions to help with dialog layout - // ------------------------------------ - - // constants used in dialog layout - static const long LAYOUT_X_MARGIN; - static const long LAYOUT_Y_MARGIN; - static const long MARGIN_BETWEEN_BUTTONS; - - // Split the message in lines putting them into the array and calculating - // the maximum line width/height which is returned as wxSize. - wxSize SplitTextMessage(const wxString& message, wxArrayString *lines); - - // Creates the (possibly multiline) message, assuming each line has the - // size sizeText (which can be retrieved from SplitTextMessage). Returns - // the bottom border of the multiline text zone. - long CreateTextMessage(const wxArrayString& lines, - const wxPoint& posText, - const wxSize& sizeText); - - // Returns the preferred size for the buttons in the dialog - wxSize GetStandardButtonSize(bool hasCancel = TRUE); - - // Create the standard [Ok] and [Cancel] (if hasCancel) buttons centering - // them with respect to the dialog width wDialog at vertical position y. - // wButton and hButton is the size of the button (which can be retrieved - // from GetStandardButtonSize) - void CreateStandardButtons(long wDialog, - long y, - long wButton, - long hButton, - bool hasCancel = TRUE); - - // Returns the standard height of single line text ctrl (it's not the same - // as the height of just text which may be retrieved from - // wxGetCharHeight()) - long GetStandardTextHeight(); + // emulate click of a button with the given id if it's present in the dialog + // + // return true if button was "clicked" or false if we don't have it + bool EmulateButtonClickIfPresent(int id); + + // this function is used by OnCharHook() to decide whether the given key + // should close the dialog + // + // for most platforms the default implementation (which just checks for + // Esc) is sufficient, but Mac port also adds Cmd-. here and other ports + // could do something different if needed + virtual bool IsEscapeKey(const wxKeyEvent& event); + + // end either modal or modeless dialog, for the modal dialog rc is used as + // the dialog return code + void EndDialog(int rc); + + // call Validate() and TransferDataFromWindow() and close dialog with + // wxID_OK return code + void AcceptAndClose(); + + + // The return code from modal dialog + int m_returnCode; + + // The identifier for the affirmative button (usually wxID_OK) + int m_affirmativeId; + + // The identifier for cancel button (usually wxID_CANCEL) + int m_escapeId; + +private: + // common part of all ctors + void Init(); + + // handle Esc key presses + void OnCharHook(wxKeyEvent& event); + + // handle closing the dialog window + void OnCloseWindow(wxCloseEvent& event); + + // handle the standard buttons + void OnButton(wxCommandEvent& event); + + // update the background colour + void OnSysColourChanged(wxSysColourChangedEvent& event); + + + DECLARE_NO_COPY_CLASS(wxDialogBase) + DECLARE_EVENT_TABLE() + WX_DECLARE_CONTROL_CONTAINER(); }; -#if defined(__WXMSW__) - #include "wx/msw/dialog.h" -#elif defined(__WXMOTIF__) - #include "wx/motif/dialog.h" -#elif defined(__WXGTK__) - #include "wx/gtk/dialog.h" -#elif defined(__WXQT__) - #include "wx/qt/dialog.h" -#elif defined(__WXMAC__) - #include "wx/mac/dialog.h" -#elif defined(__WXSTUBS__) - #include "wx/stubs/dialog.h" + +#if defined(__WXUNIVERSAL__) && !defined(__WXMICROWIN__) + #include "wx/univ/dialog.h" +#else + #if defined(__WXPALMOS__) + #include "wx/palmos/dialog.h" + #elif defined(__WXMSW__) + #include "wx/msw/dialog.h" + #elif defined(__WXMOTIF__) + #include "wx/motif/dialog.h" + #elif defined(__WXGTK20__) + #include "wx/gtk/dialog.h" + #elif defined(__WXGTK__) + #include "wx/gtk1/dialog.h" + #elif defined(__WXMAC__) + #include "wx/mac/dialog.h" + #elif defined(__WXCOCOA__) + #include "wx/cocoa/dialog.h" + #elif defined(__WXPM__) + #include "wx/os2/dialog.h" + #endif #endif #endif