nsIDaimPropertyList Interface Reference

Expose methods for acessing structured properties. More...

import "nsIDaimPropertyList.idl";

Inherits nsIDaimNotify.

List of all members.

Public Member Functions

PRUint32 open (in ACString uri, in ACString section)
void close (in PRUint32 key)
void loadProperties (in ACString uri)
void getSeq (in PRUint32 key, in ACString section)
void newSeq (in PRUint32 key, in ACString section)
void endSeq (in PRUint32 key)
PRBool nextSeq (in PRUint32 key)
void addSeq (in PRUint32 key)
void dump ()
void setProperty (in PRUint32 key, in ACString section, in ACString property, in ACString value)
void getPropertyList (in PRUint32 key, in ACString section, in ACString property, in nsIDaimStringList stringlist)
ACString getPropertyStr (in PRUint32 key, in ACString section, in ACString property)
PRUint32 getPropertyLong (in PRUint32 key, in ACString section, in ACString property)
void checkProperty (in PRUint32 key, in ACString section, in ACString property)


Detailed Description

Expose methods for acessing structured properties.

The PropertyList interface expose methods for accessing external or local ressources in structured way. Resources can be either external XML files or user-built ressources (in which case it is a "local" resources )

Properties are specified as a list of '/' separated sections which references a node in the resource.

Sequences can be specified, a sequence is a list of unnamed nodes that are sibling to a specific section.

Implemented by:


Member Function Documentation

void nsIDaimPropertyList::addSeq in PRUint32  key  ) 
 

addSeq

Add a new item to the sequence opened by GetSeq() or NewSeq()

void nsIDaimPropertyList::checkProperty in PRUint32  key,
in ACString  section,
in ACString  property
 

checkProperty

Check if the property exists or not.

Warning:
Subject to change

void nsIDaimPropertyList::close in PRUint32  key  ) 
 

close

Close the session initiated by the Open() method.

void nsIDaimPropertyList::dump  ) 
 

dump

void nsIDaimPropertyList::endSeq in PRUint32  key  ) 
 

endSeq

Terminate an acess to a sequence opened by GetSeq() or NewSeq()

void nsIDaimPropertyList::getPropertyList in PRUint32  key,
in ACString  section,
in ACString  property,
in nsIDaimStringList  stringlist
 

getPropertyList

PRUint32 nsIDaimPropertyList::getPropertyLong in PRUint32  key,
in ACString  section,
in ACString  property
 

getPropertyLong

Return a integer value associated to the property parameter. see getProperty() for parameters.

ACString nsIDaimPropertyList::getPropertyStr in PRUint32  key,
in ACString  section,
in ACString  property
 

getPropertyStr

Return a string value associated to the property parameter.

Parameters:
key the key returned by Open()
section the section (or node) you are interested in (can be null if already specified in Open().
property the name of the property.
Returns:
The string value of the property.

void nsIDaimPropertyList::getSeq in PRUint32  key,
in ACString  section
 

getSeq

Start a sequence at the section section Return false if there is no sequence associated to the specified section

void nsIDaimPropertyList::loadProperties in ACString  uri  ) 
 

loadProperties

void nsIDaimPropertyList::newSeq in PRUint32  key,
in ACString  section
 

newSeq

Create a new sequence associated to the section section. Note that the section will be created only if it does not already exists.

PRBool nsIDaimPropertyList::nextSeq in PRUint32  key  ) 
 

nextSeq

Move to the next item in a sequence

PRUint32 nsIDaimPropertyList::open in ACString  uri,
in ACString  section
 

open

Open a property list resource from located at uri

Parameters:
uri the name of the resource. See named_res for more infos on named resources.
section the section that you are interested in. Can be NULL if you plan to inspect muliple sections.
Returns:
An access key, this value should be used in subsequent call to methods that require a key as input parameter. The key should always be released with the Close() method.

void nsIDaimPropertyList::setProperty in PRUint32  key,
in ACString  section,
in ACString  property,
in ACString  value
 

setProperty


Generated on Tue May 23 17:31:48 2006 for Daim Library XPCOM Interfaces by  doxygen 1.4.6-NO