Restructure wxNotificationMessage.

wxNotificationMessage has been refactored to always use wxNotificationMessageImpl (this was previously already done in the MSW implementation) This adds various features and fixes to wxNotificationMessage: - OS X Notification Center implementation - Generic "toast" notifications - SetIcon() to specify a custom icon - AddAction() to add actions to notifications - Events to get notify of notification clicks, dismiss or actions
2015-09-09 22:59:21 +02:00
parent 39716462e6
commit bf5e403a68
31 changed files with 1999 additions and 817 deletions
--- a/samples/dialogs/dialogs.cpp
+++ b/samples/dialogs/dialogs.cpp
@@ -32,8 +32,13 @@
 #include "wx/minifram.h"
 #include "wx/sysopt.h"
 #include "wx/notifmsg.h"
+#include "wx/generic/notifmsg.h"
 #include "wx/modalhook.h"

+#if defined(__WXMSW__) && wxUSE_TASKBARICON
+#include "wx/taskbar.h"
+#endif
+
 #if wxUSE_RICHMSGDLG
    #include "wx/richmsgdlg.h"
 #endif // wxUSE_RICHMSGDLG
@@ -267,9 +272,7 @@ wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)

    EVT_MENU(DIALOGS_REQUEST,                       MyFrame::OnRequestUserAttention)
 #if wxUSE_NOTIFICATION_MESSAGE
-    EVT_MENU(DIALOGS_NOTIFY_AUTO,                   MyFrame::OnNotifMsgAuto)
-    EVT_MENU(DIALOGS_NOTIFY_SHOW,                   MyFrame::OnNotifMsgShow)
-    EVT_MENU(DIALOGS_NOTIFY_HIDE,                   MyFrame::OnNotifMsgHide)
+    EVT_MENU(DIALOGS_NOTIFY_MSG,                    MyFrame::OnNotifMsg)
 #endif // wxUSE_NOTIFICATION_MESSAGE

 #if wxUSE_RICHTOOLTIP
@@ -553,9 +556,8 @@ bool MyApp::OnInit()
    wxMenu *menuNotif = new wxMenu;
    menuNotif->Append(DIALOGS_REQUEST, wxT("&Request user attention\tCtrl-Shift-R"));
 #if wxUSE_NOTIFICATION_MESSAGE
-    menuNotif->Append(DIALOGS_NOTIFY_AUTO, "&Automatically hidden notification");
-    menuNotif->Append(DIALOGS_NOTIFY_SHOW, "&Show manual notification");
-    menuNotif->Append(DIALOGS_NOTIFY_HIDE, "&Hide manual notification");
+    menuNotif->AppendSeparator();
+    menuNotif->Append(DIALOGS_NOTIFY_MSG, "User &Notification\tCtrl-Shift-N");
 #endif // wxUSE_NOTIFICATION_MESSAGE
    menuDlg->AppendSubMenu(menuNotif, "&User notifications");

@@ -632,10 +634,6 @@ MyFrame::MyFrame(const wxString& title)
    }
 #endif // wxUSE_COLOURDLG

-#if wxUSE_NOTIFICATION_MESSAGE
-    m_notifMsg = NULL;
-#endif // wxUSE_NOTIFICATION_MESSAGE
-
 #if wxUSE_STATUSBAR
    CreateStatusBar();
 #endif // wxUSE_STATUSBAR
@@ -708,9 +706,6 @@ MyFrame::MyFrame(const wxString& title)

 MyFrame::~MyFrame()
 {
-#if wxUSE_NOTIFICATION_MESSAGE
-    delete m_notifMsg;
-#endif // wxUSE_NOTIFICATION_MESSAGE
 }

 #if wxUSE_COLOURDLG
@@ -1900,53 +1895,402 @@ void MyFrame::OnRequestUserAttention(wxCommandEvent& WXUNUSED(event))
    RequestUserAttention(wxUSER_ATTENTION_ERROR);
 }

+#if wxUSE_RICHTOOLTIP || wxUSE_NOTIFICATION_MESSAGE
+
+#include "tip.xpm"
+
+#endif
+
 #if wxUSE_NOTIFICATION_MESSAGE

