Interface XImageManager

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

:: com :: sun :: star :: ui ::

interface XImageManager

Base Interfaces

XImageManager
┣ XUIConfigurationPersistence
┣ XUIConfiguration
┣ ::com::sun::star::lang::XComponent
┗ ::com::sun::star::lang::XInitialization

XUIConfigurationPersistence	Description provides access to persistence functions to load/store images data from a storage.
XUIConfiguration	Description provides functions to add and remove listeners for changes within an image manager. An image manager implementation notifies its listener whenever an image set has been changed, due to insert, remove or replace operations. To minimize the overhead for notifications an image manager places all inserted and/or replaced images into a single notify call. A container which implements ::com::sun::star::container::XNameAccess holds the information. The access key is a command URL and provides a ::com::sun::star::graphic::XGraphic. This container is placed into the ConfigurationEvent::Element. The image set which has been changed is put into the ConfigurationEvent::aInfo.
::com::sun::star::lang::XComponent	Description allows controlling or observing the lifetime of an imahge manager instance. The owner of the object may dispose of this object using ::com::sun::star::lang::XComponent::dispose().
::com::sun::star::lang::XInitialization	Description initializes an image manager instance. An image manager instance must be initialized using ::XInitialization::initialize before it can be used. The following property must be provided if the image manager is related to a module: ModuleIdentifierspecifies a string property which is the unique identifier of module. UserConfigStoragespecifies a ::com::sun::star::embed::XStorage property which provides access to the configuration storage of the module. UserRootCommitspecifies an optional ::com::sun::star::embed::XTransactedObject property which makes it possible to commit a root storage.

Description: specifies access functions to an images manager interface to add, replace and remove images assocations to command URLs.; An image manager controls a number of image sets which are specified by a ImageType.

Methods' Summary
reset	resets the image manager to default data.
getAllImageNames	retrieves the list of command URLs which have images associated.
hasImage	determines if a command URL has an associated image.
getImages	retrieves the associated images of command URLs.
replaceImages	replaces the associated images of command URLs.
removeImages	removes associated images to a command URL.
insertImages	inserts new image/command associations to a image manager.

Methods' Details

reset

void
reset();

Description: resets the image manager to default data.; This means that all user images of the instance will be removed.

getAllImageNames

sequence< string >
getAllImageNames(	[in] short	nImageType );

Description: retrieves the list of command URLs which have images associated.
Parameter nImageType: specifies the image type for this operation.
Returns: all command URLs within the images manager that have an image associated.

hasImage

boolean
hasImage(	[in] short	nImageType,
	[in] string	aCommandURL )
raises(	::com::sun::star::lang::IllegalArgumentException );

Description: determines if a command URL has an associated image.
Parameter nImageType: specifies the image type for this operation.
Parameter ResourceURL: a command URL that should be checked for an associated image.
Returns: true if an image is associated, otherwise false.

getImages

sequence< ::com::sun::star::graphic::XGraphic >
getImages(	[in] short	nImageType,
	[in] sequence< string >	aCommandURLSequence )
raises(	::com::sun::star::lang::IllegalArgumentException );

Description: retrieves the associated images of command URLs.
Parameter nImageType: specifies the image type for this association operation.
Parameter aCommandURLSequence: a sequence of command URLs for which the images are requested.
Returns: a sequence of graphics object which are associated with the provided command URLs. If an unknown command URL is provided or a command URL has no associated image a graphics object with an empty image is provided. If the sequence aCommandURLSequence contains an invalid command URL a ::com::sun::star::lang::IllegalArgumentException is thrown.

replaceImages

void
replaceImages(	[in] short	nImageType,
	[in] sequence< string >	aCommandURLSequence,
	[in] sequence< ::com::sun::star::graphic::XGraphic >	aGraphicsSequence )
raises(	::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IllegalAccessException );

Description: replaces the associated images of command URLs.
Parameter nImageType: specifies the image type for this association operation.
Parameter aCommandURLSequence: a sequence of command URLs for which images should be replaced.
Parameter aGraphicsSequence: a sequence of graphic objects which should replace the old images of the provided command URLs.
If a command URL cannot be found the replace call will be omitted. If aCommandURLSequence contains an invalid command URL a ::com::sun::star::lang::IllegalArgumentException is thrown. If the image manager is associated with a read-only configuration manager a ::com::sun::star::lang::IllegalAccessException is thrown.

removeImages

void
removeImages(	[in] short	nImageType,
	[in] sequence< string >	aResourceURLSequence )
raises(	::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IllegalAccessException );

Description: removes associated images to a command URL.
Parameter nImageType: specifies the image type for this association operation.
Parameter aCommandURLSequence: a sequence of command URLs for which the images should be removed.
If the aCommandURLSequence contains an invalid command URL a ::com::sun::star::lang::IllegalArgumentException is thrown. If the image manager is associated with a read-only configuration manager a ::com::sun::star::lang::IllegalAccessException is thrown.

insertImages

void
insertImages(	[in] short	nImageType,
	[in] sequence< string >	aCommandURLSequence,
	[in] sequence< ::com::sun::star::graphic::XGraphic >	aGraphicSequence )
raises(	::com::sun::star::container::ElementExistException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IllegalAccessException );

Description: inserts new image/command associations to a image manager.
Parameter nImageType: specifies the image type for this association operation.
Parameter aCommandURLSequence: a sequence of command URLs which specify which commands get an new image.
Parameter aGraphicSequence: a sequence of graphic objects which should be associated with the provided command URLs.
If an association is already present it is replaced. If aCommandURLSequence contains an invalid command URL a ::com::sun::star::lang::IllegalArgumentException is thrown. If the configuration manager is read-only a ::com::sun::star::lang::IllegalAccessException is thrown.

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous