diff options
Diffstat (limited to 'chrome/browser/shell_dialogs.h')
| -rw-r--r-- | chrome/browser/shell_dialogs.h | 159 |
1 files changed, 159 insertions, 0 deletions
diff --git a/chrome/browser/shell_dialogs.h b/chrome/browser/shell_dialogs.h new file mode 100644 index 0000000..8b11060 --- /dev/null +++ b/chrome/browser/shell_dialogs.h @@ -0,0 +1,159 @@ +// Copyright 2008, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +#ifndef CHROME_BROWSER_SHELL_DIALOGS_H__ +#define CHROME_BROWSER_SHELL_DIALOGS_H__ + +#include "base/ref_counted.h" + +class ChromeFont; + +// Helpers to show certain types of Windows shell dialogs in a way that doesn't +// block the UI of the entire app. + +// A base class for shell dialogs. +class BaseShellDialog { + public: + // Returns true if the a shell dialog box is currently being shown modally + // to the specified owner. + virtual bool IsRunning(HWND owning_hwnd) const = 0; + + // Notifies the dialog box that the listener has been destroyed and it should + // no longer be sent notifications. + virtual void ListenerDestroyed() = 0; +}; + +// Shows a dialog box for selecting a file or a folder. +class SelectFileDialog + : public base::RefCountedThreadSafe<SelectFileDialog>, + public BaseShellDialog { + public: + enum Type { + SELECT_FOLDER, + SELECT_SAVEAS_FILE, + SELECT_OPEN_FILE + }; + + virtual ~SelectFileDialog() {} + + // An interface implemented by a Listener object wishing to know about the + // the result of the Select File/Folder action. These callbacks must be + // re-entrant. + class Listener { + public: + // Notifies the Listener that a file/folder selection has been made. The + // file/folder path is in |selected_path|. |params| is contextual passed to + // SelectFile. + virtual void FileSelected(const std::wstring& path, void* params) = 0; + + // Notifies the Listener that the file/folder selection was aborted (via + // the user canceling or closing the selection dialog box, for example). + // |params| is contextual passed to SelectFile. + virtual void FileSelectionCanceled(void* params) {}; + }; + + // Creates a dialog box helper. This object is ref-counted, but the returned + // object will have no reference (refcount is 0). + static SelectFileDialog* Create(Listener* listener); + + // Selects a file. This will start displaying the dialog box. This will also + // block the calling HWND until the dialog box is complete. The listener + // associated with this object will be notified when the selection is + // complete. + // |type| is the type of file dialog to be shown, see Type enumeration above. + // |title| is the title to be displayed in the dialog. If this string is + // empty, the default title is used. + // |default_path| is the default path and suggested file name to be shown in + // the dialog. This only works for SELECT_SAVEAS_FILE and SELECT_OPEN_FILE. + // Can be an empty string to indicate Windows should choose the default to + // show. + // |owning_hwnd| is the window the dialog is modal to, or NULL for a modeless + // dialog. + // |params| is data from the calling context which will be passed through to + // the listener. Can be NULL. + // NOTE: only one instance of any shell dialog can be shown per owning_hwnd + // at a time (for obvious reasons). + virtual void SelectFile(Type type, + const std::wstring& title, + const std::wstring& default_path, + HWND owning_hwnd, + void* params) = 0; +}; + +// Shows a dialog box for selecting a font. +class SelectFontDialog + : public base::RefCountedThreadSafe<SelectFileDialog>, + public BaseShellDialog { + public: + virtual ~SelectFontDialog() {} + + // An interface implemented by a Listener object wishing to know about the + // the result of the Select Font action. These callbacks must be + // re-entrant. + class Listener { + public: + // Notifies the Listener that a font selection has been made. The font + // details are supplied in |font|. |params| is contextual passed to + // SelectFile. + virtual void FontSelected(const ChromeFont& font, void* params) = 0; + + // Notifies the Listener that the font selection was aborted (via the user + // canceling or closing the selection dialog box, for example). |params| is + // contextual passed to SelectFile. + virtual void FontSelectionCanceled(void* params) {}; + }; + + // Creates a dialog box helper. This object is ref-counted, but the returned + // object will have no reference (refcount is 0). + static SelectFontDialog* Create(Listener* listener); + + // Selects a font. This will start displaying the dialog box. This will also + // block the calling HWND until the dialog box is complete. The listener + // associated with this object will be notified when the selection is + // complete. + // |owning_hwnd| is the window the dialog is modal to, or NULL for a modeless + // dialog. + // |params| is data from the calling context which will be passed through to + // the listener. Can be NULL. + // NOTE: only one instance of any shell dialog can be shown per owning_hwnd + // at a time (for obvious reasons). + // TODO(beng): support specifying the default font selected in the list when + // the dialog appears. + virtual void SelectFont(HWND owning_hwnd, + void* params) = 0; + + // Same as above - also support specifying the default font selected in the + // list when the dialog appears. + virtual void SelectFont(HWND owning_hwnd, + void* params, + const std::wstring& font_name, + int font_size) = 0; +}; + +#endif // #ifndef CHROME_BROWSER_SHELL_DIALOGS_H__ |