Bug 1295914, improve the label of the button of folder picker, r=baku,mstange,karlt,jimm

--HG--
extra : rebase_source : 17d97b01d1e7d27b37369f46a6ea8854f9384f54

dom/html/HTMLInputElement.cpp

@@ -938,9 +938,14 @@ HTMLInputElement::InitFilePicker(FilePickerType aType)
 
   // Get Loc title
   nsXPIDLString title;
+  nsXPIDLString okButtonLabel;
   if (aType == FILE_PICKER_DIRECTORY) {
     nsContentUtils::GetLocalizedString(nsContentUtils::eFORMS_PROPERTIES,
                                        "DirectoryUpload", title);
+
+    nsContentUtils::GetLocalizedString(nsContentUtils::eFORMS_PROPERTIES,
+                                       "DirectoryPickerOkButtonLabel",
+                                       okButtonLabel);
   } else {
     nsContentUtils::GetLocalizedString(nsContentUtils::eFORMS_PROPERTIES,
                                        "FileUpload", title);
@@ -963,6 +968,10 @@ HTMLInputElement::InitFilePicker(FilePickerType aType)
   nsresult rv = filePicker->Init(win, title, mode);
   NS_ENSURE_SUCCESS(rv, rv);
 
+  if (!okButtonLabel.IsEmpty()) {
+    filePicker->SetOkButtonLabel(okButtonLabel);
+  }
+
   // Native directory pickers ignore file type filters, so we don't spend
   // cycles adding them for FILE_PICKER_DIRECTORY.
   if (HasAttr(kNameSpaceID_None, nsGkAtoms::accept) &&

dom/ipc/FilePickerParent.cpp

@@ -251,7 +251,8 @@ FilePickerParent::RecvOpen(const int16_t& aSelectedType,
                            const nsString& aDefaultExtension,
                            InfallibleTArray<nsString>&& aFilters,
                            InfallibleTArray<nsString>&& aFilterNames,
-                           const nsString& aDisplayDirectory)
+                           const nsString& aDisplayDirectory,
+                           const nsString& aOkButtonLabel)
 {
   if (!CreateFilePicker()) {
     Unused << Send__delete__(this, void_t(), nsIFilePicker::returnCancel);
@@ -267,6 +268,7 @@ FilePickerParent::RecvOpen(const int16_t& aSelectedType,
   mFilePicker->SetDefaultString(aDefaultFile);
   mFilePicker->SetDefaultExtension(aDefaultExtension);
   mFilePicker->SetFilterIndex(aSelectedType);
+  mFilePicker->SetOkButtonLabel(aOkButtonLabel);
 
   if (!aDisplayDirectory.IsEmpty()) {
     nsCOMPtr<nsIFile> localFile = do_CreateInstance(NS_LOCAL_FILE_CONTRACTID);

dom/ipc/FilePickerParent.h

@@ -51,7 +51,8 @@ class FilePickerParent : public PFilePickerParent
                         const nsString& aDefaultExtension,
                         InfallibleTArray<nsString>&& aFilters,
                         InfallibleTArray<nsString>&& aFilterNames,
-                        const nsString& aDisplayDirectory) override;
+                        const nsString& aDisplayDirectory,
+                        const nsString& aOkButtonLabel) override;
 
   virtual void ActorDestroy(ActorDestroyReason aWhy) override;
 

dom/ipc/PFilePicker.ipdl

@@ -36,7 +36,7 @@ protocol PFilePicker
 parent:
     async Open(int16_t selectedType, bool addToRecentDocs, nsString defaultFile,
                nsString defaultExtension, nsString[] filters, nsString[] filterNames,
-               nsString displayDirectory);
+               nsString displayDirectory, nsString okButtonLabel);
 
 child:
     async __delete__(MaybeInputData data, int16_t result);

dom/locales/en-US/chrome/layout/HtmlForm.properties

@@ -7,6 +7,7 @@ Submit=Submit Query
 Browse=Browse…
 FileUpload=File Upload
 DirectoryUpload=Select Folder to Upload
+DirectoryPickerOkButtonLabel=Upload
 # LOCALIZATION NOTE (IsIndexPromptWithSpace): The last character of the string 
 # should be a space (U+0020) in most locales. The prompt is followed by an 
 # input field. The space needs be escaped in the property file to avoid 

widget/cocoa/nsFilePicker.mm

@@ -565,6 +565,10 @@ nsFilePicker::SetDialogTitle(const nsString& inTitle, id aPanel)
 
   [aPanel setTitle:[NSString stringWithCharacters:(const unichar*)inTitle.get() length:inTitle.Length()]];
 
+  if (!mOkButtonLabel.IsEmpty()) {
+    [aPanel setPrompt:[NSString stringWithCharacters:(const unichar*)mOkButtonLabel.get() length:mOkButtonLabel.Length()]];
+  }
+
   NS_OBJC_END_TRY_ABORT_BLOCK;
 } 
 

widget/gtk/nsFilePicker.cpp

@@ -383,8 +383,16 @@ nsFilePicker::Open(nsIFilePickerShownCallback *aCallback)
     GTK_WINDOW(mParentWidget->GetNativeData(NS_NATIVE_SHELLWIDGET));
 
   GtkFileChooserAction action = GetGtkFileChooserAction(mMode);
-  const gchar *accept_button = (action == GTK_FILE_CHOOSER_ACTION_SAVE)
-                               ? GTK_STOCK_SAVE : GTK_STOCK_OPEN;
+
+  const gchar* accept_button;
+  NS_ConvertUTF16toUTF8 buttonLabel(mOkButtonLabel);
+  if (!mOkButtonLabel.IsEmpty()) {
+    accept_button = buttonLabel.get();
+  } else {
+    accept_button = (action == GTK_FILE_CHOOSER_ACTION_SAVE) ?
+                    GTK_STOCK_SAVE : GTK_STOCK_OPEN;
+  }
+
   GtkWidget *file_chooser =
       gtk_file_chooser_dialog_new(title, parent_widget, action,
                                   GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,

widget/nsBaseFilePicker.cpp

@@ -343,6 +343,20 @@ nsBaseFilePicker::GetMode(int16_t* aMode)
   return NS_OK;
 }
 
+NS_IMETHODIMP
+nsBaseFilePicker::SetOkButtonLabel(const nsAString& aLabel)
+{
+  mOkButtonLabel = aLabel;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsBaseFilePicker::GetOkButtonLabel(nsAString& aLabel)
+{
+  aLabel = mOkButtonLabel;
+  return NS_OK;
+}
+
 NS_IMETHODIMP
 nsBaseFilePicker::GetDomFileOrDirectory(nsISupports** aValue)
 {

widget/nsBaseFilePicker.h

@@ -12,6 +12,7 @@
 #include "nsISimpleEnumerator.h"
 #include "nsArrayEnumerator.h"
 #include "nsCOMPtr.h"
+#include "nsString.h"
 
 class nsPIDOMWindowOuter;
 class nsIWidget;
@@ -36,6 +37,8 @@ public:
   NS_IMETHOD GetAddToRecentDocs(bool *aFlag);
   NS_IMETHOD SetAddToRecentDocs(bool aFlag);
   NS_IMETHOD GetMode(int16_t *aMode);
+  NS_IMETHOD SetOkButtonLabel(const nsAString& aLabel);
+  NS_IMETHOD GetOkButtonLabel(nsAString& aLabel);
 
   NS_IMETHOD GetDomFileOrDirectory(nsISupports** aValue);
   NS_IMETHOD GetDomFileOrDirectoryEnumerator(nsISimpleEnumerator** aValue);
@@ -49,6 +52,7 @@ protected:
 
   nsCOMPtr<nsPIDOMWindowOuter> mParent;
   int16_t mMode;
+  nsString mOkButtonLabel;
 };
 
 #endif // nsBaseFilePicker_h__

widget/nsFilePickerProxy.cpp

@@ -137,7 +137,7 @@ nsFilePickerProxy::Open(nsIFilePickerShownCallback* aCallback)
   }
 
   SendOpen(mSelectedType, mAddToRecentDocs, mDefault, mDefaultExtension,
-           mFilters, mFilterNames, displayDirectory);
+           mFilters, mFilterNames, displayDirectory, mOkButtonLabel);
 
   return NS_OK;
 }

widget/nsIFilePicker.idl

@@ -184,4 +184,11 @@ interface nsIFilePicker : nsISupports
   * (one of the modeOpen et. al. constants specified above).
   */
   readonly attribute short mode;
+
+  /**
+   * If set to non-empty string, the nsIFilePicker implementation
+   * may use okButtonLabel as the label for the button the user uses to accept
+   * file selection.
+   */
+  attribute AString okButtonLabel;
 };

widget/windows/nsFilePicker.cpp

@@ -595,6 +595,11 @@ nsFilePicker::ShowFolderPicker(const nsString& aInitialDir, bool &aWasInitError)
  
   // initial strings
   dialog->SetTitle(mTitle.get());
+
+  if (!mOkButtonLabel.IsEmpty()) {
+    dialog->SetOkButtonLabel(mOkButtonLabel.get());
+  }
+
   if (!aInitialDir.IsEmpty()) {
     RefPtr<IShellItem> folder;
     if (SUCCEEDED(