diff --git a/modules/juce_gui_basics/windows/juce_NativeMessageBox.h b/modules/juce_gui_basics/windows/juce_NativeMessageBox.h index 688fa6962d..8f2e0a7e3f 100644 --- a/modules/juce_gui_basics/windows/juce_NativeMessageBox.h +++ b/modules/juce_gui_basics/windows/juce_NativeMessageBox.h @@ -26,16 +26,16 @@ #ifndef __JUCE_NATIVEMESSAGEBOX_JUCEHEADER__ #define __JUCE_NATIVEMESSAGEBOX_JUCEHEADER__ +/** + This class contains some static methods for showing native alert windows. +*/ class NativeMessageBox { public: /** Shows a dialog box that just has a message and a single 'ok' button to close it. - If the callback parameter is null, the box is shown modally, and the method will - block until the user has clicked the button (or pressed the escape or return keys). - If the callback parameter is non-null, the box will be displayed and placed into a - modal state, but this method will return immediately, and the callback will be invoked - later when the user dismisses the box. + The box is shown modally, and the method will block until the user has clicked its + button (or pressed the escape or return keys). @param iconType the type of icon to show @param title the headline to show at the top of the box @@ -53,11 +53,8 @@ public: /** Shows a dialog box that just has a message and a single 'ok' button to close it. - If the callback parameter is null, the box is shown modally, and the method will - block until the user has clicked the button (or pressed the escape or return keys). - If the callback parameter is non-null, the box will be displayed and placed into a - modal state, but this method will return immediately, and the callback will be invoked - later when the user dismisses the box. + The box will be displayed and placed into a modal state, but this method will return + immediately, and the callback will be invoked later when the user dismisses the box. @param iconType the type of icon to show @param title the headline to show at the top of the box @@ -88,7 +85,7 @@ public: @param associatedComponent if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. - @param callback if this is non-null, the menu will be launched asynchronously, + @param callback if this is non-null, the box will be launched asynchronously, returning immediately, and the callback will receive a call to its modalStateFinished() when the box is dismissed, with its parameter being 1 if the ok button was pressed, or 0 for cancel, The callback object @@ -128,7 +125,7 @@ public: @param associatedComponent if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. - @param callback if this is non-null, the menu will be launched asynchronously, + @param callback if this is non-null, the box will be launched asynchronously, returning immediately, and the callback will receive a call to its modalStateFinished() when the box is dismissed, with its parameter being 1 if the "yes" button was pressed, 2 for the "no" button, or 0