:: com :: sun :: star :: frame ::

interface XController
Base Interfaces
XController
┗ ::com::sun::star::lang::XComponent

::com::sun::star::lang::XComponent
(referenced interface's summary:)

Methods' Summary
attachFrame is called to attach the controller with its managing frame.  
attachModel is called to attach the controller to a new model.  
suspend is called to prepare the controller for closing the view  
getViewData provides access to current view status  
restoreViewData restores the view status using the data gotten from a previous call to XController::getViewData().  
getModel provides access to currently attached model  
getFrame provides access to owner frame of this controller  
Methods' Details
attachFrame
void
attachFrame( [in] XFrame  Frame );

Description
is called to attach the controller with its managing frame.
Parameter Frame
the new owner frame of this controller
attachModel
boolean
attachModel( [in] XModel  Model );

Description
is called to attach the controller to a new model.
Parameter Model
the new model for this controller
Returns
`TRUE` If attaching was successful
`FALSE` Otherwise
suspend
boolean
suspend( [in] boolean  Suspend );

Description
is called to prepare the controller for closing the view
Parameter Suspend
`TRUE` Force the controller to suspend his work `FALSE` Try to reactivate the controller
Returns
`TRUE` If request was accepted and successfully finished
`FALSE` Otherwise
getViewData
any
getViewData();

Description
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()
restoreViewData
void
restoreViewData( [in] any  Data );

Description
restores the view status using the data gotten from a previous call to XController::getViewData().
Parameter Data
set of data to restore it
getModel
XModel
getModel();

Description
provides access to currently attached model
Returns
the currently attached model.
getFrame
XFrame
getFrame();

Description
provides access to owner frame of this controller
Returns
the frame containing this controller.
Top of Page