This repository has been archived by the owner on Apr 10, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 305
/
nsIStandaloneNativeMenu.idl
88 lines (80 loc) · 3.27 KB
/
nsIStandaloneNativeMenu.idl
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
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Mac Dock Support
*
* The Initial Developer of the Original Code is
* Thomas K. Dyas <tdyas@zecador.org>.
* Portions created by the Initial Developer are Copyright (C) 2009
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
interface nsIDOMElement;
/**
* Platform-independent interface to platform native menu objects.
*/
[scriptable, uuid(7F7201EB-510C-4CEF-BDF0-04A15A7A4A8C)]
interface nsIStandaloneNativeMenu : nsISupports
{
/**
* Initialize the native menu using given XUL DOM element.
*
* @param aDOMElement A XUL DOM element of tag type |menu| or |menupopup|.
*/
void init(in nsIDOMElement aDOMElement);
/**
* This method must be called before the menu is opened and displayed to the
* user. It allows the platform code to update the menu and also determine
* whether the menu should even be shown.
*
* @return true if the menu can be shown, false if it should not be shown
*/
boolean menuWillOpen();
/**
* The native object representing the XUL menu that was passed to Init(). On
* Mac OS X, this will be a NSMenu pointer, which will be retained and
* autoreleased when the attribute is retrieved.
*/
[noscript] readonly attribute voidPtr nativeMenu;
/**
* Activate the native menu item specified by |anIndexString|. This method
* is intended to be used by the test suite.
*
* @param anIndexString string containing a list of indices separated by
* pipe ('|') characters
*/
void activateNativeMenuItemAt(in AString anIndexString);
/**
* Force an update of the native menu item specified by |anIndexString|. This
* method is intended to be used by the test suite.
*
* @param anIndexString string containing a list of indices separated by
* pipe ('|') characters
*/
void forceUpdateNativeMenuAt(in AString anIndexString);
};