blob: ddc180855f8b32d291b20b108e0ad742d8b20a7d [file] [log] [blame]
// Copyright (c) 2010 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.
#pragma once
#include <string>
#include "base/basictypes.h"
#include "build/build_config.h"
#include "chrome/common/notification_observer.h"
#include "chrome/common/notification_registrar.h"
class NativeAppModalDialog;
class TabContents;
// A controller+model base class for modal dialogs.
class AppModalDialog {
// A union of data necessary to determine the type of message box to
// show. |tab_contents| parameter is optional, if provided that tab will be
// activated before the modal dialog is displayed.
AppModalDialog(TabContents* tab_contents, const std::wstring& title);
virtual ~AppModalDialog();
// Called by the AppModalDialogQueue to show this dialog.
void ShowModalDialog();
// Called by the AppModalDialogQueue to activate the dialog.
void ActivateModalDialog();
// Closes the dialog if it is showing.
void CloseModalDialog();
// Completes dialog handling, shows next modal dialog from the queue.
// TODO(beng): Get rid of this method.
void CompleteDialog();
// Dialog window title.
std::wstring title() const { return title_; }
NativeAppModalDialog* native_dialog() const { return native_dialog_; }
// Methods overridable by AppModalDialog subclasses:
// Creates an implementation of NativeAppModalDialog and shows it.
// When the native dialog is closed, the implementation of
// NativeAppModalDialog should call OnAccept or OnCancel to notify the
// renderer of the user's action. The NativeAppModalDialog is also
// expected to delete the AppModalDialog associated with it.
virtual void CreateAndShowDialog();
// Returns true if the dialog is still valid. As dialogs are created they are
// added to the AppModalDialogQueue. When the current modal dialog finishes
// and it's time to show the next dialog in the queue IsValid is invoked.
// If IsValid returns false the dialog is deleted and not shown.
virtual bool IsValid();
// Overridden by subclasses to create the feature-specific native dialog box.
virtual NativeAppModalDialog* CreateNativeDialog() = 0;
// True if the dialog should no longer be shown, e.g. because the underlying
// tab navigated away while the dialog was queued.
bool skip_this_dialog_;
// Parent tab contents.
TabContents* tab_contents_;
// The toolkit-specific implementation of the app modal dialog box.
NativeAppModalDialog* native_dialog_;
// Information about the message box is held in the following variables.
std::wstring title_;