don't crash if one of GetAllCommands() parameters is NULL (coverity checker CID 11)

[wxWidgets.git] / src / common / dlgcmn.cpp

diff --git a/src/common/dlgcmn.cpp b/src/common/dlgcmn.cpp
index c708a96e2591af62ef89334f537f53c9cdc31068..64011f46c77c7c2445f691cd9c63b4cc0aef1a3c 100644 (file)
--- a/src/common/dlgcmn.cpp
+++ b/src/common/dlgcmn.cpp
@@ -6,7 +6,7 @@
 // Created:     28.06.99
 // RCS-ID:      $Id$
 // Copyright:   (c) Vadim Zeitlin
 // Created:     28.06.99
 // RCS-ID:      $Id$
 // Copyright:   (c) Vadim Zeitlin

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -17,12 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if 0
-#ifdef __GNUG__
-    #pragma implementation
-#endif
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -31,146 +25,400 @@
 #endif
 
 #ifndef WX_PRECOMP
 #endif
 
 #ifndef WX_PRECOMP

+    #include "wx/button.h"

     #include "wx/dialog.h"
     #include "wx/dcclient.h"
     #include "wx/dialog.h"
     #include "wx/dcclient.h"

+    #include "wx/intl.h"

     #include "wx/settings.h"
     #include "wx/settings.h"

+    #include "wx/stattext.h"
+    #include "wx/sizer.h"
+    #include "wx/button.h"
+    #include "wx/containr.h"

 #endif
 
 #endif
 

+#include "wx/statline.h"
+#include "wx/sysopt.h"
+
+#if wxUSE_STATTEXT
+

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-// constants
+// wxTextWrapper

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-const long wxDialogBase::LAYOUT_X_MARGIN = 5;
-const long wxDialogBase::LAYOUT_Y_MARGIN = 5;
+// 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; }

 
 

-const long wxDialogBase::MARGIN_BETWEEN_BUTTONS = 3*LAYOUT_X_MARGIN;
+    // 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);

 
 

-// ============================================================================
-// implementation
-// ============================================================================
+    // we don't need it, but just to avoid compiler warnings
+    virtual ~wxTextWrapper() { }
+
+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

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// dialog layout functions
+// wxDialogBase

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-wxSize wxDialogBase::SplitTextMessage(const wxString& message,
-                                      wxArrayString *lines)
+// 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()
+
+WX_DELEGATE_TO_CONTROL_CONTAINER(wxDialogBase)
+#endif
+
+void wxDialogBase::Init()

 {
 {

-    wxClientDC dc(this);
-    dc.SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));
+    m_returnCode = 0;
+    m_affirmativeId = wxID_OK;
+    m_escapeId = wxID_ANY;

 
 

