LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XModel2 Interface Reference

extends interface XModel. More...

import"XModel2.idl";

Inheritance diagram for XModel2:
XModel XComponent XInterface

Public Member Functions

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...
 
- 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 his 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 XModel.

The following functions are added:

Member Function Documentation

creates the default view instance for this model.

Effectively, this method is equivalent to calling createView() with the ViewName being "Default".

Parameters
Frameused to place the new created view there
Returns
the new view controller instance
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif one of the given parameter was wrong
com::sun::star::uno::Exceptionif creation of a new view failed by other reasons

creates a new view instance classified by the specified name and arguments.

The newly created controller must not be connected with the document and the frame. That is, you should neither call XFrame::setComponent(), nor XController::attachFrame(), nor XController::attachModel(), nor XModel::connectController(), not XModel::setCurrentController(). All of this is the responsibility of the caller, which will do it in the proper order.

Parameters
ViewNameclassified name of instance
Argumentsarguments used for creation
Frameused to place the new created view there
Returns
the new view controller instance
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif one of the given parameter was wrong
com::sun::star::uno::Exceptionif creation of a new view failed by other reasons
sequence< string > getAvailableViewControllerNames ( )

provides the available names of the factory to be used to create views.

The names are usually logical view names. The following names have a defined meaning, i.e. every concrete implementation which returns such a name must ensure it has the same meaning, and if a concrete implementation has a view with the given meaning, it must give it the name as defined here:

  • Default specifies the default view of the document.
  • Preview specifies a preview of the document. A minimal implementation of such a view is a Default view which is read-only.
  • PrintPreview specifies a print preview of the document.

Implementations of this interface might decide to support additional view names, which then are documented in the respective service descriptions.

See also
createView
Returns
a sequence of names of all supported views for this document.

provides list of all currently connected controller objects.

Please note: Because this interface will might be used inside multi threaded environments those list can contain still disposed items or it new added controller will be missing (if they was added after this enumeration was created).

Returns
list of controller objects. Enumeration can be empty but not NULL.

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