LibreOffice: com::sun::star::drawing::framework Module Reference

LibreOffice LibreOffice 7.6 SDK API Reference

Loading...
Searching...
No Matches
Classes | Enumerations
com::sun::star::drawing::framework Module Reference

The drawing framework is responsible for managing the resources used by the UI of the drawing applications. More...

## Classes
service | BasicPaneFactory
| The BasicPaneFactory is a resource factory that provides the panes used by the Draw and Impress applications. More...
service | BasicToolBarFactory
| The BasicToolBarFactory is a resource factory that provides (some of) the tool bars used by the Draw and Impress applications. More...
service | BasicViewFactory
| The BasicViewFactory is a view factory that provides the panes used by the Draw and Impress applications. More...
struct | ConfigurationChangeEvent
| Objects of this class are used for notifying changes of the configuration. More...
service | ResourceId
| The ResourceId service provides several constructors for resource ids. More...
struct | TabBarButton
| Descriptor of a tab bar button. More...
interface | XConfiguration
| A configuration describes the resources of an application like panes, views, and tool bars and their relationships that are currently active or are requested to be activated. More...
interface | XConfigurationChangeListener
| A listener for configuration changes is called when it has been registered at the configuration controller and a configuration change occurs. More...
interface | XConfigurationChangeRequest
| A single explicit request for a configuration change. More...
interface | XConfigurationController
| The configuration controller is responsible for the management of the set of active resources. More...
interface | XConfigurationControllerBroadcaster
| Manage the set of registered event listeners and the event notification for a configuration controller. More...
interface | XConfigurationControllerRequestQueue
| The request queue of the configuration controller handles requests for changes to the current configuration. More...
interface | XControllerManager
| The XControllerManager gives access to the controllers of the drawing framework. More...
interface | XModuleController
| The module controller is responsible for loading a module (ad-don, plugin, whatever the name) when it is first used. More...
interface | XPane
| A pane is an abstraction of a window and is one of the resources managed by the drawing framework. More...
interface | XPane2
| An extension of the XPane interface that adds support for a) showing and hiding the windows that internally belong to the pane and b) setting the accessibility object. More...
interface | XPaneBorderPainter
| Paint the border around a rectangular region, typically a pane. More...
interface | XRelocatableResource
| An optional interface that is implemented by resources that are relocatable to different anchors. More...
interface | XResource
| Base interface that provides functionality shared by all resource types of the drawing framework. More...
interface | XResourceFactory
| Factory and possibly cache for creating and releasing resources. More...
interface | XResourceFactoryManager
| The XResourceFactoryManager is part of the configuration controller and manages the set of registered resource factories. More...
interface | XResourceId
| A resource id uses a set of URLs to unambiguously specify a resource of the drawing framework. More...
interface | XTabBar
| UI control for the selection of views in a pane. More...
interface | XToolBar
| Abstraction of tool bars used by the drawing framework. More...
interface | XView
| A view in the drawing framework is any object that paints into a pane. More...

## Enumerations
enum | AnchorBindingMode { DIRECT , INDIRECT }
| This enum specifies how a resource is bound to an anchor. More...
enum | BorderType { INNER_BORDER , OUTER_BORDER , TOTAL_BORDER }
| See XPaneBorderPainter and its addBorder() and removeBorder() methods for an explanation of the border type and its values. More...
enum | ResourceActivationMode { ADD , REPLACE }
| The ResourceActivationMode specifies, for example for the com::sun::star::drawing::framework::XConfigurationController::requestResourceActivation(), whether a requested resource is to replace an existing resource of the same class or is to be activated additionally. More...

## Detailed Description

The drawing framework is responsible for managing the resources used by the UI of the drawing applications.

Draw/Impress user interface framework.

The set of active resources is represented by the com::sun::star::drawing::framework::XConfiguration.

The com::sun::star::drawing::framework::XControllerManager interface provides access to the sub controllers. It typically is implemented by the same class that implements the com::sun::star::frame::XController interface.

The configuration is managed by the com::sun::star::drawing::framework::XConfigurationController. It coordinates changes to the configuration made by the other sub controllers so that

- unnecessary ui updates (flickering) is avoided and
- and the configuration is always in a valid and meaningful state.

For more information please see the wiki page of the drawing framework.

## Enumeration Type Documentation

## ◆ AnchorBindingMode

enum AnchorBindingMode

This enum specifies how a resource is bound to an anchor.

This can be direct or indirect.

Example: Let r:a1:a2 denote a resource r which is bound to anchor a1:a2 which itself is a resource a1 bound to anchor a2. Then r:a1:a2 is bound directly to a1:a2 and indirectly to a2.

Enumerator
DIRECT |
INDIRECT |

## ◆ BorderType

enum BorderType

See XPaneBorderPainter and its addBorder() and removeBorder() methods for an explanation of the border type and its values.

Enumerator
INNER_BORDER |
OUTER_BORDER |
TOTAL_BORDER |

## ◆ ResourceActivationMode

enum ResourceActivationMode

The ResourceActivationMode specifies, for example for the com::sun::star::drawing::framework::XConfigurationController::requestResourceActivation(), whether a requested resource is to replace an existing resource of the same class or is to be activated additionally.

Enumerator
ADD | A resource is requested in addition to already existing ones. This is used for example for panes.
REPLACE | A resource is requested to replace an already existing one of the same class. This is used for example for views.