-    wxString curLine;
-    long height, width, heightTextMax = 0, widthTextMax = 0;
-    for ( const wxChar *pc = message; ; pc++ )
+    // 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
+}
+
+#if wxUSE_STATTEXT
+
+void wxTextWrapper::Wrap(wxWindow *win, const wxString& text, int widthMax)
+{
+    const wxChar *lastSpace = NULL;
+    wxString line;
+
+    const wxChar *lineStart = text.c_str();
+    for ( const wxChar *p = lineStart; ; p++ )

     {
     {

-        if ( *pc == _T('\n') || !*pc )
+        if ( IsStartOfNewLine() )
+        {
+            OnNewLine();
+
+            lastSpace = NULL;
+            line.clear();
+            lineStart = p;
+        }
+
+        if ( *p == _T('\n') || *p == _T('\0') )
+        {
+            DoOutputLine(line);
+
+            if ( *p == _T('\0') )
+                break;
+        }
+        else // not EOL

         {
         {

-            dc.GetTextExtent(curLine, &width, &height);
-            if ( width > widthTextMax )
-                widthTextMax = width;
-            if ( height > heightTextMax )
-                heightTextMax = height;
+            if ( *p == _T(' ') )
+                lastSpace = p;

 
 

-            lines->Add(curLine);
+            line += *p;

 
 

-            if ( !*pc )
+            if ( widthMax >= 0 && lastSpace )

             {
             {

-               // the end of string
-               break;
+                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
+        }
+    }
+}

 
 

-            curLine.Empty();
+class wxTextSizerWrapper : public wxTextWrapper
+{
+public:
+    wxTextSizerWrapper(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
+        else // empty line, no need to create a control for it

         {
         {

-            curLine += *pc;
+            if ( !m_hLine )
+                m_hLine = m_win->GetCharHeight();
+
+            m_sizer->Add(5, m_hLine);

         }
     }
 
         }
     }
 

-    return wxSize(widthTextMax, heightTextMax);
-}
+private:
+    wxWindow *m_win;
+    wxSizer *m_sizer;
+    int m_hLine;
+};

 
 

-long wxDialogBase::CreateTextMessage(const wxArrayString& lines,
-                                     const wxPoint& posText,
-                                     const wxSize& sizeText)
+wxSizer *wxDialogBase::CreateTextSizer(const wxString& message)

 {
 {

-    wxStaticText *text;
-    int y = posText.y;
-    size_t nLineCount = lines.GetCount();
-    for ( size_t nLine = 0; nLine < nLineCount; nLine++ )
+    // I admit that this is complete bogus, but it makes
+    // message boxes work for pda screens temporarily..
+    int widthMax = -1;
+    const bool is_pda = wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA;
+    if (is_pda)

     {
     {

-        text = new wxStaticText(this, -1, lines[nLine],
-                                wxPoint(posText.x, y),
-                                sizeText);
-        y += sizeText.GetHeight();
+        widthMax = wxSystemSettings::GetMetric( wxSYS_SCREEN_X ) - 25;

     }
 
     }
 

-    return y;
+    // '&' is used as accel mnemonic prefix in the wxWidgets controls but in
+    // the static messages created by CreateTextSizer() (used by wxMessageBox,
+    // for example), we don't want this special meaning, so we need to quote it
+    wxString text(message);
+    text.Replace(_T("&"), _T("&&"));
+
+    wxTextSizerWrapper wrapper(this);
+
+    return wrapper.CreateSizer(text, widthMax);

 }
 
 }
 

-wxSize wxDialogBase::GetStandardButtonSize(bool hasCancel)
+class wxLabelWrapper : public wxTextWrapper

 {
 {

-    int wButton = 0;
-    GetTextExtent(_("OK"), &wButton, NULL);
-
-    if ( hasCancel )
+public:
+    void WrapLabel(wxWindow *text, int widthMax)

     {
     {

-        int width;
-        GetTextExtent(_("Cancel"), &width, NULL);
-        if ( width > wButton )
-            wButton = width;
+        m_text.clear();
+        Wrap(text, text->GetLabel(), widthMax);
+        text->SetLabel(m_text);

     }
 
     }
 

-    if ( wButton < 75 )
+protected:
+    virtual void OnOutputLine(const wxString& line)

     {
     {

-        // the minimal acceptable width
-        wButton = 75;
+        m_text += line;

     }
     }

-    else
+
+    virtual void OnNewLine()

     {
     {

-        // the width of the button is not just the width of the label...
-        wButton += 2*LAYOUT_X_MARGIN;
+        m_text += _T('\n');

     }
 
     }
 

-    // a nice looking proportion
-    int hButton = (wButton * 23) / 75;
+private:
+    wxString m_text;
+};

 
 

-    return wxSize(wButton, hButton);
+// NB: don't "factor out" the scope operator, SGI MIPSpro 7.3 (but not 7.4)
+//     gets confused if it doesn't immediately follow the class name
+void
+#if defined(__WXGTK__) && !defined(__WXUNIVERSAL__)
+wxStaticText::
+#else
+wxStaticTextBase::
+#endif
+Wrap(int width)
+{
+    wxLabelWrapper wrapper;
+    wrapper.WrapLabel(this, width);

 }
 
 }
 

-void wxDialogBase::CreateStandardButtons(long wDialog,
-                                         long y,
-                                         long wButton,
-                                         long hButton,
-                                         bool hasCancel)
+#endif // wxUSE_STATTEXT
+
+wxSizer *wxDialogBase::CreateButtonSizer( long flags, bool separated, wxCoord distance )

 {
 {

-    // NB: create [Ok] first to get the right tab order
-    wxButton *ok = (wxButton *) NULL;
-    wxButton *cancel = (wxButton *) NULL;
+#ifdef __SMARTPHONE__
+    wxUnusedVar(separated);
+    wxUnusedVar(distance);

 
 

-    long x = wDialog / 2;
-    if ( hasCancel )
-        x -= MARGIN_BETWEEN_BUTTONS / 2 + wButton;
-    else
-        x -= wButton / 2;
+    wxDialog* dialog = (wxDialog*) this;
+    if (flags & wxOK){
+        dialog->SetLeftMenu(wxID_OK);
+    }

 
 

-    ok = new wxButton( this, wxID_OK, _("OK"),
-                       wxPoint(x, y),
-                       wxSize(wButton, hButton) );
+    if (flags & wxCANCEL){
+        dialog->SetRightMenu(wxID_CANCEL);
+    }

 
 

-    if ( hasCancel )
+    if (flags & wxYES){
+        dialog->SetLeftMenu(wxID_YES);
+    }
+
+    if (flags & wxNO){
+        dialog->SetLeftMenu(wxID_NO);
+    }
+    wxBoxSizer* sizer = new wxBoxSizer(wxHORIZONTAL);
+    return sizer;
+
+#else // !__SMARTPHONE__
+
+#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 easily replaced with real wxButtons
+    // with "wince.dialog.real-ok-cancel" option set to 1
+    if ( ((flags & ~(wxCANCEL|wxNO_DEFAULT))== wxOK) &&
+         (wxSystemOptions::GetOptionInt(wxT("wince.dialog.real-ok-cancel"))==0)
+       )

     {
     {

-        x += MARGIN_BETWEEN_BUTTONS + wButton;
-        cancel = new wxButton( this, wxID_CANCEL, _("Cancel"),
-                               wxPoint(x, y),
-                               wxSize(wButton, hButton) );
+        wxBoxSizer* sizer = new wxBoxSizer(wxHORIZONTAL);
+        return sizer;

     }
     }

+#endif // __POCKETPC__
+
+#if wxUSE_BUTTON
+
+    wxSizer* buttonSizer = CreateStdDialogButtonSizer( flags );
+
+    // Mac Human Interface Guidelines recommend not to use static lines as grouping elements
+#if wxUSE_STATLINE && !defined(__WXMAC__)
+    if(!separated)
+        return buttonSizer;
+
+    wxBoxSizer *topsizer = new wxBoxSizer( wxVERTICAL );
+    topsizer->Add( new wxStaticLine( this, wxID_ANY ), 0, wxEXPAND | wxBOTTOM, distance );
+    topsizer->Add( buttonSizer, 0, wxEXPAND );
+    return topsizer;
+
+#else // !wxUSE_STATLINE

 
 

-    ok->SetDefault();
-    ok->SetFocus();
+    wxUnusedVar(separated);
+    wxUnusedVar(distance);
+    return buttonSizer;
+
+#endif // wxUSE_STATLINE/!wxUSE_STATLINE
+
+#else // !wxUSE_BUTTON
+
+    wxUnusedVar(separated);
+    wxUnusedVar(distance);
+    wxBoxSizer* sizer = new wxBoxSizer(wxHORIZONTAL);
+    return sizer;
+
+#endif // wxUSE_BUTTON/!wxUSE_BUTTON
+
+#endif // __SMARTPHONE__/!__SMARTPHONE__

 }
 
 }
 

-long wxDialogBase::GetStandardTextHeight()
+#if wxUSE_BUTTON
+
+wxStdDialogButtonSizer *wxDialogBase::CreateStdDialogButtonSizer( long flags )

 {
 {

-    return (3*GetCharHeight()) / 2;
+    wxStdDialogButtonSizer *sizer = new wxStdDialogButtonSizer();
+
+    wxButton *ok = NULL;
+    wxButton *yes = NULL;
+    wxButton *no = NULL;
+
+    if (flags & wxOK){
+        ok = new wxButton(this, wxID_OK);
+        sizer->AddButton(ok);
+    }
+
+    if (flags & wxCANCEL){
+        wxButton *cancel = new wxButton(this, wxID_CANCEL);
+        sizer->AddButton(cancel);
+    }
+
+    if (flags & wxYES){
+        yes = new wxButton(this, wxID_YES);
+        sizer->AddButton(yes);
+    }
+
+    if (flags & wxNO){
+        no = new wxButton(this, wxID_NO);
+        sizer->AddButton(no);
+    }
+
+    if (flags & wxHELP){
+        wxButton *help = new wxButton(this, wxID_HELP);
+        sizer->AddButton(help);
+    }
+
+    if (flags & wxNO_DEFAULT)
+    {
+        if (no)
+        {
+            no->SetDefault();
+            no->SetFocus();
+        }
+    }
+    else
+    {
+        if (ok)
+        {
+            ok->SetDefault();
+            ok->SetFocus();
+        }
+        else if (yes)
+        {
+            yes->SetDefault();
+            yes->SetFocus();
+        }
+    }
+
+    if (flags & wxOK)
+        SetAffirmativeId(wxID_OK);
+    else if (flags & wxYES)
+        SetAffirmativeId(wxID_YES);
+
+    sizer->Realize();
+
+    return sizer;

 }
 }

+
+#endif // wxUSE_BUTTON