interface XControl in module com::sun::star::awt::

(Global Index)

Syntax

interface XControl : com::sun::star::lang::XComponent ;

Description

Implementations of this interface are abstract windows. The main reason to instanciate this implementation is to show it on a screen. A control has a context. Set the context with the "set context" method.
Before the window appears on a screen, the createPeer(...) must be called.
If the implementation of the control does not distinguish between model, view or controller, then it must allow you to set a new XGraphics in the view so you can print the control.

Method Summary

setContext sets the context for the control.

getContext gets the context which was previously set with setContext.

createPeer creates a "child" window on the screen. If the parent is NULL, then the desktop window of the toolkit is the parent.

getPeer returns the peer which was previously created or set.

setModel sets a model for the control. The control gets the persistent data from this interface and sets update links to the model data. The main interface to the model is the XPropertySet.

getModel returns the model for this control. The model allows access to data like "test," "font," etc. for the control. If there is no extra model, this method must return the "com::sun::star::uno::XInterface" from the control.

getView returns the view of this control.

setDesignMode sets the design mode for use in a design editor. Normally the control will be painted directly without a peer.

isDesignMode

isTransparent

Known Services Which Export this Interface

com::sun::star::awt::UnoControlContainer

com::sun::star::awt::UnoControl

Method Details



setContext

Syntax

oneway void setContext (
com::sun::star::uno::XInterface Context );

Description

sets the context for the control.


getContext

Syntax

com::sun::star::uno::XInterface getContext ();

Description

gets the context which was previously set with setContext.


createPeer

Syntax

oneway void createPeer (
com::sun::star::awt::XToolkit Toolkit,
com::sun::star::awt::XWindowPeer Parent );

Description

creates a "child" window on the screen. If the parent is NULL, then the desktop window of the toolkit is the parent.


getPeer

Syntax

com::sun::star::awt::XWindowPeer getPeer ();

Description

returns the peer which was previously created or set.


setModel

Syntax

boolean setModel (
com::sun::star::awt::XControlModel Model );

Description

sets a model for the control. The control gets the persistent data from this interface and sets update links to the model data. The main interface to the model is the XPropertySet.


getModel

Syntax

com::sun::star::awt::XControlModel getModel ();

Description

returns the model for this control. The model allows access to data like "test," "font," etc. for the control. If there is no extra model, this method must return the "com::sun::star::uno::XInterface" from the control.


getView

Syntax

com::sun::star::awt::XView getView ();

Description

returns the view of this control.


setDesignMode

Syntax

oneway void setDesignMode (
boolean bOn );

Description

sets the design mode for use in a design editor. Normally the control will be painted directly without a peer.


isDesignMode

Syntax

boolean isDesignMode ();

Returns

true if the control is in design mode, false otherwise.

isTransparent

Syntax

boolean isTransparent ();

Returns

true if the control is transparent, false otherwise.
Top of Page