Public Member Functions | Public Attributes

fuelIBookmarkFolder Interface Reference

Interface representing a bookmark folder. More...

import "fuelIApplication.idl";

Collaboration diagram for fuelIBookmarkFolder:

List of all members.

Public Member Functions

NS_SCRIPTABLE NS_IMETHOD GetId (PRInt64 *aId)=0
 Interface representing a bookmark folder.
NS_SCRIPTABLE NS_IMETHOD GetTitle (nsAString &aTitle)=0
 The title of the folder.
NS_SCRIPTABLE NS_IMETHOD SetTitle (const nsAString &aTitle)=0
NS_SCRIPTABLE NS_IMETHOD GetDescription (nsAString &aDescription)=0
 The description of the folder.
NS_SCRIPTABLE NS_IMETHOD SetDescription (const nsAString &aDescription)=0
NS_SCRIPTABLE NS_IMETHOD GetType (nsAString &aType)=0
 The type of the folder.
NS_SCRIPTABLE NS_IMETHOD GetParent (fuelIBookmarkFolder **aParent)=0
 The parent folder of the folder.
NS_SCRIPTABLE NS_IMETHOD SetParent (fuelIBookmarkFolder *aParent)=0
NS_SCRIPTABLE NS_IMETHOD GetAnnotations (fuelIAnnotations **aAnnotations)=0
 The annotations object for the folder.
NS_SCRIPTABLE NS_IMETHOD GetEvents (extIEvents **aEvents)=0
 The events object for the folder.
NS_SCRIPTABLE NS_IMETHOD GetChildren (nsIVariant **aChildren)=0
 Array of all bookmarks, separators and folders contained in this folder.
NS_SCRIPTABLE NS_IMETHOD AddBookmark (const nsAString &aTitle, nsIURI *aURI, fuelIBookmark **_retval NS_OUTPARAM)=0
 Adds a new child bookmark to this folder.
NS_SCRIPTABLE NS_IMETHOD AddSeparator (fuelIBookmark **_retval NS_OUTPARAM)=0
 Adds a new child separator to this folder.
NS_SCRIPTABLE NS_IMETHOD AddFolder (const nsAString &aTitle, fuelIBookmarkFolder **_retval NS_OUTPARAM)=0
 Adds a new child folder to this folder.
NS_SCRIPTABLE NS_IMETHOD Remove (void)=0
 Removes the folder from the parent folder.
fuelIBookmark addBookmark (in AString aTitle, in nsIURI aURI)
 Adds a new child bookmark to this folder.
fuelIBookmark addSeparator ()
 Adds a new child separator to this folder.
fuelIBookmarkFolder addFolder (in AString aTitle)
 Adds a new child folder to this folder.
void remove ()
 Removes the folder from the parent folder.

Public Attributes

readonly attribute long long id
 The id of the folder.
attribute AString title
 The title of the folder.
attribute AString description
 The description of the folder.
readonly attribute AString type
 The type of the folder.
attribute fuelIBookmarkFolder parent
 The parent folder of the folder.
readonly attribute fuelIAnnotations annotations
 The annotations object for the folder.
readonly attribute extIEvents events
 The events object for the folder.
readonly attribute nsIVariant children
 Array of all bookmarks, separators and folders contained in this folder.

Detailed Description

Interface representing a bookmark folder.

Folders can hold bookmarks, separators and other folders.


Member Function Documentation

NS_SCRIPTABLE NS_IMETHOD fuelIBookmarkFolder::AddBookmark ( const nsAString aTitle,
nsIURI aURI,
fuelIBookmark **_retval  NS_OUTPARAM 
) [pure virtual]

Adds a new child bookmark to this folder.

Parameters:
aTitle The title of bookmark.
aURI The uri of bookmark.
fuelIBookmark fuelIBookmarkFolder::addBookmark ( in AString  aTitle,
in nsIURI  aURI 
)

Adds a new child bookmark to this folder.

Parameters:
aTitle The title of bookmark.
aURI The uri of bookmark.
fuelIBookmarkFolder fuelIBookmarkFolder::addFolder ( in AString  aTitle  ) 

Adds a new child folder to this folder.

Parameters:
aTitle The title of folder.
NS_SCRIPTABLE NS_IMETHOD fuelIBookmarkFolder::AddFolder ( const nsAString aTitle,
fuelIBookmarkFolder **_retval  NS_OUTPARAM 
) [pure virtual]

Adds a new child folder to this folder.

Parameters:
aTitle The title of folder.
fuelIBookmark fuelIBookmarkFolder::addSeparator (  ) 

Adds a new child separator to this folder.

NS_SCRIPTABLE NS_IMETHOD fuelIBookmarkFolder::AddSeparator ( fuelIBookmark **_retval  NS_OUTPARAM  )  [pure virtual]

Adds a new child separator to this folder.

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

The annotations object for the folder.

NS_SCRIPTABLE NS_IMETHOD fuelIBookmarkFolder::GetChildren ( nsIVariant **  aChildren  )  [pure virtual]

Array of all bookmarks, separators and folders contained in this folder.

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

The description of the folder.

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

The events object for the folder.

supports: "add", "addchild", "remove", "removechild", "change", "move"

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

Interface representing a bookmark folder.

Folders can hold bookmarks, separators and other folders. The id of the folder.

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

The parent folder of the folder.

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

The title of the folder.

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

The type of the folder.

values: "folder"

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

Removes the folder from the parent folder.

void fuelIBookmarkFolder::remove (  ) 

Removes the folder from the parent folder.

NS_SCRIPTABLE NS_IMETHOD fuelIBookmarkFolder::SetDescription ( const nsAString aDescription  )  [pure virtual]
NS_SCRIPTABLE NS_IMETHOD fuelIBookmarkFolder::SetParent ( fuelIBookmarkFolder aParent  )  [pure virtual]
NS_SCRIPTABLE NS_IMETHOD fuelIBookmarkFolder::SetTitle ( const nsAString aTitle  )  [pure virtual]

Member Data Documentation

The annotations object for the folder.

Array of all bookmarks, separators and folders contained in this folder.

The description of the folder.

The events object for the folder.

supports: "add", "addchild", "remove", "removechild", "change", "move"

readonly attribute long long fuelIBookmarkFolder::id

The id of the folder.

The parent folder of the folder.

attribute AString fuelIBookmarkFolder::title

The title of the folder.

readonly attribute AString fuelIBookmarkFolder::type

The type of the folder.

values: "folder"


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