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 ressource
- Parameter Arguments
- are optional arguments for that ressource
(see ::com::sun::star::document::MediaDescriptor)
- Returns
- true for success
false otherwise
|
|
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
- Description
- provides read acces on currently representation of the
::com::sun::star::document::MediaDescriptor
of this model which describes the model and his state
- Returns
- the arguments with which the model was originally created or
stored the last time.
|
|
connectController
[oneway] 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
[oneway] 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
[oneway] 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
[oneway] 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
- 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
- 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
- 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.
|
|
Copyright © 2012, 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.