nsISupportsPriority

IID:aa578b44-abd5-4c19-8b14-36d4de6fdc36
Inherits From:nsISupports

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.


Constants

Typical priority values.
PRInt32 PRIORITY_HIGHEST = -20
PRInt32 PRIORITY_HIGH = -10
PRInt32 PRIORITY_NORMAL = 0
PRInt32 PRIORITY_LOW = 10
PRInt32 PRIORITY_LOWEST = 20

Properties

PRInt32 priority

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.


Methods

void adjustPriority ( PRInt32 delta )

void adjustPriority ( PRInt32 delta )

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.

Arguments:
delta

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com