]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/dlgcmn.cpp
update button style to include BS_MULTILINE when a multiline label is set
[wxWidgets.git] / src / common / dlgcmn.cpp
index 9b6e38f81b63725d491b4f284844752bb11f1939..92417acc0e216b8395b6ad3b78c9732c098ae6b7 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        common/dlgcmn.cpp
+// Name:        src/common/dlgcmn.cpp
 // Purpose:     common (to all ports) wxDialog functions
 // Author:      Vadim Zeitlin
 // Modified by:
 // headers
 // ----------------------------------------------------------------------------
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "dialogbase.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
     #pragma hdrstop
 #endif
 
+#include "wx/dialog.h"
+
 #ifndef WX_PRECOMP
+    #include "wx/app.h"
     #include "wx/button.h"
-    #include "wx/dialog.h"
     #include "wx/dcclient.h"
     #include "wx/intl.h"
     #include "wx/settings.h"
     #include "wx/stattext.h"
     #include "wx/sizer.h"
-    #include "wx/button.h"
     #include "wx/containr.h"
 #endif
 
-#if wxUSE_STATTEXT
-
-// ----------------------------------------------------------------------------
-// wxTextWrapper
-// ----------------------------------------------------------------------------
-
-// this class is used to wrap the text on word boundary: wrapping is done by
-// calling OnStartLine() and OnOutputLine() functions
-class wxTextWrapper
-{
-public:
-    wxTextWrapper() { m_eol = false; }
-
-    // win is used for getting the font, text is the text to wrap, width is the
-    // max line width or -1 to disable wrapping
-    void Wrap(wxWindow *win, const wxString& text, int widthMax);
-
-    // we don't need it, but just to avoid compiler warnings
-    virtual ~wxTextWrapper() { }
+#include "wx/statline.h"
+#include "wx/sysopt.h"
+#include "wx/private/stattext.h"
 
-protected:
-    // line may be empty
-    virtual void OnOutputLine(const wxString& line) = 0;
-
-    // called at the start of every new line (except the very first one)
-    virtual void OnNewLine() { }
-
-private:
-    // call OnOutputLine() and set m_eol to true
-    void DoOutputLine(const wxString& line)
-    {
-        OnOutputLine(line);
-
-        m_eol = true;
-    }
-
-    // this function is a destructive inspector: when it returns true it also
-    // resets the flag to false so calling it again woulnd't return true any
-    // more
-    bool IsStartOfNewLine()
-    {
-        if ( !m_eol )
-            return false;
-
-        m_eol = false;
-
-        return true;
-    }
-
-
-    bool m_eol;
-};
-
-#endif // wxUSE_STATTEXT
 
 // ----------------------------------------------------------------------------
 // wxDialogBase
 // ----------------------------------------------------------------------------
 
-// FIXME - temporary hack in absence of wxTopLevelWindow, should be always used
-#ifdef wxTopLevelWindowNative
 BEGIN_EVENT_TABLE(wxDialogBase, wxTopLevelWindow)
-    WX_EVENT_TABLE_CONTROL_CONTAINER(wxDialogBase)
-END_EVENT_TABLE()
+    EVT_BUTTON(wxID_ANY, wxDialogBase::OnButton)
 
-WX_DELEGATE_TO_CONTROL_CONTAINER(wxDialogBase)
-#endif
+    EVT_CLOSE(wxDialogBase::OnCloseWindow)
+
+    EVT_CHAR_HOOK(wxDialogBase::OnCharHook)
+END_EVENT_TABLE()
 
 void wxDialogBase::Init()
 {
     m_returnCode = 0;
     m_affirmativeId = wxID_OK;
-    
+    m_escapeId = wxID_ANY;
+
     // the dialogs have this flag on by default to prevent the events from the
     // dialog controls from reaching the parent frame which is usually
     // undesirable and can lead to unexpected and hard to find bugs
     SetExtraStyle(GetExtraStyle() | wxWS_EX_BLOCK_EVENTS);
+}
 
-#ifdef wxTopLevelWindowNative // FIXME - temporary hack, should be always used!
-    m_container.SetContainerWindow(this);
-#endif
+// helper of GetParentForModalDialog()
+static bool CanBeUsedAsParent(wxWindow *parent)
+{
+    extern WXDLLIMPEXP_DATA_CORE(wxList) wxPendingDelete;
+
+    return !parent->HasExtraStyle(wxWS_EX_TRANSIENT) &&
+                parent->IsShownOnScreen() &&
+                    !wxPendingDelete.Member(parent) &&
+                        !parent->IsBeingDeleted();
+}
+
+wxWindow *wxDialogBase::GetParentForModalDialog(wxWindow *parent) const
+{
+    // creating a parent-less modal dialog will result (under e.g. wxGTK2)
+    // in an unfocused dialog, so try to find a valid parent for it:
+    if ( parent )
+        parent = wxGetTopLevelParent(parent);
+
+    if ( !parent || !CanBeUsedAsParent(parent) )
+        parent = wxTheApp->GetTopWindow();
+
+    if ( parent && !CanBeUsedAsParent(parent) )
+    {
+        // can't use this one, it's going to disappear
+        parent = NULL;
+    }
+
+    return parent;
 }
 
 #if wxUSE_STATTEXT
 
-void wxTextWrapper::Wrap(wxWindow *win, const wxString& text, int widthMax)
+class wxTextSizerWrapper : public wxTextWrapper
 {
-    const wxChar *lastSpace = NULL;
-    wxString line;
-
-    const wxChar *lineStart = text.c_str();
-    for ( const wxChar *p = lineStart; ; p++ )
+public:
+    wxTextSizerWrapper(wxWindow *win)
     {
-        if ( IsStartOfNewLine() )
-        {
-            OnNewLine();
+        m_win = win;
+        m_hLine = 0;
+    }
 
-            lastSpace = NULL;
-            line.clear();
-            lineStart = p;
-        }
+    wxSizer *CreateSizer(const wxString& text, int widthMax)
+    {
+        m_sizer = new wxBoxSizer(wxVERTICAL);
+        Wrap(m_win, text, widthMax);
+        return m_sizer;
+    }
 
-        if ( *p == _T('\n') || *p == _T('\0') )
+protected:
+    virtual void OnOutputLine(const wxString& line)
+    {
+        if ( !line.empty() )
         {
-            DoOutputLine(line);
-
-            if ( *p == _T('\0') )
-                break;
+            m_sizer->Add(new wxStaticText(m_win, wxID_ANY, line));
         }
-        else // not EOL
+        else // empty line, no need to create a control for it
         {
-            if ( *p == _T(' ') )
-                lastSpace = p;
-
-            line += *p;
-
-            if ( widthMax >= 0 && lastSpace )
-            {
-                int width;
-                win->GetTextExtent(line, &width, NULL);
-
-                if ( width > widthMax )
-                {
-                    // remove the last word from this line
-                    line.erase(lastSpace - lineStart, p + 1 - lineStart);
-                    DoOutputLine(line);
-
-                    // go back to the last word of this line which we didn't
-                    // output yet
-                    p = lastSpace;
-                }
-            }
-            //else: no wrapping at all or impossible to wrap
+            if ( !m_hLine )
+                m_hLine = m_win->GetCharHeight();
+
+            m_sizer->Add(5, m_hLine);
         }
     }
-}
+
+private:
+    wxWindow *m_win;
+    wxSizer *m_sizer;
+    int m_hLine;
+};
 
 wxSizer *wxDialogBase::CreateTextSizer(const wxString& message)
 {
@@ -194,151 +153,123 @@ wxSizer *wxDialogBase::CreateTextSizer(const wxString& message)
     wxString text(message);
     text.Replace(_T("&"), _T("&&"));
 
-
-    class TextSizerWrapper : public wxTextWrapper
-    {
-    public:
-        TextSizerWrapper(wxWindow *win)
-        {
-            m_win = win;
-            m_hLine = 0;
-        }
-
-        wxSizer *CreateSizer(const wxString& text, int widthMax)
-        {
-            m_sizer = new wxBoxSizer(wxVERTICAL);
-            Wrap(m_win, text, widthMax);
-            return m_sizer;
-        }
-
-    protected:
-        virtual void OnOutputLine(const wxString& line)
-        {
-            if ( !line.empty() )
-            {
-                m_sizer->Add(new wxStaticText(m_win, wxID_ANY, line));
-            }
-            else // empty line, no need to create a control for it
-            {
-                if ( !m_hLine )
-                    m_hLine = m_win->GetCharHeight();
-
-                m_sizer->Add(5, m_hLine);
-            }
-        }
-
-    private:
-        wxWindow *m_win;
-        wxSizer *m_sizer;
-        int m_hLine;
-    };
-
-    TextSizerWrapper wrapper(this);
+    wxTextSizerWrapper wrapper(this);
 
     return wrapper.CreateSizer(text, widthMax);
 }
 
-void
-#if defined(__WXGTK__) && !defined(__WXUNIVERSAL__)
-wxStaticText
-#else
-wxStaticTextBase
-#endif
-::Wrap(int width)
-{
-    class LabelWrapper : public wxTextWrapper
-    {
-    public:
-        void WrapLabel(wxWindow *text, int widthMax)
-        {
-            m_text.clear();
-            Wrap(text, text->GetLabel(), widthMax);
-            text->SetLabel(m_text);
-        }
-
-    protected:
-        virtual void OnOutputLine(const wxString& line)
-        {
-            m_text += line;
-        }
-
-        virtual void OnNewLine()
-        {
-            m_text += _T('\n');
-        }
-
-    private:
-        wxString m_text;
-    };
-
-    LabelWrapper wrapper;
-    wrapper.WrapLabel(this, width);
-}
-
 #endif // wxUSE_STATTEXT
 
-#if wxUSE_BUTTON
-
-wxSizer *wxDialogBase::CreateButtonSizer( long flags )
+wxSizer *wxDialogBase::CreateButtonSizer(long flags)
 {
+    wxSizer *sizer = NULL;
+
 #ifdef __SMARTPHONE__
     wxDialog* dialog = (wxDialog*) this;
-    if (flags & wxOK){
+    if ( flags & wxOK )
         dialog->SetLeftMenu(wxID_OK);
-    }
 
-    if (flags & wxCANCEL){
+    if ( flags & wxCANCEL )
         dialog->SetRightMenu(wxID_CANCEL);
-    }
 
-    if (flags & wxYES){
+    if ( flags & wxYES )
         dialog->SetLeftMenu(wxID_YES);
-    }
 
-    if (flags & wxNO){
-        dialog->SetLeftMenu(wxID_NO);
+    if ( flags & wxNO )
+        dialog->SetRightMenu(wxID_NO);
+#else // !__SMARTPHONE__
+
+#if wxUSE_BUTTON
+
+#ifdef __POCKETPC__
+    // PocketPC guidelines recommend for Ok/Cancel dialogs to use OK button
+    // located inside caption bar and implement Cancel functionality through
+    // Undo outside dialog. As native behaviour this will be default here but
+    // can be replaced with real wxButtons by setting the option below to 1
+    if ( (flags & ~(wxCANCEL|wxNO_DEFAULT)) != wxOK ||
+            wxSystemOptions::GetOptionInt(wxT("wince.dialog.real-ok-cancel")) )
+#endif // __POCKETPC__
+    {
+        sizer = CreateStdDialogButtonSizer(flags);
     }
-    wxBoxSizer* sizer = new wxBoxSizer(wxHORIZONTAL);
+#endif // wxUSE_BUTTON
+
+#endif // __SMARTPHONE__/!__SMARTPHONE__
+
     return sizer;
-#else
-    return CreateStdDialogButtonSizer( flags );
-#endif
 }
 
+wxSizer *wxDialogBase::CreateSeparatedButtonSizer(long flags)
+{
+    wxSizer *sizer = CreateButtonSizer(flags);
+    if ( !sizer )
+        return NULL;
+
+    // Mac Human Interface Guidelines recommend not to use static lines as
+    // grouping elements
+#if wxUSE_STATLINE && !defined(__WXMAC__)
+    wxBoxSizer *topsizer = new wxBoxSizer(wxVERTICAL);
+    topsizer->Add(new wxStaticLine(this),
+                   wxSizerFlags().Expand().DoubleBorder(wxBOTTOM));
+    topsizer->Add(sizer, wxSizerFlags().Expand());
+    sizer = topsizer;
+#endif // wxUSE_STATLINE
+
+    return sizer;
+}
+
+#if wxUSE_BUTTON
+
 wxStdDialogButtonSizer *wxDialogBase::CreateStdDialogButtonSizer( long flags )
 {
     wxStdDialogButtonSizer *sizer = new wxStdDialogButtonSizer();
+
     wxButton *ok = NULL;
     wxButton *yes = NULL;
     wxButton *no = NULL;
 
-    if (flags & wxOK){
+    if (flags & wxOK)
+    {
         ok = new wxButton(this, wxID_OK);
         sizer->AddButton(ok);
     }
 
-    if (flags & wxCANCEL){
+    if (flags & wxCANCEL)
+    {
         wxButton *cancel = new wxButton(this, wxID_CANCEL);
         sizer->AddButton(cancel);
     }
 
-    if (flags & wxYES){
+    if (flags & wxYES)
+    {
         yes = new wxButton(this, wxID_YES);
         sizer->AddButton(yes);
     }
 
-    if (flags & wxNO){
+    if (flags & wxNO)
+    {
         no = new wxButton(this, wxID_NO);
         sizer->AddButton(no);
     }
 
-    if (flags & wxHELP){
+    if (flags & wxAPPLY)
+    {
+        wxButton *apply = new wxButton(this, wxID_APPLY);
+        sizer->AddButton(apply);
+    }
+
+    if (flags & wxCLOSE)
+    {
+        wxButton *close = new wxButton(this, wxID_CLOSE);
+        sizer->AddButton(close);
+    }
+
+    if (flags & wxHELP)
+    {
         wxButton *help = new wxButton(this, wxID_HELP);
         sizer->AddButton(help);
     }
 
-    sizer->Realize();
-
     if (flags & wxNO_DEFAULT)
     {
         if (no)
@@ -360,14 +291,165 @@ wxStdDialogButtonSizer *wxDialogBase::CreateStdDialogButtonSizer( long flags )
             yes->SetFocus();
         }
     }
-    
+
     if (flags & wxOK)
         SetAffirmativeId(wxID_OK);
     else if (flags & wxYES)
         SetAffirmativeId(wxID_YES);
 
+    sizer->Realize();
+
     return sizer;
 }
 
-
 #endif // wxUSE_BUTTON
+
+// ----------------------------------------------------------------------------
+// standard buttons handling
+// ----------------------------------------------------------------------------
+
+void wxDialogBase::EndDialog(int rc)
+{
+    if ( IsModal() )
+        EndModal(rc);
+    else
+        Hide();
+}
+
+void wxDialogBase::AcceptAndClose()
+{
+    if ( Validate() && TransferDataFromWindow() )
+    {
+        EndDialog(m_affirmativeId);
+    }
+}
+
+void wxDialogBase::SetAffirmativeId(int affirmativeId)
+{
+    m_affirmativeId = affirmativeId;
+}
+
+void wxDialogBase::SetEscapeId(int escapeId)
+{
+    m_escapeId = escapeId;
+}
+
+bool wxDialogBase::EmulateButtonClickIfPresent(int id)
+{
+#if wxUSE_BUTTON
+    wxButton *btn = wxDynamicCast(FindWindow(id), wxButton);
+
+    if ( !btn || !btn->IsEnabled() || !btn->IsShown() )
+        return false;
+
+    wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, id);
+    event.SetEventObject(btn);
+    btn->GetEventHandler()->ProcessEvent(event);
+
+    return true;
+#else // !wxUSE_BUTTON
+    wxUnusedVar(id);
+    return false;
+#endif // wxUSE_BUTTON/!wxUSE_BUTTON
+}
+
+bool wxDialogBase::IsEscapeKey(const wxKeyEvent& event)
+{
+    // for most platforms, Esc key is used to close the dialogs
+    return event.GetKeyCode() == WXK_ESCAPE &&
+                event.GetModifiers() == wxMOD_NONE;
+}
+
+void wxDialogBase::OnCharHook(wxKeyEvent& event)
+{
+    if ( event.GetKeyCode() == WXK_ESCAPE )
+    {
+        int idCancel = GetEscapeId();
+        switch ( idCancel )
+        {
+            case wxID_NONE:
+                // don't handle Esc specially at all
+                break;
+
+            case wxID_ANY:
+                // this value is special: it means translate Esc to wxID_CANCEL
+                // but if there is no such button, then fall back to wxID_OK
+                if ( EmulateButtonClickIfPresent(wxID_CANCEL) )
+                    return;
+                idCancel = GetAffirmativeId();
+                // fall through
+
+            default:
+                // translate Esc to button press for the button with given id
+                if ( EmulateButtonClickIfPresent(idCancel) )
+                    return;
+        }
+    }
+
+    event.Skip();
+}
+
+void wxDialogBase::OnButton(wxCommandEvent& event)
+{
+    const int id = event.GetId();
+    if ( id == GetAffirmativeId() )
+    {
+        AcceptAndClose();
+    }
+    else if ( id == wxID_APPLY )
+    {
+        if ( Validate() )
+            TransferDataFromWindow();
+
+        // TODO: disable the Apply button until things change again
+    }
+    else if ( id == GetEscapeId() ||
+                (id == wxID_CANCEL && GetEscapeId() == wxID_ANY) )
+    {
+        EndDialog(wxID_CANCEL);
+    }
+    else // not a standard button
+    {
+        event.Skip();
+    }
+}
+
+// ----------------------------------------------------------------------------
+// other event handlers
+// ----------------------------------------------------------------------------
+
+void wxDialogBase::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
+{
+    // We'll send a Cancel message by default, which may close the dialog.
+    // Check for looping if the Cancel event handler calls Close().
+
+    // Note that if a cancel button and handler aren't present in the dialog,
+    // nothing will happen when you close the dialog via the window manager, or
+    // via Close(). We wouldn't want to destroy the dialog by default, since
+    // the dialog may have been created on the stack. However, this does mean
+    // that calling dialog->Close() won't delete the dialog unless the handler
+    // for wxID_CANCEL does so. So use Destroy() if you want to be sure to
+    // destroy the dialog. The default OnCancel (above) simply ends a modal
+    // dialog, and hides a modeless dialog.
+
+    // VZ: this is horrible and MT-unsafe. Can't we reuse some of these global
+    //     lists here? don't dare to change it now, but should be done later!
+    static wxList closing;
+
+    if ( closing.Member(this) )
+        return;
+
+    closing.Append(this);
+
+    wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
+    cancelEvent.SetEventObject( this );
+    GetEventHandler()->ProcessEvent(cancelEvent); // This may close the dialog
+
+    closing.DeleteObject(this);
+}
+
+void wxDialogBase::OnSysColourChanged(wxSysColourChangedEvent& WXUNUSED(event))
+{
+  SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));
+  Refresh();
+}