1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_SHELL_DIALOGS_H_
#define CHROME_BROWSER_SHELL_DIALOGS_H_
#include <string>
#include <vector>
#include "base/file_path.h"
#include "base/gfx/native_widget_types.h"
#include "base/ref_counted.h"
#include "base/string16.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(gfx::NativeWindow owning_window) 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,
SELECT_OPEN_MULTI_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 |path|. |params| is contextual passed to
// SelectFile. |index| specifies the index of the filter passed to the
// the initial call to SelectFile.
virtual void FileSelected(const FilePath& path,
int index, void* params) = 0;
// Notifies the Listener that many files have been selected. The
// files are in |files|. |params| is contextual passed to SelectFile.
virtual void MultiFilesSelected(
const std::vector<FilePath>& files, void* params) {};
// 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 window 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.
// |filter| is a null (\0) separated list of alternating filter description
// and filters and terminated with two nulls.
// |filter_index| is the 1-based index into the filter list in |filter|.
// Specify 0 if you don't need filters, or if you only need the default
// (first filter) behavior.
// |owning_window| is the window the dialog is modal to, or NULL for a
// modeless dialog.
// |default_extension| is the default extension to add to the file if the
// user doesn't type one. This should NOT include the '.'. If you specify
// this you must also specify a filter.
// |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_window
// at a time (for obvious reasons).
virtual void SelectFile(Type type,
const string16& title,
const FilePath& default_path,
const std::wstring& filter,
int filter_index,
const FilePath::StringType& default_extension,
gfx::NativeWindow owning_window,
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 window until the dialog box is complete. The listener
// associated with this object will be notified when the selection is
// complete.
// |owning_window| 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_window
// at a time (for obvious reasons).
// TODO(beng): support specifying the default font selected in the list when
// the dialog appears.
virtual void SelectFont(gfx::NativeWindow owning_window,
void* params) = 0;
// Same as above - also support specifying the default font selected in the
// list when the dialog appears.
virtual void SelectFont(gfx::NativeWindow owning_window,
void* params,
const std::wstring& font_name,
int font_size) = 0;
};
#endif // CHROME_BROWSER_SHELL_DIALOGS_H_
|
