:: com :: sun :: star :: frame ::

interface XModel
Base Interfaces
XModel
┗ ::com::sun::star::lang::XComponent

::com::sun::star::lang::XComponent
(referenced interface's summary:)

Methods' Summary
attachResource informs a model about its resource description.  
getURL provides information about the location of this model  
getArgs provides read access on currently representation of the com::sun::star::document::MediaDescriptor of this model which describes the model and its state  
connectController is called whenever a new controller is created for this model.  
disconnectController is called whenever an existing controller should be deregistered at this model.  
lockControllers suspends some notifications to the controllers which are used for display updates.  
unlockControllers resumes the notifications which were suspended by XModel::lockControllers().  
hasControllersLocked determines if there is at least one lock remaining.  
getCurrentController provides access to the controller which currently controls this model  
setCurrentController sets a registered controller as the current controller.  
getCurrentSelection provides read access on current selection on controller  
Methods' Details
attachResource
boolean
attachResource( [in] string  URL,
[in] sequence< ::com::sun::star::beans::PropertyValue >  Arguments );

Description
informs a model about its resource description.
Parameter URL
specifies the resource
Parameter Arguments
are optional arguments for that resource (see com::sun::star::document::MediaDescriptor)
Returns
`TRUE` for success
`FALSE` otherwise
getURL
string
getURL();

Description
provides information about the location of this model
Returns
the URL of the resource which is represented by this model.
See also
XStorable::getLocation()
getArgs
sequence< ::com::sun::star::beans::PropertyValue >
getArgs();

Description
provides read access on currently representation of the com::sun::star::document::MediaDescriptor of this model which describes the model and its state
Returns
the arguments with which the model was originally created or stored the last time.
connectController
void
connectController( [in] XController  Controller );

Description
is called whenever a new controller is created for this model.

The com::sun::star::lang::XComponent interface of the controller must be used to recognize when it is deleted.

Parameter Controller
a new controller for this model
See also
XModel::disconnectController()
disconnectController
void
disconnectController( [in] XController  Controller );

Description
is called whenever an existing controller should be deregistered at this model.

The com::sun::star::lang::XComponent interface of the controller must be used to recognize when it is deleted.

Parameter Controller
the existing controller which should be deregistered
See also
XModel::connectController()
lockControllers
void
lockControllers();

Description
suspends some notifications to the controllers which are used for display updates.

The calls to XModel::lockControllers() and XModel::unlockControllers() may be nested and even overlapping, but they must be in pairs. While there is at least one lock remaining, some notifications for display updates are not broadcasted.

unlockControllers
void
unlockControllers();

Description
resumes the notifications which were suspended by XModel::lockControllers().

The calls to XModel::lockControllers() and XModel::unlockControllers() may be nested and even overlapping, but they must be in pairs. While there is at least one lock remaining, some notifications for display updates are not broadcasted.

hasControllersLocked
boolean
hasControllersLocked();

Description
determines if there is at least one lock remaining.

While there is at least one lock remaining, some notifications for display updates are not broadcasted to the controllers.

Returns
`TRUE` if any lock exist
`FALSE` otherwise
getCurrentController
XController
getCurrentController();

Description
provides access to the controller which currently controls this model
Returns
If the controller which is active is a controller of this model, it will be returned. If not, the controller which was the last active of this model is returned. If no controller of this model ever was active, the controller first registered is returned. If no controller is registered for this model, `NULL` is returned.
setCurrentController
void
setCurrentController( [in] XController  Controller )
raises( ::com::sun::star::container::NoSuchElementException );

Description
sets a registered controller as the current controller.
Parameter Controller
reference to an already existing connected controller, which should be the new active one
Throws
com::sun::star::container::NoSuchElementException if xController isn't an already connected controller on this model
getCurrentSelection
::com::sun::star::uno::XInterface
getCurrentSelection();

Description
provides read access on current selection on controller
Returns
the current selection in the current controller. If there is no current controller, it returns `NULL`.
Top of Page