added 'Save...' button to the log dialog

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_2_BRANCH@7534 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

src/generic/logg.cpp

@@ -46,6 +46,7 @@
 
 #include "wx/file.h"
 #include "wx/textfile.h"
+#include "wx/statline.h"
 
 #ifdef  __WXMSW__
   // for OutputDebugString()
@@ -85,20 +86,37 @@ public:
     // event handlers
     void OnOk(wxCommandEvent& event);
     void OnDetails(wxCommandEvent& event);
+#if wxUSE_FILE
+    void OnSave(wxCommandEvent& event);
+#endif // wxUSE_FILE
     void OnListSelect(wxListEvent& event);
 
 private:
+    // create controls needed for the details display
+    void CreateDetailsControls();
+
     // the data for the listctrl
     wxArrayString m_messages;
     wxArrayInt m_severity;
     wxArrayLong m_times;
 
+    // the sizer containing the buttons to which we dynamically add (and
+    // remove) the "Save" button
+    wxBoxSizer *m_sizerButtons;
+
     // the "toggle" button and its state
     wxButton *m_btnDetails;
     bool      m_showingDetails;
 
-    // the listctrl (not shown initially)
+    // the controls which are not shown initially (but only when details
+    // button is pressed)
     wxListCtrl *m_listctrl;
+#if wxUSE_STATLINE
+    wxStaticLine *m_statline;
+#endif // wxUSE_STATLINE
+#if wxUSE_FILE
+    wxButton *m_btnSave;
+#endif // wxUSE_FILE
 
     // the translated "Details" string
     static wxString ms_details;
@@ -109,11 +127,28 @@ private:
 BEGIN_EVENT_TABLE(wxLogDialog, wxDialog)
     EVT_BUTTON(wxID_OK,     wxLogDialog::OnOk)
     EVT_BUTTON(wxID_MORE,   wxLogDialog::OnDetails)
+#if wxUSE_FILE
+    EVT_BUTTON(wxID_SAVE,   wxLogDialog::OnSave)
+#endif // wxUSE_FILE
     EVT_LIST_ITEM_SELECTED(-1, wxLogDialog::OnListSelect)
 END_EVENT_TABLE()
 
 #endif // wxUSE_LOG_DIALOG
 
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
+
+#if wxUSE_FILE
+
+// pass an uninitialized file object, the function will ask the user for the
+// filename and try to open it, returns TRUE on success (file was opened),
+// FALSE if file couldn't be opened/created and -1 if the file selection
+// dialog was cancelled
+static int OpenLogFile(wxFile& file, wxString *filename = NULL);
+
+#endif // wxUSE_FILE
+
 // ----------------------------------------------------------------------------
 // global variables
 // ----------------------------------------------------------------------------
@@ -478,62 +513,23 @@ void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
 #if wxUSE_FILE
 void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
 {
-    // get the file name
+    wxString filename;
-    // -----------------
+    wxFile file;
-    const wxChar *szFileName = wxSaveFileSelector(wxT("log"), wxT("txt"), wxT("log.txt"));
+    int rc = OpenLogFile(file, &filename);
-    if ( szFileName == NULL ) {
+    if ( rc == -1 )
+    {
         // cancelled
         return;
     }
 
-    // open file
+    bool bOk = rc != 0;
-    // ---------
-    wxFile file;
-    bool bOk = FALSE;
-    if ( wxFile::Exists(szFileName) ) {
-        bool bAppend = FALSE;
-        wxString strMsg;
-        strMsg.Printf(_("Append log to file '%s' (choosing [No] will overwrite it)?"),
-                      szFileName);
-        switch ( wxMessageBox(strMsg, _("Question"), wxYES_NO | wxCANCEL) ) {
-            case wxYES:
-                bAppend = TRUE;
-                break;
-
-            case wxNO:
-                bAppend = FALSE;
-                break;
-
-            case wxCANCEL:
-                return;
-
-            default:
-                wxFAIL_MSG(_("invalid message box return value"));
-        }
-
-        if ( bAppend ) {
-            bOk = file.Open(szFileName, wxFile::write_append);
-        }
-        else {
-            bOk = file.Create(szFileName, TRUE /* overwrite */);
-        }
-    }
-    else {
-        bOk = file.Create(szFileName);
-    }
 
     // retrieve text and save it
     // -------------------------
     int nLines = m_pTextCtrl->GetNumberOfLines();
     for ( int nLine = 0; bOk && nLine < nLines; nLine++ ) {
         bOk = file.Write(m_pTextCtrl->GetLineText(nLine) +
-                // we're not going to pull in the whole wxTextFile if all we need is this...
+                         wxTextFile::GetEOL());
-#if wxUSE_TEXTFILE
-                wxTextFile::GetEOL()
-#else // !wxUSE_TEXTFILE
-                '\n'
-#endif // wxUSE_TEXTFILE
-                        );
     }
 
     if ( bOk )
@@ -543,7 +539,7 @@ void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
         wxLogError(_("Can't save log contents to file."));
     }
     else {
-        wxLogStatus(this, _("Log saved to the file '%s'."), szFileName);
+        wxLogStatus(this, _("Log saved to the file '%s'."), filename.c_str());
     }
 }
 #endif // wxUSE_FILE
