Public Member Functions | Public Attributes | List of all members
sbIDisplayPaneInstantiator Interface Reference

import"sbIDisplayPanes.idl";

Inheritance diagram for sbIDisplayPaneInstantiator:
[legend]
Collaboration diagram for sbIDisplayPaneInstantiator:
[legend]

Public Member Functions

void loadContent (in sbIDisplayPaneContentInfo aPane)
 
void hide ()
 

Public Attributes

readonly attribute AString contentGroup
 
readonly attribute AString contentUrl
 
readonly attribute AString contentTitle
 
readonly attribute AString contentIcon
 
readonly attribute nsIDOMWindow contentWindow
 
readonly attribute nsIDOMXULElement displayPane
 
attribute PRBool collapsed
 

Detailed Description

A display pane instantiator is a component that can render a display pane to the user. It is associated with a particular content group.

Definition at line 87 of file sbIDisplayPanes.idl.

Member Function Documentation

void sbIDisplayPaneInstantiator::hide ( )

hide the pane (the user must load new content to show the pane again)

void sbIDisplayPaneInstantiator::loadContent ( in sbIDisplayPaneContentInfo  aPane)

load the given content in the instantiator

Member Data Documentation

attribute PRBool sbIDisplayPaneInstantiator::collapsed

collapse the pane (the user can uncollapse without loading new content)

Definition at line 126 of file sbIDisplayPanes.idl.

readonly attribute AString sbIDisplayPaneInstantiator::contentGroup

the content group this display pane instantiator supports

Definition at line 92 of file sbIDisplayPanes.idl.

readonly attribute AString sbIDisplayPaneInstantiator::contentIcon

the icon of the currently displayed content

Definition at line 104 of file sbIDisplayPanes.idl.

readonly attribute AString sbIDisplayPaneInstantiator::contentTitle

the title of the currently displayed content

Definition at line 100 of file sbIDisplayPanes.idl.

readonly attribute AString sbIDisplayPaneInstantiator::contentUrl

the url of the currently displayed content

Definition at line 96 of file sbIDisplayPanes.idl.

readonly attribute nsIDOMWindow sbIDisplayPaneInstantiator::contentWindow

the currently displayed contents; may be null

Definition at line 108 of file sbIDisplayPanes.idl.

readonly attribute nsIDOMXULElement sbIDisplayPaneInstantiator::displayPane

the display pane this content is loaded into

Definition at line 113 of file sbIDisplayPanes.idl.

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