LibreOffice
LibreOffice 7.4 SDK API Reference
Public Member Functions | List of all members
XModel3 Interface Reference

extends interface XModel2 with optimised read access getArgs(). More...

import"XModel3.idl";

Inheritance diagram for XModel3:
XModel2 XModel XComponent XInterface

Public Member Functions

sequence< com::sun::star::beans::PropertyValuegetArgs2 ([in] sequence< string > requestedArgs)
 Provides optimised read access (so we don't need to fetch expensive properties that we are not interested in) on currently representation of the com::sun::star::document::MediaDescriptor of this model which describes the model and its state. More...
 
- Public Member Functions inherited from XModel2
com::sun::star::container::XEnumeration getControllers ()
 provides list of all currently connected controller objects. More...
 
sequence< string > getAvailableViewControllerNames ()
 provides the available names of the factory to be used to create views. More...
 
com::sun::star::frame::XController2 createDefaultViewController ([in] com::sun::star::frame::XFrame Frame) raises (com::sun::star::lang::IllegalArgumentException, com::sun::star::uno::Exception )
 creates the default view instance for this model. More...
 
com::sun::star::frame::XController2 createViewController ([in] string ViewName, [in] sequence< com::sun::star::beans::PropertyValue > Arguments, [in] com::sun::star::frame::XFrame Frame) raises (com::sun::star::lang::IllegalArgumentException, com::sun::star::uno::Exception )
 creates a new view instance classified by the specified name and arguments. More...
 
void setArgs ([in] sequence< com::sun::star::beans::PropertyValue > Arguments) raises (com::sun::star::lang::IllegalArgumentException, com::sun::star::util::InvalidStateException)
 Sets com::sun::star::document::MediaDescriptor properties of the current model during runtime. More...
 
- Public Member Functions inherited from XModel
boolean attachResource ([in] string URL, [in] sequence< com::sun::star::beans::PropertyValue > Arguments)
 informs a model about its resource description. More...
 
string getURL ()
 provides information about the location of this model More...
 
sequence< com::sun::star::beans::PropertyValuegetArgs ()
 provides read access on currently representation of the com::sun::star::document::MediaDescriptor of this model which describes the model and its state More...
 
void connectController ([in] XController Controller)
 is called whenever a new controller is created for this model. More...
 
void disconnectController ([in] XController Controller)
 is called whenever an existing controller should be deregistered at this model. More...
 
void lockControllers ()
 suspends some notifications to the controllers which are used for display updates. More...
 
void unlockControllers ()
 resumes the notifications which were suspended by XModel::lockControllers(). More...
 
boolean hasControllersLocked ()
 determines if there is at least one lock remaining. More...
 
XController getCurrentController ()
 provides access to the controller which currently controls this model More...
 
void setCurrentController ([in] XController Controller) raises ( com::sun::star::container::NoSuchElementException )
 sets a registered controller as the current controller. More...
 
com::sun::star::uno::XInterface getCurrentSelection ()
 provides read access on current selection on controller More...
 
- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

extends interface XModel2 with optimised read access getArgs().

Member Function Documentation

◆ getArgs2()

sequence< com::sun::star::beans::PropertyValue > getArgs2 ( [in] sequence< string >  requestedArgs)

Provides optimised read access (so we don't need to fetch expensive properties that we are not interested in) on currently representation of the com::sun::star::document::MediaDescriptor of this model which describes the model and its state.

Returns only the selected args.

Parameters
requestedArgs
Returns
the requested and possibly some more arguments with which the model was originally created or stored the last time.

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