-void MyFrame::OnNotifMsgAuto(wxCommandEvent& WXUNUSED(event))
+// ----------------------------------------------------------------------------
+// TestNotificationMessageDialog
+// ----------------------------------------------------------------------------
+
+class TestNotificationMessageWindow : public wxFrame
 {
-    // Notice that the notification remains shown even after the
-    // wxNotificationMessage object itself is destroyed so we can show simple
-    // notifications using temporary objects.
-    if ( !wxNotificationMessage
-          (
-            "Automatic Notification",
-            "Nothing important has happened\n"
-            "this notification will disappear soon."
-          ).Show() )
+public:
+    TestNotificationMessageWindow(wxWindow *parent) :
+        wxFrame(parent, wxID_ANY, "User Notification Test Dialog")
    {
-        wxLogStatus("Failed to show notification message");
+#ifdef __WXMSW__
+        SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE));
+#endif
+        wxSizer * const sizerTop = new wxBoxSizer(wxVERTICAL);
+
+        wxSizer* sizerText = new wxStaticBoxSizer(wxVERTICAL, this, "Notification Texts");
+
+        sizerText->Add(new wxStaticText(this, wxID_ANY, "&Title:"),
+            wxSizerFlags());
+        m_textTitle = new wxTextCtrl(this, wxID_ANY, "Notification Title");
+        sizerText->Add(m_textTitle, wxSizerFlags().Expand());
+
+        sizerText->Add(new wxStaticText(this, wxID_ANY, "&Message:"),
+            wxSizerFlags());
+        m_textMessage = new wxTextCtrl(this, wxID_ANY, "A message within the notification",
+            wxDefaultPosition, wxDefaultSize, wxTE_MULTILINE);
+        m_textMessage->SetMinSize(wxSize(300, -1));
+        sizerText->Add(m_textMessage, wxSizerFlags().Expand());
+
+        sizerTop->Add(sizerText, wxSizerFlags().Expand().Border());
+
+        const wxString icons[] =
+        {
+            "De&fault",
+            "None",
+            "&Information",
+            "&Warning",
+            "&Error",
+            "&Custom"
+        };
+        wxCOMPILE_TIME_ASSERT(WXSIZEOF(icons) == Icon_Max, IconMismatch);
+        m_icons = new wxRadioBox(this, wxID_ANY, "Ic&on in notification",
+            wxDefaultPosition, wxDefaultSize,
+            WXSIZEOF(icons), icons,
+            1, wxRA_SPECIFY_ROWS);
+        m_icons->SetSelection(Icon_Default);
+        sizerTop->Add(m_icons, wxSizerFlags().Expand().Border());
+
+        const wxString timeouts[] =
+        {
+            "&Automatic",
+            "&Never",
+            "&5 sec",
+            "&15 sec"
+        };
+        m_showTimeout = new wxRadioBox(this, wxID_ANY, "&Timeout for notification",
+            wxDefaultPosition, wxDefaultSize,
+            WXSIZEOF(timeouts), timeouts,
+            1, wxRA_SPECIFY_ROWS);
+        m_showTimeout->SetSelection(0);
+        sizerTop->Add(m_showTimeout, wxSizerFlags().Expand().Border());
+
+        wxSizer* sizerActions = new wxStaticBoxSizer(wxVERTICAL, this, "Additional Actions");
+
+        m_actionList = new wxListBox(this, wxID_ANY);
+        sizerActions->Add(m_actionList, wxSizerFlags().Expand());
+
+        wxSizer* sizerActionMod = new wxBoxSizer(wxHORIZONTAL);
+        sizerActionMod->Add(new wxStaticText(this, wxID_ANY, "ID:"), wxSizerFlags().Center());
+        const wxString actionIds[] =
+        {
+            "wxID_DELETE",
+            "wxID_CLOSE",
+            "wxID_OK",
+            "wxID_CANCEL"
+        };
+        m_actionChoice = new wxChoice(this, wxID_ANY,
+            wxDefaultPosition, wxDefaultSize,
+            WXSIZEOF(actionIds), actionIds
+            );
+        m_actionChoice->SetSelection(0);
+        sizerActionMod->Add(m_actionChoice);
+        sizerActionMod->Add(new wxStaticText(this, wxID_ANY, "Custom label:"), wxSizerFlags().Center());
+        m_actionCaption = new wxTextCtrl(this, wxID_ANY);
+        sizerActionMod->Add(m_actionCaption);
+        wxButton* actionAddBtn = new wxButton(this, wxID_ADD);
+        actionAddBtn->Bind(wxEVT_BUTTON, &TestNotificationMessageWindow::OnActionAddClicked, this);
+        sizerActionMod->Add(actionAddBtn);
+        wxButton* actionRemoveBtn = new wxButton(this, wxID_REMOVE);
+        actionRemoveBtn->Bind(wxEVT_BUTTON, &TestNotificationMessageWindow::OnActionRemoveClicked, this);
+        sizerActionMod->Add(actionRemoveBtn);
+
+        sizerActions->Add(sizerActionMod, wxSizerFlags().Border());
+
+        sizerTop->Add(sizerActions, wxSizerFlags().Expand().Border());
+
+        wxSizer* sizerSettings = new wxStaticBoxSizer(wxVERTICAL, this, "Notification Settings");
+
+#ifdef wxHAS_NATIVE_NOTIFICATION_MESSAGE
+        m_useGeneric = new wxCheckBox(this, wxID_ANY, "Use &generic notifications");
+        sizerSettings->Add(m_useGeneric);
+#endif
+
+        m_delayShow = new wxCheckBox(this, wxID_ANY, "&Delay show");
+#if defined(__WXOSX__)
+        m_delayShow->SetValue(true);
+#endif
+        sizerSettings->Add(m_delayShow);
+
+        m_handleEvents = new wxCheckBox(this, wxID_ANY, "&Handle events");
+        m_handleEvents->SetValue(true);
+        sizerSettings->Add(m_handleEvents);
+
+#if defined(__WXMSW__) && wxUSE_TASKBARICON
+        m_taskbarIcon = NULL;
+        m_useTaskbar = new wxCheckBox(this, wxID_ANY, "Use persistent &taskbar icon");
+        m_useTaskbar->SetValue(false);
+        sizerSettings->Add(m_useTaskbar);
+#endif
+
+        sizerTop->Add(sizerSettings, wxSizerFlags().Expand().Border());
+
+        m_textStatus = new wxStaticText(this, wxID_ANY, "", wxDefaultPosition, wxDefaultSize,
+            wxST_NO_AUTORESIZE | wxALIGN_CENTRE_HORIZONTAL);
+        m_textStatus->SetForegroundColour(*wxBLUE);
+        sizerTop->Add(m_textStatus, wxSizerFlags().Expand().Border());
+
+        wxSizer* sizerButtons = new wxBoxSizer(wxHORIZONTAL);
+        sizerButtons->Add(new wxButton(this, wxID_NEW, "&Show"));
+        m_closeButton = new wxButton(this, wxID_CLOSE, "&Close");
+        m_closeButton->Disable();
+        sizerButtons->Add(m_closeButton);
+        sizerTop->Add(sizerButtons, wxSizerFlags().Center());
+
+        SetSizerAndFit(sizerTop);
+
+        Center();
+
+        Bind(wxEVT_BUTTON, &TestNotificationMessageWindow::OnShowClicked, this, wxID_NEW);
+        Bind(wxEVT_BUTTON, &TestNotificationMessageWindow::OnCloseClicked, this, wxID_CLOSE);
    }

