Public Member Functions | Public Attributes

fuelIBookmark Interface Reference

Interface representing a bookmark item. More...

import "fuelIApplication.idl";

Collaboration diagram for fuelIBookmark:

List of all members.

Public Member Functions

NS_SCRIPTABLE NS_IMETHOD GetId (PRInt64 *aId)=0
 The id of the bookmark.
NS_SCRIPTABLE NS_IMETHOD GetTitle (nsAString &aTitle)=0
 The title of the bookmark.
NS_SCRIPTABLE NS_IMETHOD SetTitle (const nsAString &aTitle)=0
NS_SCRIPTABLE NS_IMETHOD GetUri (nsIURI **aUri)=0
 The uri of the bookmark.
NS_SCRIPTABLE NS_IMETHOD SetUri (nsIURI *aUri)=0
NS_SCRIPTABLE NS_IMETHOD GetDescription (nsAString &aDescription)=0
 The description of the bookmark.
NS_SCRIPTABLE NS_IMETHOD SetDescription (const nsAString &aDescription)=0
NS_SCRIPTABLE NS_IMETHOD GetKeyword (nsAString &aKeyword)=0
 The keyword associated with the bookmark.
NS_SCRIPTABLE NS_IMETHOD SetKeyword (const nsAString &aKeyword)=0
NS_SCRIPTABLE NS_IMETHOD GetType (nsAString &aType)=0
 The type of the bookmark.
NS_SCRIPTABLE NS_IMETHOD GetParent (fuelIBookmarkFolder **aParent)=0
 The parent folder of the bookmark.
NS_SCRIPTABLE NS_IMETHOD SetParent (fuelIBookmarkFolder *aParent)=0
NS_SCRIPTABLE NS_IMETHOD GetAnnotations (fuelIAnnotations **aAnnotations)=0
 The annotations object for the bookmark.
NS_SCRIPTABLE NS_IMETHOD GetEvents (extIEvents **aEvents)=0
 The events object for the bookmark.
NS_SCRIPTABLE NS_IMETHOD Remove (void)=0
 Removes the item from the parent folder.
void remove ()
 Removes the item from the parent folder.

Public Attributes

readonly attribute long long id
 The id of the bookmark.
attribute AString title
 The title of the bookmark.
attribute nsIURI uri
 The uri of the bookmark.
attribute AString description
 The description of the bookmark.
attribute AString keyword
 The keyword associated with the bookmark.
readonly attribute AString type
 The type of the bookmark.
attribute fuelIBookmarkFolder parent
 The parent folder of the bookmark.
readonly attribute fuelIAnnotations annotations
 The annotations object for the bookmark.
readonly attribute extIEvents events
 The events object for the bookmark.

Detailed Description

Interface representing a bookmark item.


Member Function Documentation

NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::GetAnnotations ( fuelIAnnotations **  aAnnotations  )  [pure virtual]

The annotations object for the bookmark.

NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::GetDescription ( nsAString aDescription  )  [pure virtual]

The description of the bookmark.

NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::GetEvents ( extIEvents **  aEvents  )  [pure virtual]

The events object for the bookmark.

supports: "remove", "change", "visit", "move"

NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::GetId ( PRInt64 aId  )  [pure virtual]

The id of the bookmark.

NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::GetKeyword ( nsAString aKeyword  )  [pure virtual]

The keyword associated with the bookmark.

NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::GetParent ( fuelIBookmarkFolder **  aParent  )  [pure virtual]

The parent folder of the bookmark.

NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::GetTitle ( nsAString aTitle  )  [pure virtual]

The title of the bookmark.

NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::GetType ( nsAString aType  )  [pure virtual]

The type of the bookmark.

values: "bookmark", "separator"

NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::GetUri ( nsIURI **  aUri  )  [pure virtual]

The uri of the bookmark.

NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::Remove ( void   )  [pure virtual]

Removes the item from the parent folder.

Used to delete a bookmark or separator

void fuelIBookmark::remove (  ) 

Removes the item from the parent folder.

Used to delete a bookmark or separator

NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::SetDescription ( const nsAString aDescription  )  [pure virtual]
NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::SetKeyword ( const nsAString aKeyword  )  [pure virtual]
NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::SetParent ( fuelIBookmarkFolder aParent  )  [pure virtual]
NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::SetTitle ( const nsAString aTitle  )  [pure virtual]
NS_SCRIPTABLE NS_IMETHOD fuelIBookmark::SetUri ( nsIURI aUri  )  [pure virtual]

Member Data Documentation

The annotations object for the bookmark.

attribute AString fuelIBookmark::description

The description of the bookmark.

readonly attribute extIEvents fuelIBookmark::events

The events object for the bookmark.

supports: "remove", "change", "visit", "move"

readonly attribute long long fuelIBookmark::id

The id of the bookmark.

attribute AString fuelIBookmark::keyword

The keyword associated with the bookmark.

The parent folder of the bookmark.

attribute AString fuelIBookmark::title

The title of the bookmark.

readonly attribute AString fuelIBookmark::type

The type of the bookmark.

values: "bookmark", "separator"

The uri of the bookmark.


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