Browse Source

rename all references to default_button_index -> default_id to keep consistent with cancel_id

leethomas 9 years ago
parent
commit
ae5c6add11

+ 3 - 3
atom/browser/api/atom_api_dialog.cc

@@ -41,7 +41,7 @@ namespace {
 
 void ShowMessageBox(int type,
                     const std::vector<std::string>& buttons,
-                    int default_button_index,
+                    int default_id,
                     int cancel_id,
                     int options,
                     const std::string& title,
@@ -56,11 +56,11 @@ void ShowMessageBox(int type,
                                                         peek,
                                                         &callback)) {
     atom::ShowMessageBox(window, (atom::MessageBoxType)type, buttons,
-                         default_button_index, cancel_id, options, title,
+                         default_id, cancel_id, options, title,
                         message, detail, icon, callback);
   } else {
     int chosen = atom::ShowMessageBox(window, (atom::MessageBoxType)type,
-                                      buttons, default_button_index, cancel_id,
+                                      buttons, default_id, cancel_id,
                                       options, title, message, detail, icon);
     args->Return(chosen);
   }

+ 2 - 2
atom/browser/api/lib/dialog.coffee

@@ -95,7 +95,7 @@ module.exports =
     options.message            ?= ''
     options.detail             ?= ''
     options.icon               ?= null
-    options.defaultButtonIndex ?= -1
+    options.defaultId ?= -1
 
     # Choose a default button to get selected when dialog is cancelled.
     unless options.cancelId?
@@ -109,7 +109,7 @@ module.exports =
 
     binding.showMessageBox messageBoxType,
                            options.buttons,
-                           options.defaultButtonIndex,
+                           options.defaultId,
                            options.cancelId,
                            flags,
                            options.title,

+ 2 - 2
atom/browser/ui/message_box.h

@@ -38,7 +38,7 @@ int ShowMessageBox(NativeWindow* parent_window,
                    MessageBoxType type,
                    const std::vector<std::string>& buttons,
                    int cancel_id,
-                   int default_button_index,
+                   int default_id,
                    int options,
                    const std::string& title,
                    const std::string& message,
@@ -48,7 +48,7 @@ int ShowMessageBox(NativeWindow* parent_window,
 void ShowMessageBox(NativeWindow* parent_window,
                     MessageBoxType type,
                     const std::vector<std::string>& buttons,
-                    int default_button_index,
+                    int default_id,
                     int cancel_id,
                     int options,
                     const std::string& title,

+ 6 - 6
atom/browser/ui/message_box_gtk.cc

@@ -29,7 +29,7 @@ class GtkMessageBox {
   GtkMessageBox(NativeWindow* parent_window,
                 MessageBoxType type,
                 const std::vector<std::string>& buttons,
-                int default_button_index,
+                int default_id,
                 int cancel_id,
                 const std::string& title,
                 const std::string& message,
@@ -61,7 +61,7 @@ class GtkMessageBox {
 
     // Add buttons.
     for (size_t i = 0; i < buttons.size(); ++i) {
-      if (i == (size_t)default_button_index) {
+      if (i == (size_t)default_id) {
         GtkWidget* button = gtk_dialog_add_button(GTK_DIALOG(dialog_),
                               TranslateToStock(i, buttons[i]),
                               i);
@@ -169,21 +169,21 @@ void GtkMessageBox::OnResponseDialog(GtkWidget* widget, int response) {
 int ShowMessageBox(NativeWindow* parent,
                    MessageBoxType type,
                    const std::vector<std::string>& buttons,
-                   int default_button_index,
+                   int default_id,
                    int cancel_id,
                    int options,
                    const std::string& title,
                    const std::string& message,
                    const std::string& detail,
                    const gfx::ImageSkia& icon) {
-  return GtkMessageBox(parent, type, buttons, default_button_index, cancel_id,
+  return GtkMessageBox(parent, type, buttons, default_id, cancel_id,
                       title, message, detail, icon).RunSynchronous();
 }
 
 void ShowMessageBox(NativeWindow* parent,
                     MessageBoxType type,
                     const std::vector<std::string>& buttons,
-                    int default_button_index,
+                    int default_id,
                     int cancel_id,
                     int options,
                     const std::string& title,
@@ -191,7 +191,7 @@ void ShowMessageBox(NativeWindow* parent,
                     const std::string& detail,
                     const gfx::ImageSkia& icon,
                     const MessageBoxCallback& callback) {
-  (new GtkMessageBox(parent, type, buttons, default_button_index, cancel_id,
+  (new GtkMessageBox(parent, type, buttons, default_id, cancel_id,
                     title, message, detail, icon))->RunAsynchronous(callback);
 }
 

+ 7 - 7
atom/browser/ui/message_box_mac.mm

@@ -54,7 +54,7 @@ namespace {
 NSAlert* CreateNSAlert(NativeWindow* parent_window,
                        MessageBoxType type,
                        const std::vector<std::string>& buttons,
-                       int default_button_index,
+                       int default_id,
                        const std::string& title,
                        const std::string& message,
                        const std::string& detail) {
@@ -83,8 +83,8 @@ NSAlert* CreateNSAlert(NativeWindow* parent_window,
     NSButton* button = [alert addButtonWithTitle:title];
     [button setTag:i];
 
-    if (i == (size_t)default_button_index) {
-      // focus the button at default_button_index if the user opted to do so.
+    if (i == (size_t)default_id) {
+      // focus the button at default_id if the user opted to do so.
       // The first button added gets set as the default selected.
       // So remove that default, and make the requested button the default
       [[[alert buttons] objectAtIndex:0] setKeyEquivalent:@""];
@@ -104,7 +104,7 @@ void SetReturnCode(int* ret_code, int result) {
 int ShowMessageBox(NativeWindow* parent_window,
                    MessageBoxType type,
                    const std::vector<std::string>& buttons,
-                   int default_button_index,
+                   int default_id,
                    int cancel_id,
                    int options,
                    const std::string& title,
@@ -112,7 +112,7 @@ int ShowMessageBox(NativeWindow* parent_window,
                    const std::string& detail,
                    const gfx::ImageSkia& icon) {
   NSAlert* alert = CreateNSAlert(
-      parent_window, type, buttons, default_button_index, title, message,
+      parent_window, type, buttons, default_id, title, message,
       detail);
 
   // Use runModal for synchronous alert without parent, since we don't have a
@@ -139,7 +139,7 @@ int ShowMessageBox(NativeWindow* parent_window,
 void ShowMessageBox(NativeWindow* parent_window,
                     MessageBoxType type,
                     const std::vector<std::string>& buttons,
-                    int default_button_index,
+                    int default_id,
                     int cancel_id,
                     int options,
                     const std::string& title,
@@ -148,7 +148,7 @@ void ShowMessageBox(NativeWindow* parent_window,
                     const gfx::ImageSkia& icon,
                     const MessageBoxCallback& callback) {
   NSAlert* alert = CreateNSAlert(
-      parent_window, type, buttons, default_button_index, title, message,
+      parent_window, type, buttons, default_id, title, message,
       detail);
   ModalDelegate* delegate = [[ModalDelegate alloc] initWithCallback:callback
                                                            andAlert:alert

+ 7 - 7
atom/browser/ui/message_box_win.cc

@@ -72,7 +72,7 @@ void MapToCommonID(const std::vector<base::string16>& buttons,
 int ShowMessageBoxUTF16(HWND parent,
                         MessageBoxType type,
                         const std::vector<base::string16>& buttons,
-                        int default_button_index,
+                        int default_id,
                         int cancel_id,
                         int options,
                         const base::string16& title,
@@ -157,7 +157,7 @@ void RunMessageBoxInNewThread(base::Thread* thread,
                               NativeWindow* parent,
                               MessageBoxType type,
                               const std::vector<std::string>& buttons,
-                              int default_button_index,
+                              int default_id,
                               int cancel_id,
                               int options,
                               const std::string& title,
@@ -165,7 +165,7 @@ void RunMessageBoxInNewThread(base::Thread* thread,
                               const std::string& detail,
                               const gfx::ImageSkia& icon,
                               const MessageBoxCallback& callback) {
-  int result = ShowMessageBox(parent, type, buttons, default_button_index,
+  int result = ShowMessageBox(parent, type, buttons, default_id,
                               cancel_id, options, title, message, detail, icon);
   content::BrowserThread::PostTask(
       content::BrowserThread::UI, FROM_HERE, base::Bind(callback, result));
@@ -178,7 +178,7 @@ void RunMessageBoxInNewThread(base::Thread* thread,
 int ShowMessageBox(NativeWindow* parent,
                    MessageBoxType type,
                    const std::vector<std::string>& buttons,
-                   int default_button_index,
+                   int default_id,
                    int cancel_id,
                    int options,
                    const std::string& title,
@@ -197,7 +197,7 @@ int ShowMessageBox(NativeWindow* parent,
   return ShowMessageBoxUTF16(hwnd_parent,
                              type,
                              utf16_buttons,
-                             default_button_index,
+                             default_id,
                              cancel_id,
                              options,
                              base::UTF8ToUTF16(title),
@@ -209,7 +209,7 @@ int ShowMessageBox(NativeWindow* parent,
 void ShowMessageBox(NativeWindow* parent,
                     MessageBoxType type,
                     const std::vector<std::string>& buttons,
-                    int default_button_index,
+                    int default_id,
                     int cancel_id,
                     int options,
                     const std::string& title,
@@ -229,7 +229,7 @@ void ShowMessageBox(NativeWindow* parent,
   unretained->message_loop()->PostTask(
       FROM_HERE,
       base::Bind(&RunMessageBoxInNewThread, base::Unretained(unretained),
-                 parent, type, buttons, default_button_index,
+                 parent, type, buttons, default_id,
                  cancel_id, options, title, message, detail, icon, callback));
 }
 

+ 1 - 1
docs/api/dialog.md

@@ -87,7 +87,7 @@ will be passed via `callback(filename)`
   `"warning"`. On Windows, "question" displays the same icon as "info", unless
   you set an icon using the "icon" option.
   * `buttons` Array - Array of texts for buttons.
-  * `defaultButtonIndex` Integer - Index of the button in the buttons array which will be selected by default when the message box opens.
+  * `defaultId` Integer - Index of the button in the buttons array which will be selected by default when the message box opens.
   * `title` String - Title of the message box, some platforms will not show it.
   * `message` String - Content of the message box.
   * `detail` String - Extra information of the message.