Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsISupportsPriority Interface Reference

This interface exposes the general notion of a scheduled object with a integral priority value. More...

import "nsISupportsPriority.idl";

Inheritance diagram for nsISupportsPriority:
Inheritance graph
[legend]
Collaboration diagram for nsISupportsPriority:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void adjustPriority (in long delta)
 This method adjusts the priority attribute by a given delta.

Public Attributes

const long PRIORITY_HIGHEST = -20
 Typical priority values.
const long PRIORITY_HIGH = -10
const long PRIORITY_NORMAL = 0
const long PRIORITY_LOW = 10
const long PRIORITY_LOWEST = 20
attribute long priority
 This attribute may be modified to change the priority of this object.

Detailed Description

This interface exposes the general notion of a scheduled object with a integral priority value.

Following UNIX conventions, smaller (and possibly negative) values have higher priority.

This interface does not strictly define what happens when the priority of an object is changed. An implementation of this interface is free to define the side-effects of changing the priority of an object. In some cases, changing the priority of an object may be disallowed (resulting in an exception being thrown) or may simply be ignored.

Definition at line 51 of file nsISupportsPriority.idl.


Member Function Documentation

This method adjusts the priority attribute by a given delta.

It helps reduce the amount of coding required to increment or decrement the value of the priority attribute.


Member Data Documentation

This attribute may be modified to change the priority of this object.

The implementation of this interface is free to truncate a given priority value to whatever limits are appropriate. Typically, this attribute is initialized to PRIORITY_NORMAL, but implementations may choose to assign a different initial value.

Definition at line 69 of file nsISupportsPriority.idl.

Definition at line 57 of file nsISupportsPriority.idl.

Typical priority values.

Definition at line 56 of file nsISupportsPriority.idl.

Definition at line 59 of file nsISupportsPriority.idl.

Definition at line 60 of file nsISupportsPriority.idl.

Definition at line 58 of file nsISupportsPriority.idl.


The documentation for this interface was generated from the following file: