mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
240 lines
8.8 KiB
Plaintext
240 lines
8.8 KiB
Plaintext
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "nsISupports.idl"
|
|
#include "nsIObserver.idl"
|
|
|
|
interface nsIPrincipal;
|
|
interface nsIURI;
|
|
|
|
%{C++
|
|
#define ALERT_NOTIFICATION_CONTRACTID "@mozilla.org/alert-notification;1"
|
|
%}
|
|
|
|
[scriptable, uuid(1650a064-79d5-4eb6-8c9e-57dd6522b6ac)]
|
|
interface nsIAlertNotification : nsISupports
|
|
{
|
|
/** Initializes an alert notification. */
|
|
void init([optional] in AString name,
|
|
[optional] in AString imageURL,
|
|
[optional] in AString title,
|
|
[optional] in AString text,
|
|
[optional] in boolean textClickable,
|
|
[optional] in AString cookie,
|
|
[optional] in AString dir,
|
|
[optional] in AString lang,
|
|
[optional] in AString data,
|
|
[optional] in nsIPrincipal principal,
|
|
[optional] in boolean inPrivateBrowsing);
|
|
|
|
/**
|
|
* The name of the notification. On Android, the name is hashed and used as
|
|
* a notification ID. Notifications will replace previous notifications with
|
|
* the same name.
|
|
*/
|
|
readonly attribute AString name;
|
|
|
|
/**
|
|
* A URL identifying the image to put in the alert. The OS X backend limits
|
|
* the amount of time it will wait for the image to load to six seconds. After
|
|
* that time, the alert will show without an image.
|
|
*/
|
|
readonly attribute AString imageURL;
|
|
|
|
/** The title for the alert. */
|
|
readonly attribute AString title;
|
|
|
|
/** The contents of the alert. */
|
|
readonly attribute AString text;
|
|
|
|
/**
|
|
* Controls the click behavior. If true, the alert listener will be notified
|
|
* when the user clicks on the alert.
|
|
*/
|
|
readonly attribute boolean textClickable;
|
|
|
|
/**
|
|
* An opaque cookie that will be passed to the alert listener for each
|
|
* callback.
|
|
*/
|
|
readonly attribute AString cookie;
|
|
|
|
/**
|
|
* Bidi override for the title and contents. Valid values are "auto", "ltr",
|
|
* or "rtl". Ignored if the backend doesn't support localization.
|
|
*/
|
|
readonly attribute AString dir;
|
|
|
|
/**
|
|
* Language of the title and text. Ignored if the backend doesn't support
|
|
* localization.
|
|
*/
|
|
readonly attribute AString lang;
|
|
|
|
/**
|
|
* A Base64-encoded structured clone buffer containing data associated with
|
|
* this alert. Only used for web notifications. Chrome callers should use a
|
|
* cookie instead.
|
|
*/
|
|
readonly attribute AString data;
|
|
|
|
/**
|
|
* The principal of the page that created the alert. Used for IPC security
|
|
* checks, and to determine whether the alert is actionable.
|
|
*/
|
|
readonly attribute nsIPrincipal principal;
|
|
|
|
/**
|
|
* The URI of the page that created the alert. |null| if the alert is not
|
|
* actionable.
|
|
*/
|
|
readonly attribute nsIURI URI;
|
|
|
|
/**
|
|
* Controls the image loading behavior. If true, the image URL will be loaded
|
|
* in private browsing mode.
|
|
*/
|
|
readonly attribute boolean inPrivateBrowsing;
|
|
|
|
/**
|
|
* Indicates whether this alert should show the source string and action
|
|
* buttons. False for system alerts (which can omit the principal), or
|
|
* expanded, system, and null principals.
|
|
*/
|
|
readonly attribute boolean actionable;
|
|
|
|
/**
|
|
* The host and port of the originating page, or an empty string if the alert
|
|
* is not actionable.
|
|
*/
|
|
readonly attribute AString source;
|
|
};
|
|
|
|
[scriptable, uuid(f7a36392-d98b-4141-a7d7-4e46642684e3)]
|
|
interface nsIAlertsService : nsISupports
|
|
{
|
|
void showAlert(in nsIAlertNotification alert,
|
|
[optional] in nsIObserver alertListener);
|
|
/**
|
|
* Initializes and shows an |nsIAlertNotification| with the given parameters.
|
|
*
|
|
* @param alertListener Used for callbacks. May be null if the caller
|
|
* doesn't care about callbacks.
|
|
* @see nsIAlertNotification for descriptions of all other parameters.
|
|
* @throws NS_ERROR_NOT_AVAILABLE If the notification cannot be displayed.
|
|
*
|
|
* The following arguments will be passed to the alertListener's observe()
|
|
* method:
|
|
* subject - null
|
|
* topic - "alertfinished" when the alert goes away
|
|
* "alertdisablecallback" when alerts should be disabled for the principal
|
|
* "alertsettingscallback" when alert settings should be opened
|
|
* "alertclickcallback" when the text is clicked
|
|
* "alertshow" when the alert is shown
|
|
* data - the value of the cookie parameter passed to showAlertNotification.
|
|
*
|
|
* @note Depending on current circumstances (if the user's in a fullscreen
|
|
* application, for instance), the alert might not be displayed at all.
|
|
* In that case, if an alert listener is passed in it will receive the
|
|
* "alertfinished" notification immediately.
|
|
*/
|
|
void showAlertNotification(in AString imageUrl,
|
|
in AString title,
|
|
in AString text,
|
|
[optional] in boolean textClickable,
|
|
[optional] in AString cookie,
|
|
[optional] in nsIObserver alertListener,
|
|
[optional] in AString name,
|
|
[optional] in AString dir,
|
|
[optional] in AString lang,
|
|
[optional] in AString data,
|
|
[optional] in nsIPrincipal principal,
|
|
[optional] in boolean inPrivateBrowsing);
|
|
|
|
/**
|
|
* Close alerts created by the service.
|
|
*
|
|
* @param name The name of the notification to close. If no name
|
|
* is provided then only a notification created with
|
|
* no name (if any) will be closed.
|
|
*/
|
|
void closeAlert([optional] in AString name,
|
|
[optional] in nsIPrincipal principal);
|
|
|
|
};
|
|
|
|
[scriptable, uuid(c5d63e3a-259d-45a8-b964-8377967cb4d2)]
|
|
interface nsIAlertsDoNotDisturb : nsISupports
|
|
{
|
|
/**
|
|
* Toggles a manual Do Not Disturb mode for the service to reduce the amount
|
|
* of disruption that alerts cause the user.
|
|
* This may mean only displaying them in a notification tray/center or not
|
|
* displaying them at all. If a system backend already supports a similar
|
|
* feature controlled by the user, enabling this may not have any impact on
|
|
* code to show an alert. e.g. on OS X, the system will take care not
|
|
* disrupting a user if we simply create a notification like usual.
|
|
*/
|
|
attribute bool manualDoNotDisturb;
|
|
};
|
|
|
|
[scriptable, uuid(df1bd4b0-3a8c-40e6-806a-203f38b0bd9f)]
|
|
interface nsIAlertsProgressListener : nsISupports
|
|
{
|
|
/**
|
|
* Called to notify the alert service that progress has occurred for the
|
|
* given notification previously displayed with showAlertNotification().
|
|
*
|
|
* @param name The name of the notification displaying the
|
|
* progress. On Android the name is hashed and used
|
|
* as a notification ID.
|
|
* @param progress Numeric value in the range 0 to progressMax
|
|
* indicating the current progress.
|
|
* @param progressMax Numeric value indicating the maximum progress.
|
|
* @param text The contents of the alert. If not provided,
|
|
* the percentage will be displayed.
|
|
*/
|
|
void onProgress(in AString name,
|
|
in long long progress,
|
|
in long long progressMax,
|
|
[optional] in AString text);
|
|
|
|
/**
|
|
* Called to cancel and hide the given notification previously displayed
|
|
* with showAlertNotification().
|
|
*
|
|
* @param name The name of the notification.
|
|
*/
|
|
void onCancel(in AString name);
|
|
};
|
|
|
|
[scriptable, uuid(fc6d7f0a-0cf6-4268-8c71-ab640842b9b1)]
|
|
interface nsIAlertsIconData : nsISupports
|
|
{
|
|
/**
|
|
* Shows an alert with an icon. Web notifications use the favicon of the
|
|
* page that created the alert. If the favicon is not in the Places database,
|
|
* |iconSize| will be zero.
|
|
*/
|
|
void showAlertWithIconData(in nsIAlertNotification alert,
|
|
[optional] in nsIObserver alertListener,
|
|
[optional] in uint32_t iconSize,
|
|
[const, array, size_is(iconSize)] in uint8_t
|
|
iconData);
|
|
};
|
|
|
|
[scriptable, uuid(f3c82915-bf60-41ea-91ce-6c46b22e381a)]
|
|
interface nsIAlertsIconURI : nsISupports
|
|
{
|
|
/**
|
|
* Shows an alert with an icon URI. Web notifications use |moz-anno:|
|
|
* URIs to reference favicons from Places. If the page doesn't have a
|
|
* favicon, |iconURI| will be |null|.
|
|
*/
|
|
void showAlertWithIconURI(in nsIAlertNotification alert,
|
|
[optional] in nsIObserver alertListener,
|
|
[optional] in nsIURI iconURI);
|
|
};
|