1 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
2 : *
3 : * ***** BEGIN LICENSE BLOCK *****
4 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 : *
6 : * The contents of this file are subject to the Mozilla Public License Version
7 : * 1.1 (the "License"); you may not use this file except in compliance with
8 : * the License. You may obtain a copy of the License at
9 : * http://www.mozilla.org/MPL/
10 : *
11 : * Software distributed under the License is distributed on an "AS IS" basis,
12 : * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 : * for the specific language governing rights and limitations under the
14 : * License.
15 : *
16 : * The Original Code is the Mozilla browser.
17 : *
18 : * The Initial Developer of the Original Code is
19 : * Netscape Communications Corporation.
20 : * Portions created by the Initial Developer are Copyright (C) 1999
21 : * the Initial Developer. All Rights Reserved.
22 : *
23 : * Contributor(s):
24 : * Rod Spears <rods@netscape.com>
25 : * Stuart Parmenter <pavlov@netscape.com>
26 : * Dean Tessman <dean_tessman@hotmail.com>
27 : *
28 : * Alternatively, the contents of this file may be used under the terms of
29 : * either the GNU General Public License Version 2 or later (the "GPL"), or
30 : * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
31 : * in which case the provisions of the GPL or the LGPL are applicable instead
32 : * of those above. If you wish to allow use of your version of this file only
33 : * under the terms of either the GPL or the LGPL, and not to allow others to
34 : * use your version of this file under the terms of the MPL, indicate your
35 : * decision by deleting the provisions above and replace them with the notice
36 : * and other provisions required by the GPL or the LGPL. If you do not delete
37 : * the provisions above, a recipient may use your version of this file under
38 : * the terms of any one of the MPL, the GPL or the LGPL.
39 : *
40 : * ***** END LICENSE BLOCK ***** */
41 :
42 : #ifndef __nsIRollupListener_h__
43 : #define __nsIRollupListener_h__
44 :
45 : #include "nsTArray.h"
46 :
47 : class nsIContent;
48 : class nsIWidget;
49 :
50 1404 : class nsIRollupListener {
51 : public:
52 :
53 : /**
54 : * Notifies the object to rollup, optionally returning the node that
55 : * was just rolled up.
56 : *
57 : * aCount is the number of popups in a chain to close. If this is
58 : * PR_UINT32_MAX, then all popups are closed.
59 : * If aGetLastRolledUp is true, then return the last rolled up popup,
60 : * if this is supported.
61 : */
62 : virtual nsIContent* Rollup(PRUint32 aCount, bool aGetLastRolledUp = false) = 0;
63 :
64 : /**
65 : * Asks the RollupListener if it should rollup on mousevents
66 : */
67 : virtual bool ShouldRollupOnMouseWheelEvent() = 0;
68 :
69 : /**
70 : * Asks the RollupListener if it should rollup on mouse activate, eg. X-Mouse
71 : */
72 : virtual bool ShouldRollupOnMouseActivate() = 0;
73 :
74 : /*
75 : * Retrieve the widgets for open menus and store them in the array
76 : * aWidgetChain. The number of menus of the same type should be returned,
77 : * for example, if a context menu is open, return only the number of menus
78 : * that are part of the context menu chain. This allows closing up only
79 : * those menus in different situations. The returned value should be exactly
80 : * the same number of widgets added to aWidgetChain.
81 : */
82 : virtual PRUint32 GetSubmenuWidgetChain(nsTArray<nsIWidget*> *aWidgetChain) = 0;
83 : };
84 :
85 : #endif /* __nsIRollupListener_h__ */
|