LibreOffice
LibreOffice 24.8 SDK API Reference
Loading...
Searching...
No Matches
LocalHierarchyBrowser Service Referencepublished

is a HierarchyBrowser, that browses a configuration database stored in the local file system. More...

import <LocalHierarchyBrowser.idl;

Inheritance diagram for LocalHierarchyBrowser:
HierarchyBrowser XJob XInterface

Included Services

service HierarchyBrowser
 allows browsing a configuration hierarchy for components.
 

Additional Inherited Members

- Exported Interfaces inherited from HierarchyBrowser
interface com::sun::star::task::XJob
 allows executing a scan of the repository
 
- Public Member Functions inherited from XJob
any execute ([in] sequence< com::sun::star::beans::NamedValue > Arguments) raises ( com::sun::star::lang::IllegalArgumentException , com::sun::star::uno::Exception )
 executes the job synchronously
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object.
 
void acquire ()
 increases the reference counter by one.
 
void release ()
 decreases the reference counter by one.
 

Detailed Description

is a HierarchyBrowser, that browses a configuration database stored in the local file system.

See also
com::sun::star::configuration::backend::LocalSingleBackend
Since
OOo 1.1.2

Exported Interfaces

◆ HierarchyBrowser

allows browsing a configuration hierarchy for components.

Either a schema repository or a layer directory can be browsed. Components can be retrieved either as component names or as file URLs.

The following additional arguments are supported for com::sun::star::task::XJob::execute():

SchemaDataUrl : string
Base directory to search for schema files. If this is specified, schema files will be browsed, so argument LayerDataUrl should not be specified.
LayerDataUrl : string
Base directory to search for layer files. If this is specified, layer files will be browsed, so argument SchemaDataUrl should not be specified.
FetchComponentNames : boolean
  • if TRUE components will be returned as component names,
  • if FALSE components will be returned as fileURLs,
  • if this argument is not provided, the default is to retrieve names when browsing schemas and URLs when browsing layers.

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