-    // But it doesn't have to be a temporary, of course.
-    wxNotificationMessage n("Dummy Warning", "Example of a warning notification.");
-    n.SetFlags(wxICON_ERROR);
-    n.Show(5); // Just for testing, use 5 second delay.
-}
+private:
+    enum
+    {
+        Icon_Default,
+        Icon_None,
+        Icon_Info,
+        Icon_Warning,
+        Icon_Error,
+        Icon_Custom,
+        Icon_Max
+    };

-void MyFrame::OnNotifMsgShow(wxCommandEvent& WXUNUSED(event))
+    class ActionInfo : public wxClientData
+    {
+    public:
+        ActionInfo(wxWindowID actionId, const wxString& actionCaption):
+            id(actionId),
+            customCaption(actionCaption)
+        {
+
+        }
+
+        wxWindowID id;
+        wxString customCaption;
+    };
+
+    wxTextCtrl* m_textTitle;
+    wxTextCtrl* m_textMessage;
+    wxRadioBox* m_icons;
+    wxRadioBox* m_showTimeout;
+    wxListBox* m_actionList;
+    wxChoice* m_actionChoice;
+    wxTextCtrl* m_actionCaption;
+#ifdef wxHAS_NATIVE_NOTIFICATION_MESSAGE
+    wxCheckBox* m_useGeneric;
+#endif
+    wxCheckBox* m_delayShow;
+    wxCheckBox* m_handleEvents;
+    wxStaticText* m_textStatus;
+    wxButton* m_closeButton;
+
+#if defined(__WXMSW__) && wxUSE_TASKBARICON
+    wxCheckBox* m_useTaskbar;
+    wxTaskBarIcon* m_taskbarIcon;
+#endif
+
+    wxSharedPtr< wxNotificationMessageBase> m_notif;
+
+    void DoShowNotification()
+    {
+        if ( m_delayShow->GetValue() )
+        {
+            ShowStatus("Sleeping for 3 seconds to allow you to switch to another window");
+            wxYield();
+            wxSleep(3);
+        }
+
+        m_closeButton->Enable();
+        ShowStatus("Showing notification...");
+#ifdef wxHAS_NATIVE_NOTIFICATION_MESSAGE
+        if ( m_useGeneric->GetValue() )
+            m_notif = new wxGenericNotificationMessage(
+                m_textTitle->GetValue(),
+                m_textMessage->GetValue(),
+                this);
+        else
+#endif
+        {
+            m_notif = new wxNotificationMessage(
+                m_textTitle->GetValue(),
+                m_textMessage->GetValue(),
+                this);
+
+#if defined(__WXMSW__) && wxUSE_TASKBARICON
+            if ( m_useTaskbar->GetValue() )
+            {
+                if ( !m_taskbarIcon )
+                {
+                    m_taskbarIcon = new wxTaskBarIcon();
+                    m_taskbarIcon->SetIcon(reinterpret_cast<wxTopLevelWindow*>(GetParent())->GetIcon(), 
+                        "Dialogs Sample (Persistent)");
+                }
+                wxNotificationMessage::UseTaskBarIcon(m_taskbarIcon);
+            }
+            else
+            if ( m_taskbarIcon )
+            {
+                wxNotificationMessage::UseTaskBarIcon(NULL);
+                delete m_taskbarIcon;
+                m_taskbarIcon = NULL;
+            }
+#endif
+        }
+
+        switch (m_icons->GetSelection())
+        {
+            case Icon_Default:
+                // Don't call SetFlags or SetIcon to see the implementations default
+                break;
+            case Icon_None:
+                m_notif->SetFlags(0);
+                break;
+            case Icon_Info:
+                m_notif->SetFlags(wxICON_INFORMATION);
+                break;
+            case Icon_Warning:
+                m_notif->SetFlags(wxICON_WARNING);
+                break;
+            case Icon_Error:
+                m_notif->SetFlags(wxICON_ERROR);
+                break;
+            case Icon_Custom:
+                m_notif->SetIcon(tip_xpm);
+                break;
+        }
+
+        int timeout;
+        switch (m_showTimeout->GetSelection())
+        {
+            case 1:
+                timeout = wxNotificationMessage::Timeout_Never;
+                break;
+            case 2:
+                timeout = 5;
+                break;
+            case 3:
+                timeout = 10;
+                break;
+            default:
+                timeout = wxNotificationMessage::Timeout_Auto;
+                break;
+        }
+
+        for (unsigned int i = 0; i < m_actionList->GetCount(); i++)
+        {
+            ActionInfo* ai = reinterpret_cast<ActionInfo*>(m_actionList->GetClientObject(i));
+            if ( !m_notif->AddAction(ai->id, ai->customCaption) )
+                wxLogWarning("Could not add action: %s", m_actionList->GetString(i));
+        }
+
+        if ( m_handleEvents->GetValue() )
+        {
+            m_notif->Bind(wxEVT_NOTIFICATION_MESSAGE_ACTION, &TestNotificationMessageWindow::OnNotificationAction, this);
+            m_notif->Bind(wxEVT_NOTIFICATION_MESSAGE_CLICK, &TestNotificationMessageWindow::OnNotificationClicked, this);
+            m_notif->Bind(wxEVT_NOTIFICATION_MESSAGE_DISMISSED, &TestNotificationMessageWindow::OnNotificationDismissed, this);
+        }
+
+        m_notif->Show(timeout);
+
+        // Free the notification if we don't handle it's events
+        if ( !m_handleEvents->GetValue() )
+        {
+            // Notice that the notification remains shown even after the
+            // wxNotificationMessage object itself is destroyed so we can show simple
+            // notifications using temporary objects.
+            m_notif.reset();
+            ShowStatus("Showing notification, deleted object");
+        }
+    }
+
+    void OnShowClicked(wxCommandEvent& WXUNUSED(event))
+    {
+        DoShowNotification();
+    }
+
+    void OnCloseClicked(wxCommandEvent& WXUNUSED(event))
+    {
+        if ( m_notif )
+            m_notif->Close();
+    }
+
+    void OnActionAddClicked(wxCommandEvent& WXUNUSED(event))
+    {
+        wxWindowID actionId;
+        switch (m_actionChoice->GetSelection())
+        {
+            case 1:
+                actionId = wxID_CLOSE;
+                break;
+            case 2:
+                actionId = wxID_OK;
+                break;
+            case 3:
+                actionId = wxID_CANCEL;
+                break;
+            default:
+                actionId = wxID_DELETE;
+                break;
+        }
+
+        wxString actionCaption = m_actionCaption->GetValue();
+        wxString desc = m_actionChoice->GetStringSelection();
+        if ( !actionCaption.empty() )
+            desc += " (" + actionCaption + ")";
+        m_actionList->SetSelection( m_actionList->Append( desc, new ActionInfo(actionId, actionCaption) ) );
+    }
+
+    void OnActionRemoveClicked(wxCommandEvent& WXUNUSED(event))
+    {
+        int pos = m_actionList->GetSelection();
+        if ( pos != wxNOT_FOUND )
+        {
+            m_actionList->Delete(pos);
+            if ( pos > 0 && m_actionList->GetCount() > 0 )
+                m_actionList->SetSelection(pos - 1);
+        }
+        else
+            wxLogError("No action selected");
+    }
+
+    void OnNotificationClicked(wxCommandEvent& event)
+    {
+        ShowStatus("Notification was clicked");
+
+        Raise();
+
+        event.Skip();
+    }
+
+    void OnNotificationDismissed(wxCommandEvent& event)
+    {
+        ShowStatus("Notification was dismissed");
+
+        Raise();
+
+        event.Skip();
+    }
+
+    void OnNotificationAction(wxCommandEvent& event)
+    {
+        ShowStatus(wxString::Format("Selected %s action in notification", wxGetStockLabel(event.GetId(), 0)) );
+
+        event.Skip();
+    }
+
+    void ShowStatus(const wxString& text)
+    {
+        m_textStatus->SetLabelText(text);
+    }
+
+};
+
+void MyFrame::OnNotifMsg(wxCommandEvent& WXUNUSED(event))
 {
-    if ( !m_notifMsg )
-    {
-        m_notifMsg = new wxNotificationMessage
-                         (
-                            "wxWidgets Manual Notification",
-                            "You can hide this notification from the menu",
-                            this
-                         );
-    }
-
-    if ( !m_notifMsg->Show(wxNotificationMessage::Timeout_Never) )
-    {
-        wxLogStatus("Failed to show manual notification message");
-    }
-}
-
-void MyFrame::OnNotifMsgHide(wxCommandEvent& WXUNUSED(event))
-{
-    if ( m_notifMsg && !m_notifMsg->Close() )
-    {
-        wxLogStatus("Failed to hide manual notification message");
-    }
+    TestNotificationMessageWindow* dlg = new TestNotificationMessageWindow(this);
+    dlg->Show();
 }

 #endif // wxUSE_NOTIFICATION_MESSAGE
@@ -1955,8 +2299,6 @@ void MyFrame::OnNotifMsgHide(wxCommandEvent& WXUNUSED(event))

 #include "wx/richtooltip.h"

-#include "tip.xpm"
-
 class RichTipDialog : public wxDialog
 {
 public:
@@ -2225,7 +2567,7 @@ TestDefaultActionDialog::TestDefaultActionDialog( wxWindow *parent ) :
    main_sizer->Add( grid_sizer, 0, wxALL, 10 );

    wxSizer *button_sizer = CreateSeparatedButtonSizer( wxOK|wxCANCEL );
-    if (button_sizer)
+    if ( button_sizer )
        main_sizer->Add( button_sizer, 0, wxALL|wxGROW, 5 );

    SetSizerAndFit( main_sizer );