@@ -688,7 +684,7 @@ wxLogDialog::wxLogDialog(wxWindow *parent,
                          const wxArrayLong& times,
                          const wxString& caption,
                          long style)
-           : wxDialog(parent, -1, caption )
+           : wxDialog(parent, -1, caption)
 {
     if ( ms_details.IsEmpty() )
     {
@@ -719,27 +715,33 @@ wxLogDialog::wxLogDialog(wxWindow *parent,
 
     m_showingDetails = FALSE; // not initially
     m_listctrl = (wxListCtrl *)NULL;
+#if wxUSE_STATLINE
+    m_statline = (wxStaticLine *)NULL;
+#endif // wxUSE_STATLINE
+#if wxUSE_FILE
+    m_btnSave = (wxButton *)NULL;
+#endif // wxUSE_FILE
 
     // create the controls which are always shown and layout them: we use
     // sizers even though our window is not resizeable to calculate the size of
     // the dialog properly
     wxBoxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
-    wxBoxSizer *sizerButtons = new wxBoxSizer(wxVERTICAL);
+    m_sizerButtons = new wxBoxSizer(wxVERTICAL);
     wxBoxSizer *sizerAll = new wxBoxSizer(wxHORIZONTAL);
 
     wxButton *btnOk = new wxButton(this, wxID_OK, _("OK"));
-    sizerButtons->Add(btnOk, 0, wxCENTRE|wxBOTTOM, MARGIN/2);
+    m_sizerButtons->Add(btnOk, 0, wxCENTRE|wxBOTTOM, MARGIN/2);
     m_btnDetails = new wxButton(this, wxID_MORE, ms_details + _T(" >>"));
-    sizerButtons->Add(m_btnDetails, 0, wxCENTRE|wxTOP, MARGIN/2 - 1);
+    m_sizerButtons->Add(m_btnDetails, 0, wxCENTRE|wxTOP, MARGIN/2 - 1);
 
 #ifndef __WIN16__
     wxIcon icon = wxTheApp->GetStdIcon((int)(style & wxICON_MASK));
     sizerAll->Add(new wxStaticBitmap(this, -1, icon), 0, wxCENTRE);
-#endif
+#endif // !Win16
 
     const wxString& message = messages.Last();
     sizerAll->Add(CreateTextSizer(message), 0, wxCENTRE|wxLEFT|wxRIGHT, MARGIN);
-    sizerAll->Add(sizerButtons, 0, wxALIGN_RIGHT|wxLEFT, MARGIN);
+    sizerAll->Add(m_sizerButtons, 0, wxALIGN_RIGHT|wxLEFT, MARGIN);
 
     sizerTop->Add(sizerAll, 0, wxCENTRE|wxALL, MARGIN);
 
@@ -764,6 +766,118 @@ wxLogDialog::wxLogDialog(wxWindow *parent,
     Centre();
 }
 
+void wxLogDialog::CreateDetailsControls()
+{
+    // create the save button and separator line if possible
+#if wxUSE_FILE
+    m_btnSave = new wxButton(this, wxID_SAVE, _("&Save..."));
+#endif // wxUSE_FILE
+
+#if wxUSE_STATLINE
+    m_statline = new wxStaticLine(this, -1);
+#endif // wxUSE_STATLINE
+
+    // create the list ctrl now
+    m_listctrl = new wxListCtrl(this, -1,
+                                wxDefaultPosition, wxDefaultSize,
+                                wxSUNKEN_BORDER |
+                                wxLC_REPORT |
+                                wxLC_NO_HEADER |
+                                wxLC_SINGLE_SEL);
+
+    // no need to translate these strings as they're not shown to the
+    // user anyhow (we use wxLC_NO_HEADER style)
+    m_listctrl->InsertColumn(0, _T("Message"));
+    m_listctrl->InsertColumn(1, _T("Time"));
+
+    // prepare the imagelist
+    static const int ICON_SIZE = 16;
+    wxImageList *imageList = new wxImageList(ICON_SIZE, ICON_SIZE);
+
+    // order should be the same as in the switch below!
+    static const int icons[] =
+    {
+        wxICON_ERROR,
+        wxICON_EXCLAMATION,
+        wxICON_INFORMATION
+    };
+
+    bool loadedIcons = TRUE;
+
+#ifndef __WIN16__
+    for ( size_t icon = 0; icon < WXSIZEOF(icons); icon++ )
+    {
+        wxBitmap bmp = wxTheApp->GetStdIcon(icons[icon]);
+
+        // This may very well fail if there are insufficient
+        // colours available. Degrade gracefully.
+
+        if (!bmp.Ok())
+            loadedIcons = FALSE;
+        else
+            imageList->Add(wxImage(bmp).
+                        Rescale(ICON_SIZE, ICON_SIZE).
+                         ConvertToBitmap());
+    }
+
+    m_listctrl->SetImageList(imageList, wxIMAGE_LIST_SMALL);
+#endif // !Win16
+
+    // and fill it
+    wxString fmt = wxLog::GetTimestamp();
+    if ( !fmt )
+    {
+        // default format
+        fmt = _T("%c");
+    }
+
+    size_t count = m_messages.GetCount();
+    for ( size_t n = 0; n < count; n++ )
+    {
+        int image = -1;
+#ifndef __WIN16__
+        switch ( m_severity[n] )
+        {
+            case wxLOG_Error:
+                image = 0;
+                break;
+
+            case wxLOG_Warning:
+                image = 1;
+                break;
+
+            default:
+                image = 2;
+        }
+#endif // !Win16
+
+        if (!loadedIcons)
+            image = -1;
+
+        if (image > -1)
+            m_listctrl->InsertItem(n, m_messages[n], image);
+        else
+            m_listctrl->InsertItem(n, m_messages[n]);
+
+        m_listctrl->SetItem(n, 1,
+                            wxDateTime((time_t)m_times[n]).Format(fmt));
+    }
+
+    // let the columns size themselves
+    m_listctrl->SetColumnWidth(0, wxLIST_AUTOSIZE);
+    m_listctrl->SetColumnWidth(1, wxLIST_AUTOSIZE);
+
+    // get the approx height of the listctrl
+    wxFont font = GetFont();
+    if ( !font.Ok() )
+        font = *wxSWISS_FONT;
+
+    int y;
+    GetTextExtent(_T("H"), (int*)NULL, &y, (int*)NULL, (int*)NULL, &font);
+    int height = wxMin(y*(count + 3), 100);
+    m_listctrl->SetSize(-1, height);
+}
+
 void wxLogDialog::OnListSelect(wxListEvent& event)
 {
     // we can't just disable the control because this looks ugly under Windows
@@ -777,6 +891,48 @@ void wxLogDialog::OnOk(wxCommandEvent& WXUNUSED(event))
     EndModal(wxID_OK);
 }
 
+#if wxUSE_FILE
+
+void wxLogDialog::OnSave(wxCommandEvent& WXUNUSED(event))
+{
+    wxFile file;
+    int rc = OpenLogFile(file);
+    if ( rc == -1 )
+    {
+        // cancelled
+        return;
+    }
+
+    bool ok = rc != 0;
+
+    wxString fmt = wxLog::GetTimestamp();
+    if ( !fmt )
+    {
+        // default format
+        fmt = _T("%c");
+    }
+
+    size_t count = m_messages.GetCount();
+    for ( size_t n = 0; ok && (n < count); n++ )
+    {
+        wxString line;
+        line << wxDateTime((time_t)m_times[n]).Format(fmt)
+             << _T(": ")
+             << m_messages[n]
+             << wxTextFile::GetEOL();
+
+        ok = file.Write(line);
+    }
+
+    if ( ok )
+        ok = file.Close();
+
+    if ( !ok )
+        wxLogError(_("Can't save log contents to file."));
+}
+
+#endif // wxUSE_FILE
+
 void wxLogDialog::OnDetails(wxCommandEvent& WXUNUSED(event))
 {
     wxSizer *sizer = GetSizer();
@@ -786,6 +942,14 @@ void wxLogDialog::OnDetails(wxCommandEvent& WXUNUSED(event))
         m_btnDetails->SetLabel(ms_details + _T(">>"));
 
         sizer->Remove(m_listctrl);
+
+#if wxUSE_STATLINE
+        sizer->Remove(m_statline);
+#endif // wxUSE_STATLINE
+
+#if wxUSE_FILE
+        m_sizerButtons->Remove(m_btnSave);
+#endif // wxUSE_FILE
     }
     else // show details now
     {
@@ -793,120 +957,36 @@ void wxLogDialog::OnDetails(wxCommandEvent& WXUNUSED(event))
 
         if ( !m_listctrl )
         {
-            // create it now
+            CreateDetailsControls();
-            m_listctrl = new wxListCtrl(this, -1,
-                                        wxDefaultPosition, wxDefaultSize,
-                                        wxSUNKEN_BORDER |
-                                        wxLC_REPORT |
-                                        wxLC_NO_HEADER |
-                                        wxLC_SINGLE_SEL);
-            // no need to translate these strings as they're not shown to the
-            // user anyhow (we use wxLC_NO_HEADER style)
-            m_listctrl->InsertColumn(0, _T("Message"));
-            m_listctrl->InsertColumn(1, _T("Time"));
-
-            // prepare the imagelist
-            static const int ICON_SIZE = 16;
-            wxImageList *imageList = new wxImageList(ICON_SIZE, ICON_SIZE);
-
-            // order should be the same as in the switch below!
-            static const int icons[] =
-            {
-                wxICON_ERROR,
-                wxICON_EXCLAMATION,
-                wxICON_INFORMATION
-            };
-
-            bool loadedIcons = TRUE;
-
-#ifndef __WIN16__
-            for ( size_t icon = 0; icon < WXSIZEOF(icons); icon++ )
-            {
-                wxBitmap bmp = wxTheApp->GetStdIcon(icons[icon]);
-
-                // This may very well fail if there are insufficient
-                // colours available. Degrade gracefully.
-
-                if (!bmp.Ok())
-                    loadedIcons = FALSE;
-                else
-                    imageList->Add(wxImage(bmp).
-                                Rescale(ICON_SIZE, ICON_SIZE).
-                                 ConvertToBitmap());
-            }
-
-            m_listctrl->SetImageList(imageList, wxIMAGE_LIST_SMALL);
-#endif
-
-            // and fill it
-            wxString fmt = wxLog::GetTimestamp();
-            if ( !fmt )
-            {
-                // default format
-                fmt = _T("%X");
-            }
-
-            size_t count = m_messages.GetCount();
-            for ( size_t n = 0; n < count; n++ )
-            {
-                int image = -1;
-#ifndef __WIN16__
-                switch ( m_severity[n] )
-                {
-                    case wxLOG_Error:
-                        image = 0;
-                        break;
-
-                    case wxLOG_Warning:
-                        image = 1;
-                        break;
-
-                    default:
-                        image = 2;
-                }
-#endif
-
-                if (!loadedIcons)
-                    image = -1;
-
-                if (image > -1)
-                    m_listctrl->InsertItem(n, m_messages[n], image);
-                else
-                    m_listctrl->InsertItem(n, m_messages[n]);
-
-                m_listctrl->SetItem(n, 1,
-                                    wxDateTime((time_t)m_times[n]).Format(fmt));
-            }
-
-            // let the columns size themselves
-            m_listctrl->SetColumnWidth(0, wxLIST_AUTOSIZE);
-            m_listctrl->SetColumnWidth(1, wxLIST_AUTOSIZE);
-
-            // get the approx height of the listctrl
-            wxFont font = GetFont();
-            if ( !font.Ok() )
-                font = *wxSWISS_FONT;
-
-            int y;
-            GetTextExtent(_T("H"), (int*)NULL, &y, (int*)NULL, (int*)NULL, &font);
-            int height = wxMin(y*(count + 3), 100);
-            m_listctrl->SetSize(-1, height);
         }
 
-        sizer->Add(m_listctrl, 1, wxEXPAND|(wxALL & ~wxTOP), MARGIN);
+#if wxUSE_FILE
+        m_sizerButtons->Add(m_btnSave, 0, wxCENTRE|wxTOP, MARGIN);
+#endif // wxUSE_FILE
+
+#if wxUSE_STATLINE
+        sizer->Add(m_statline, 0, wxEXPAND | (wxALL & ~wxTOP), MARGIN);
+#endif // wxUSE_STATLINE
+
+        sizer->Add(m_listctrl, 1, wxEXPAND| (wxALL & ~wxTOP), MARGIN);
     }
 
     m_showingDetails = !m_showingDetails;
 
     // in any case, our size changed - update
+#if wxUSE_FILE
+    m_sizerButtons->RecalcSizes();
+#endif // wxUSE_FILE
+
     sizer->SetSizeHints(this);
     sizer->Fit(this);
+
 #ifdef __WXGTK__
-    Show(TRUE);
     // VS: this is neccessary in order to force frame redraw under
     // WindowMaker or fvwm2 (and probably other broken WMs).
     // Otherwise, detailed list wouldn't be displayed.
-#endif
+    Show(TRUE);
+#endif // wxGTK
 }
 
 wxLogDialog::~wxLogDialog()
@@ -918,3 +998,64 @@ wxLogDialog::~wxLogDialog()
 }
 
 #endif // wxUSE_LOG_DIALOG
+
+#if wxUSE_FILE
+
+// pass an uninitialized file object, the function will ask the user for the
+// filename and try to open it, returns TRUE on success (file was opened),
+// FALSE if file couldn't be opened/created and -1 if the file selection
+// dialog was cancelled
+static int OpenLogFile(wxFile& file, wxString *pFilename)
+{
+    // get the file name
+    // -----------------
+    wxString filename = wxSaveFileSelector(wxT("log"), wxT("txt"), wxT("log.txt"));
+    if ( !filename ) {
+        // cancelled
+        return -1;
+    }
+
+    // open file
+    // ---------
+    bool bOk = FALSE;
+    if ( wxFile::Exists(filename) ) {
+        bool bAppend = FALSE;
+        wxString strMsg;
+        strMsg.Printf(_("Append log to file '%s' (choosing [No] will overwrite it)?"),
+                      filename.c_str());
+        switch ( wxMessageBox(strMsg, _("Question"),
+                              wxICON_QUESTION | wxYES_NO | wxCANCEL) ) {
+            case wxYES:
+                bAppend = TRUE;
+                break;
+
+            case wxNO:
+                bAppend = FALSE;
+                break;
+
+            case wxCANCEL:
+                return -1;
+
+            default:
+                wxFAIL_MSG(_("invalid message box return value"));
+        }
+
+        if ( bAppend ) {
+            bOk = file.Open(filename, wxFile::write_append);
+        }
+        else {
+            bOk = file.Create(filename, TRUE /* overwrite */);
+        }
+    }
+    else {
+        bOk = file.Create(filename);
+    }
+
+    if ( pFilename )
+        *pFilename = filename;
+
+    return bOk;
+}
+
+#endif // wxUSE_FILE
+