LibreOffice: XController2 Interface Reference

LibreOffice LibreOffice 25.8 SDK API Reference

Loading...
Searching...
No Matches
XController2 Interface Reference

extends the XController interface More...

`import "XController2.idl";`

Inheritance diagram for XController2:

## Public Types
typedef sequence< ::com::sun::star::beans::PropertyValue > | CreationArguments
| denotes the arguments used to create the instance.

## Public Member Functions
::com::sun::star::ui::XSidebarProvider | getSidebar ()
| get the sidebar if exists
Public Member Functions inherited from XController
void | attachFrame ([in] XFrame Frame)
| is called to attach the controller with its managing frame.
boolean | attachModel ([in] XModel Model)
| is called to attach the controller to a new model.
boolean | suspend ([in] boolean Suspend)
| is called to prepare the controller for closing the view
any | getViewData ()
| provides access to current view status
void | restoreViewData ([in] any Data)
| restores the view status using the data gotten from a previous call to XController::getViewData().
XModel | getModel ()
| provides access to currently attached model
XFrame | getFrame ()
| provides access to owner frame of this controller
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.
void | addEventListener ([in] XEventListener xListener)
| adds an event listener to the object.
void | removeEventListener ([in] XEventListener aListener)
| removes an event listener from the listener list.
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object.
void | acquire ()
| increases the reference counter by one.
void | release ()
| decreases the reference counter by one.

## Public Attributes
::com::sun::star::awt::XWindow | ComponentWindow
| denotes the "root window" of the controller.
string | ViewControllerName
| specifies the view name of the controller.

## Detailed Description

extends the XController interface

Since
  OOo 3.0

## Member Typedef Documentation

## ◆ CreationArguments

sequence< ::com::sun::star::beans::PropertyValue > CreationArguments
| attributereadonly

denotes the arguments used to create the instance.

Usually, controllers are created via XModel2::createViewController(), where the caller can pass not only a controller name, but also arguments parameterizing the to-be-created instance. Those arguments used at creation time can subsequently be retrieved using the `CreationArguments` member.

## Member Function Documentation

## ◆ getSidebar()

::com::sun::star::ui::XSidebarProvider getSidebar | ( |  | ) |

get the sidebar if exists

Since
  LibreOffice 5.1

## Member Data Documentation

## ◆ ComponentWindow

::com::sun::star::awt::XWindow ComponentWindow
| attributereadonly

denotes the "root window" of the controller.

If the controller is plugged into a frame, this window acts as the frame's `ComponentWindow`.

See also
  XFrame

## ◆ ViewControllerName

string ViewControllerName
| attributereadonly

specifies the view name of the controller.

A view name is a logical name, which can be used to create views of the same type. The name is meaningful only in conjunction with XModel2::createViewController()

- if it's passed there, a view/controller pair of the same type will be created.

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

- com/sun/star/frame/XController2.idl