wxNotificationMessage macos & win polish

1 files changed, 26 insertions, 1 deletions

diff --git a/lib/wx/doc/src/wxNotificationMessage.xml b/lib/wx/doc/src/wxNotificationMessage.xml
index 71ad363592..1ebb145bb0 100644
--- a/lib/wx/doc/src/wxNotificationMessage.xml
+++ b/lib/wx/doc/src/wxNotificationMessage.xml
@@ -30,7 +30,7 @@
 <description><p>This class allows showing the user a message non intrusively.
       </p><p>Currently it is implemented natively for Windows, macOS, GTK and uses generic toast notifications under the other platforms. It's not recommended but <c>wxGenericNotificationMessage</c> can be used instead of the native ones. This might make sense if your application requires features not available in the native implementation.
       </p><p>Notice that this class is not a window and so doesn't derive from <seeerl marker="wxWindow"><c>wxWindow</c></seeerl>.
-      </p><p>Platform Notes</p> <p>Par: Up to Windows 8 balloon notifications are displayed from an icon in the notification area of the taskbar. If your application uses a <seeerl marker="wxTaskBarIcon"><c>wxTaskBarIcon</c></seeerl> you should call <c>UseTaskBarIcon()</c> (not implemented in wx) to ensure that only one icon is shown in the notification area. Windows 10 displays all notifications as popup toasts. To suppress the additional icon in the notification area on Windows 10 and for toast notification support on Windows 8 it is recommended to call <c>MSWUseToasts()</c> (not implemented in wx) before showing the first notification message.
+      </p><p>Platform Notes</p> <p>Par: Up to Windows 8 balloon notifications are displayed from an icon in the notification area of the taskbar. If your application uses a <seeerl marker="wxTaskBarIcon"><c>wxTaskBarIcon</c></seeerl> you should call <seemfa marker="#useTaskBarIcon/1"><c>useTaskBarIcon/1</c></seemfa> to ensure that only one icon is shown in the notification area. Windows 10 displays all notifications as popup toasts. To suppress the additional icon in the notification area on Windows 10 and for toast notification support on Windows 8 it is recommended to call <seemfa marker="#mSWUseToasts/1"><c>mSWUseToasts/1</c></seemfa> before showing the first notification message.
       </p><p>Par: The macOS implementation uses Notification Center to display native notifications. In order to use actions your notifications must use the alert style. This can be enabled by the user in system settings or by setting the <c>NSUserNotificationAlertStyle</c> value in Info.plist to <c>alert</c>. Please note that the user always has the option to change the notification style.
       </p><p>Since: 2.9.0 
       </p>
@@ -148,5 +148,30 @@
       </p><p>Return: false if an error occurred. 
       </p></desc>
   </func>
+  
+  <func>
+    <name name="useTaskBarIcon" arity="1" clause_i="1" since=""/>
+    <fsummary>If the application already uses a <c>wxTaskBarIcon</c>, it should be connected to notifications by using this method. </fsummary>
+    <desc><p>If the application already uses a <seeerl marker="wxTaskBarIcon"><c>wxTaskBarIcon</c></seeerl>, it should be connected to notifications by using this method. 
+      </p><p>This has no effect if toast notifications are used.
+      </p><p>Return: the task bar icon which was used previously (may be <c>NULL</c>)
+      </p><p>Only for:wxmsw</p></desc>
+  </func>
+  
+  <func>
+    <name name="mSWUseToasts" arity="0" clause_i="1" since=""/>
+    <fsummary>See: <c>mSWUseToasts/1</c></fsummary>
+  </func>
+  
+  <func>
+    <name name="mSWUseToasts" arity="1" clause_i="1" since=""/>
+    <fsummary>Enables toast notifications available since Windows 8 and suppresses the additional icon in the notification area on Windows 10. </fsummary>
+    <desc><p>Enables toast notifications available since Windows 8 and suppresses the additional icon in the notification area on Windows 10. 
+      </p><p>Toast notifications <c>require</c> a shortcut to the application in the start menu. The start menu shortcut needs to contain an Application User Model ID. It is recommended that the applications setup creates the shortcut and the application specifies the setup created shortcut in <c>shortcutPath</c>. A call to this method will verify (and if necessary modify) the shortcut before enabling toast notifications.
+      </p><p>Return: false if toast notifications could not be enabled.
+      </p><p>Only for:wxmsw</p><p>See: <c>wxAppConsole::SetAppName()</c> (not implemented in wx), <c>wxAppConsole::SetVendorName()</c> (not implemented in wx)
+      </p><p>Since: 3.1.0 
+      </p></desc>
+  </func>
   </funcs>
 </erlref>