Interface representing a collection of annotations associated with a bookmark or bookmark folder. More...
import "fuelIApplication.idl";
Collaboration diagram for fuelIAnnotations:
Public Member Functions | |
| NS_SCRIPTABLE NS_IMETHOD | GetNames (nsIVariant **aNames)=0 |
| Array of the annotation names associated with the owning item. | |
| NS_SCRIPTABLE NS_IMETHOD | Has (const nsAString &aName, PRBool *_retval NS_OUTPARAM)=0 |
| Determines if an annotation exists with the given name. | |
| NS_SCRIPTABLE NS_IMETHOD | Get (const nsAString &aName, nsIVariant **_retval NS_OUTPARAM)=0 |
| Gets the value of an annotation with the given name. | |
| NS_SCRIPTABLE NS_IMETHOD | Set (const nsAString &aName, nsIVariant *aValue, PRInt32 aExpiration)=0 |
| Sets the value of an annotation with the given name. | |
| NS_SCRIPTABLE NS_IMETHOD | Remove (const nsAString &aName)=0 |
| Removes the named annotation from the owner item. | |
| boolean | has (in AString aName) |
| Determines if an annotation exists with the given name. | |
| nsIVariant | get (in AString aName) |
| Gets the value of an annotation with the given name. | |
| void | set (in AString aName, in nsIVariant aValue, in PRInt32 aExpiration) |
| Sets the value of an annotation with the given name. | |
| void | remove (in AString aName) |
| Removes the named annotation from the owner item. | |
Public Attributes | |
| readonly attribute nsIVariant | names |
| Array of the annotation names associated with the owning item. | |
Detailed Description
Interface representing a collection of annotations associated with a bookmark or bookmark folder.
Member Function Documentation
| NS_SCRIPTABLE NS_IMETHOD fuelIAnnotations::Get | ( | const nsAString & | aName, | |
| nsIVariant **_retval | NS_OUTPARAM | |||
| ) | [pure virtual] |
Gets the value of an annotation with the given name.
- Parameters:
-
aName The name of the annotation
- Returns:
- A variant containing the value of the annotation. Supports string, boolean and number.
| nsIVariant fuelIAnnotations::get | ( | in AString | aName | ) |
Gets the value of an annotation with the given name.
- Parameters:
-
aName The name of the annotation
- Returns:
- A variant containing the value of the annotation. Supports string, boolean and number.
| NS_SCRIPTABLE NS_IMETHOD fuelIAnnotations::GetNames | ( | nsIVariant ** | aNames | ) | [pure virtual] |
Array of the annotation names associated with the owning item.
| NS_SCRIPTABLE NS_IMETHOD fuelIAnnotations::Has | ( | const nsAString & | aName, | |
| PRBool *_retval | NS_OUTPARAM | |||
| ) | [pure virtual] |
Determines if an annotation exists with the given name.
- Parameters:
-
aName The name of the annotation
- Returns:
- true if an annotation exists with the given name, false otherwise.
| boolean fuelIAnnotations::has | ( | in AString | aName | ) |
Determines if an annotation exists with the given name.
- Parameters:
-
aName The name of the annotation
- Returns:
- true if an annotation exists with the given name, false otherwise.
| NS_SCRIPTABLE NS_IMETHOD fuelIAnnotations::Remove | ( | const nsAString & | aName | ) | [pure virtual] |
Removes the named annotation from the owner item.
- Parameters:
-
aName The name of annotation.
| void fuelIAnnotations::remove | ( | in AString | aName | ) |
Removes the named annotation from the owner item.
- Parameters:
-
aName The name of annotation.
| void fuelIAnnotations::set | ( | in AString | aName, | |
| in nsIVariant | aValue, | |||
| in PRInt32 | aExpiration | |||
| ) |
Sets the value of an annotation with the given name.
- Parameters:
-
aName The name of the annotation aValue The new value of the annotation. Supports string, boolean and number aExpiration The expiration policy for the annotation. See nsIAnnotationService.
| NS_SCRIPTABLE NS_IMETHOD fuelIAnnotations::Set | ( | const nsAString & | aName, | |
| nsIVariant * | aValue, | |||
| PRInt32 | aExpiration | |||
| ) | [pure virtual] |
Sets the value of an annotation with the given name.
- Parameters:
-
aName The name of the annotation aValue The new value of the annotation. Supports string, boolean and number aExpiration The expiration policy for the annotation. See nsIAnnotationService.
Member Data Documentation
| readonly attribute nsIVariant fuelIAnnotations::names |
Array of the annotation names associated with the owning item.
The documentation for this interface was generated from the following files:
