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
|
// Copyright (c) 2011 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 VIEWS_WINDOW_DIALOG_DELEGATE_H_
#define VIEWS_WINDOW_DIALOG_DELEGATE_H_
#pragma once
#include "base/string16.h"
#include "ui/base/accessibility/accessibility_types.h"
#include "ui/base/message_box_flags.h"
#include "views/widget/widget_delegate.h"
#include "views/window/dialog_client_view.h"
using ui::MessageBoxFlags;
namespace views {
class View;
///////////////////////////////////////////////////////////////////////////////
//
// DialogDelegate
//
// DialogDelegate is an interface implemented by objects that wish to show a
// dialog box Window. The window that is displayed uses this interface to
// determine how it should be displayed and notify the delegate object of
// certain events.
//
///////////////////////////////////////////////////////////////////////////////
class VIEWS_EXPORT DialogDelegate : public WidgetDelegate {
public:
virtual DialogDelegate* AsDialogDelegate();
// Returns a mask specifying which of the available DialogButtons are visible
// for the dialog. Note: If an OK button is provided, you should provide a
// CANCEL button. A dialog box with just an OK button is frowned upon and
// considered a very special case, so if you're planning on including one,
// you should reconsider, or beng says there will be stabbings.
//
// To use the extra button you need to override GetDialogButtons()
virtual int GetDialogButtons() const;
// Returns whether accelerators are enabled on the button. This is invoked
// when an accelerator is pressed, not at construction time. This
// returns true.
virtual bool AreAcceleratorsEnabled(
ui::MessageBoxFlags::DialogButton button);
// Returns the label of the specified DialogButton.
virtual string16 GetDialogButtonLabel(
ui::MessageBoxFlags::DialogButton button) const;
// Override this function if with a view which will be shown in the same
// row as the OK and CANCEL buttons but flush to the left and extending
// up to the buttons.
virtual View* GetExtraView();
// Returns whether the height of the extra view should be at least as tall as
// the buttons. The default (false) is to give the extra view it's preferred
// height. By returning true the height becomes
// max(extra_view preferred height, buttons preferred height).
virtual bool GetSizeExtraViewHeightToButtons();
// Returns the default dialog button. This should not be a mask as only
// one button should ever be the default button. Return
// ui::MessageBoxFlags::DIALOGBUTTON_NONE if there is no default. Default
// behavior is to return ui::MessageBoxFlags::DIALOGBUTTON_OK or
// ui::MessageBoxFlags::DIALOGBUTTON_CANCEL (in that order) if they are
// present, ui::MessageBoxFlags::DIALOGBUTTON_NONE otherwise.
virtual int GetDefaultDialogButton() const;
// Returns whether the specified dialog button is enabled.
virtual bool IsDialogButtonEnabled(
ui::MessageBoxFlags::DialogButton button) const;
// Returns whether the specified dialog button is visible.
virtual bool IsDialogButtonVisible(
ui::MessageBoxFlags::DialogButton button) const;
// For Dialog boxes, if there is a "Cancel" button, this is called when the
// user presses the "Cancel" button or the Close button on the window or
// in the system menu, or presses the Esc key. This function should return
// true if the window can be closed after it returns, or false if it must
// remain open.
virtual bool Cancel();
// For Dialog boxes, this is called when the user presses the "OK" button,
// or the Enter key. Can also be called on Esc key or close button
// presses if there is no "Cancel" button. This function should return
// true if the window can be closed after it returns, or false if it must
// remain open. If |window_closing| is true, it means that this handler is
// being called because the window is being closed (e.g. by Window::Close)
// and there is no Cancel handler, so Accept is being called instead.
virtual bool Accept(bool window_closing);
virtual bool Accept();
// Overridden from WindowDelegate:
virtual View* GetInitiallyFocusedView() OVERRIDE;
virtual ClientView* CreateClientView(Widget* widget) OVERRIDE;
// Called when the window has been closed.
virtual void OnClose() {}
// A helper for accessing the DialogClientView object contained by this
// delegate's Window.
const DialogClientView* GetDialogClientView() const;
DialogClientView* GetDialogClientView();
protected:
// Overridden from WindowDelegate:
virtual ui::AccessibilityTypes::Role GetAccessibleWindowRole() const OVERRIDE;
};
// A DialogDelegate implementation that is-a View. Used to override GetWidget()
// to call View's GetWidget() for the common case where a DialogDelegate
// implementation is-a View.
class VIEWS_EXPORT DialogDelegateView : public DialogDelegate,
public View {
public:
DialogDelegateView();
virtual ~DialogDelegateView();
// Overridden from DialogDelegate:
virtual Widget* GetWidget() OVERRIDE;
virtual const Widget* GetWidget() const OVERRIDE;
private:
DISALLOW_COPY_AND_ASSIGN(DialogDelegateView);
};
} // namespace views
#endif // VIEWS_WINDOW_DIALOG_DELEGATE_H_
|
