15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2011 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_BROWSER_UI_APP_MODAL_DIALOGS_APP_MODAL_DIALOG_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_UI_APP_MODAL_DIALOGS_APP_MODAL_DIALOG_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 117d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles)#include "base/strings/string16.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "build/build_config.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NativeAppModalDialog; 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content { 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class WebContents; 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A controller+model base class for modal dialogs. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class AppModalDialog { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A union of data necessary to determine the type of message box to 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // show. 25a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) AppModalDialog(content::WebContents* web_contents, 26a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const base::string16& title); 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~AppModalDialog(); 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by the AppModalDialogQueue to show this dialog. 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ShowModalDialog(); 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by the AppModalDialogQueue to activate the dialog. 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ActivateModalDialog(); 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Closes the dialog if it is showing. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CloseModalDialog(); 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Completes dialog handling, shows next modal dialog from the queue. 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(beng): Get rid of this method. 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CompleteDialog(); 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 42a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) base::string16 title() const { return title_; } 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NativeAppModalDialog* native_dialog() const { return native_dialog_; } 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::WebContents* web_contents() const { return web_contents_; } 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates an implementation of NativeAppModalDialog and shows it. 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // When the native dialog is closed, the implementation of 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NativeAppModalDialog should call OnAccept or OnCancel to notify the 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // renderer of the user's action. The NativeAppModalDialog is also 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // expected to delete the AppModalDialog associated with it. 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CreateAndShowDialog(); 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the dialog is still valid. As dialogs are created they are 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // added to the AppModalDialogQueue. When the current modal dialog finishes 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and it's time to show the next dialog in the queue IsValid is invoked. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If IsValid returns false the dialog is deleted and not shown. 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool IsValid(); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Methods overridable by AppModalDialog subclasses: 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Invalidates the dialog, therefore causing it to not be shown when its turn 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to be shown comes around. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Invalidate(); 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Used only for testing. Returns whether the dialog is a JavaScript modal 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // dialog. 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool IsJavaScriptModalDialog(); 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden by subclasses to create the feature-specific native dialog box. 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual NativeAppModalDialog* CreateNativeDialog() = 0; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) private: 7490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) // Information about the message box is held in the following variables. 75a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) base::string16 title_; 7690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) 7790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) // True if CompleteDialog was called. 7890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) bool completed_; 7990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // False if the dialog should no longer be shown, e.g. because the underlying 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // tab navigated away while the dialog was queued. 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool valid_; 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The toolkit-specific implementation of the app modal dialog box. 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NativeAppModalDialog* native_dialog_; 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::WebContents* web_contents_; 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(AppModalDialog); 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_UI_APP_MODAL_DIALOGS_APP_MODAL_DIALOG_H_ 93