Interface XEmbeddedObject

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

:: com :: sun :: star :: embed ::

interface XEmbeddedObject

Base Interfaces

XEmbeddedObject
┣ XVisualObject
┣ XClassifiedObject
┣ XComponentSupplier
┣ XStateChangeBroadcaster
┣ ::com::sun::star::document::XEventBroadcaster
┗ ::com::sun::star::util::XCloseable
   ┗ ::com::sun::star::util::XCloseBroadcaster

XVisualObject	Description represents common visualisation functionality for embedded objects.
XClassifiedObject	Description allows to detect class ID of the object.
XComponentSupplier	Description allows to get access to the component handled by the object.
XStateChangeBroadcaster	Description allows to be notified when object changes the state.
::com::sun::star::document::XEventBroadcaster	Description allows to be notified about object related events.
::com::sun::star::util::XCloseable	Description allows to control lifetime of the object.

Description: represents common functionality for embedded objects.

Methods' Summary
changeState	changes the state of the object to the requested one.
getReachableStates	returns supported states for the object.
getCurrentState	returns the current state of the object.
doVerb	lets object perform an action referenced by nVerbID.
getSupportedVerbs	returns supported verbs for the object.
setClientSite	sets a connection to the container's client.
getClientSite	provides access to the internal link to the container client.
update	updates object's representations.
setUpdateMode	specifies how often the object's representation should be updated.
getStatus	retrieves the status of the object.
setContainerName	provides object with the name of container document.

Methods' Details

changeState

void
changeState(	[in] long	nNewState )
raises(	UnreachableStateException, WrongStateException, ::com::sun::star::uno::Exception );

Description: changes the state of the object to the requested one.
Parameter nNewState: specifies the new state, can take values from the constant set EmbedStates
Throws: com::sun::star::embed::UnreachableStateException the specified state can not be reached
Throws: com::sun::star::embed::WrongStateException in case object is in invalid state
Throws: com::sun::star::uno::Exception in case of other problems

getReachableStates

sequence< long >
getReachableStates()
raises(	NeedsRunningStateException, WrongStateException );

Description: returns supported states for the object.
Returns: the sequence of states the object can be set to
Throws: com::sun::star::embed::NeedsRunnignStateException means that the object is in loaded state now and can be switched to running state, other possible states can be detected only when the object is not in loaded state any more
Throws: com::sun::star::embed::WrongStateException in case object is in invalid state

getCurrentState

long
getCurrentState()
raises(	WrongStateException );

Description: returns the current state of the object.
Returns: the current state of the object
Throws: com::sun::star::embed::WrongStateException in case object is in invalid state

doVerb

void
doVerb(	[in] long	nVerbID )
raises(	::com::sun::star::lang::IllegalArgumentException, WrongStateException, UnreachableStateException, ::com::sun::star::uno::Exception );

Description: lets object perform an action referenced by nVerbID.
Parameter nVerbID: specifies an action to perform, can take values from EmbedVerbs
Throws: ::com::sun::star::lang::IllegalArgumentException the verb is not supported
Throws: com::sun::star::embed::WrongStateException the object is in wrong state to call the function
Throws: com::sun::star::embed::UnreachableStateException the state, required by the verb, can not be reached
Throws: com::sun::star::uno::Exception in case of other problems

getSupportedVerbs

sequence< VerbDescriptor >
getSupportedVerbs()
raises(	NeedsRunningStateException, WrongStateException );

Description: returns supported verbs for the object.
Returns: the sequence of verbs the object supports
Throws: com::sun::star::embed::NeedsRunnignStateException means that the object is in loaded state now and can be switched to running state, acceptable verbs can be detected only when the object is not in loaded state any more
Throws: com::sun::star::embed::WrongStateException the object is in wrong state to call the function

setClientSite

void
setClientSite(	[in] XEmbeddedClient	xClient )
raises(	WrongStateException );

Description: sets a connection to the container's client.
Parameter xClient: provides a reference to a client implementation
Throws: com::sun::star::embed::WrongStateException the object is in wrong state

getClientSite

XEmbeddedClient
getClientSite()
raises(	WrongStateException );

Description: provides access to the internal link to the container client.
Returns: a reference to related container client if any is set
Throws: com::sun::star::embed::WrongStateException the object is in wrong state

update

void
update()
raises(	WrongStateException, ::com::sun::star::uno::Exception );

Description: updates object's representations.
Throws: com::sun::star::embed::WrongStateException the object is in wrong state to call the function
Throws: com::sun::star::uno::Exception in case problems detected

setUpdateMode

void
setUpdateMode(	[in] long	nMode )
raises(	WrongStateException );

Description: specifies how often the object's representation should be updated.
Parameter nMode: the new update mode, can take values from ::EmbeddedUpdateModes
Throws: ::com::sun::star::embed::WrongStateException the object is in wrong state

getStatus

hyper
getStatus(	[in] hyper	nAspect )
raises(	WrongStateException );

Description: retrieves the status of the object.
Parameter nAspect: the aspect specifying the form of object representation
Returns: the value specifying the status of the object for specified aspect can take values from EmbedMisc constant set
Throws: com::sun::star::embed::WrongStateException the object is in wrong state

setContainerName

void
setContainerName(	[in] string	sName );

Description: provides object with the name of container document.
Parameter sName: name of the container document

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