LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XController Interface Referencepublished

With this interface, components viewed in a Frame can serve events (by supplying dispatches). More...

import"XController.idl";

Inheritance diagram for XController:
XComponent XInterface PropertyBrowserController Controller StartModule XController2 XObjectInspector DataSourceBrowser QueryDesign RelationDesign TableDesign

Public Member Functions

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

Detailed Description

With this interface, components viewed in a Frame can serve events (by supplying dispatches).

See also
XFrame
com::sun::star::awt::XWindow
XModel
Developers Guide
OfficeDev - Component - Getting Frames, Controllers and Models from Each Other
OfficeDev - Controllers
OfficeDev - Frame-Controller-Model Paradigm in OpenOffice.org

Member Function Documentation

void attachFrame ( [in] XFrame  Frame)

is called to attach the controller with its managing frame.

Parameters
Framethe new owner frame of this controller
boolean attachModel ( [in] XModel  Model)

is called to attach the controller to a new model.

Parameters
Modelthe new model for this controller
Returns
TRUEif attach was successfully
FALSEotherwise
XFrame getFrame ( )

provides access to owner frame of this controller

Returns
the frame containing this controller.
XModel getModel ( )

provides access to currently attached model

Returns
the currently attached model.
any getViewData ( )

provides access to current view status

Returns
set of data that can be used to restore the current view status at later time by using XController::restoreViewData()
void restoreViewData ( [in] any  Data)

restores the view status using the data gotten from a previous call to XController::getViewData().

Parameters
Dataset of data to restore it
boolean suspend ( [in] boolean  Suspend)

is called to prepare the controller for closing the view

Parameters
SuspendTRUEforce the controller to suspend his work FALSEtry to reactivate the controller
Returns
TRUEif request was accepted and of course successfully finished
FALSEotherwise

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