Methods' Details |
requestResourceActivation
- Description
- Request the activation of a resource.
The request is processed asynchronously. Notifications about
configuration changes are sent after this call returns.
- Parameter xResourceId
- The resource whose activation is requested.
- Parameter eMode
When eMode is REPLACE then, before adding the
resource activation to the request queue, similar resources
linked to the same anchor are removed. This makes it easer to
switch between resources whose activation is mutually exclusive.
For example, there can only be one view per pane, so before
activating a new view the old one has to be deactivated.
When eMode is ADD then the resource is requested
without further changes.
|
|
requestResourceDeactivation
void |
requestResourceDeactivation( |
[in] XResourceId |
xResourceId ); |
- Description
- Request the deactivation of a resource.
The request is processed asynchronously. Notifications about
configuration changes are sent after this call returns.
Requesting the deactivation
of a resource that is not active is not an error.
- Parameter xResourceId
- The resource whose deactivation is requested.
|
|
getResource
- Description
- Return the active resource specified by the given resource id.
- Parameter xResourceId
- A valid resource id. This should, but does not have to be, the
resource id of an active resource.
- Returns
- When the given resource id specifies an active resource then
that resource is returned. Otherwise an empty reference is
returned.
|
|
lock
- Description
- Lock the processing of configuration change requests.
This is only necessary when more than one change request is being
made in a row. It prevents an update being made (with all the visible UI
changes) before all change requests are being made.
Recursive lock() calls are recognized: the
configuration controller is locked while lock() was
called more often than unlock().
|
|
unlock
- Description
- Unlock the processing of configuration change requests.
When unlock() is called as many times as
lock() and the queue of configuration change
requests is not empty the configuration controller continues the
processing of the change requests. An update of the current
configuration will eventually being made.
|
|
update
- Description
- Explicitly request an update of the current configuration.
Call it when a resource is activated or deactivated
without the control and knowledge of the drawing framework. Calling
this method (from outside the drawing framework) should hardly every
be necessary.
|
|
getRequestedConfiguration
- Description
- Return a copy of the requested configuration.
Modifications to the returned configuration have no effect on the
drawing framework.
|
|
getCurrentConfiguration
- Description
- Return a copy of the current configuration.
Modifications to the returned configuration have no effect on the
drawing framework.
|
|
restoreConfiguration
- Description
- Replace the requested configuration with the given configuration and
schedule an update of the current configuration.
Together with the getCurrentConfiguration() and
getRequestedConfiguration() methods this
allows the saving and restoring of configurations. However, the
given configuration can have other origins then these methods.
The given configuration is transformed into a list of of change
requests so that the resulting requested configuration equals the
given configuration. This has the advantage that not only the
resource activations and deactivations but all configuration
changes are properly broadcasted.
Note that because of the configuration change notifications
listeners can make more configuration change requests, so that the
resulting requested configuration can be different from the given
configuration.
- Parameter xConfiguration
- This typically is a configuration that was obtained with an
earlier getRequestedConfiguration() call.
|
|
Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.
LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.
The Document Foundation acknowledges all community members, please find more info at our website.