Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

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

::com::sun::star::lang::XComponent
(referenced interface's summary:)
allows to exclicitly free resources and break cyclic references.
Description
identifies a control.

Implementations of this interface are abstract windows. The main reason to instantiate this implementation is to show the window on the screen. Before the window appears on the screen, the createPeer method must be called.

If the implementation of the control does not distinguish between model, view and controller, it must allow to set a new XGraphics in the view, so that the control can be printed.


Methods' Summary
setContext sets the context of the control.  
getContext gets the context of the control.  
createPeer creates a "child" window on the screen.  
getPeer returns the peer which was previously created or set.  
setModel sets a model for the control.  
getModel returns the model for this control.  
getView returns the view of this control.  
setDesignMode sets the design mode for use in a design editor.  
isDesignMode returns true if the control is in design mode, false otherwise.  
isTransparent returns true if the control is transparent, false otherwise.  
Methods' Details
setContext
[oneway] void
setContext( [in] ::com::sun::star::uno::XInterface  Context );

Description
sets the context of the control.
getContext
::com::sun::star::uno::XInterface
getContext();

Description
gets the context of the control.
createPeer
[oneway] void
createPeer( [in] XToolkit  Toolkit,
[in] 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
XWindowPeer
getPeer();

Description
returns the peer which was previously created or set.
setModel
boolean
setModel( [in] XControlModel  Model );

Description
sets a model for the control.
getModel
XControlModel
getModel();

Description
returns the model for this control.
getView
XView
getView();

Description
returns the view of this control.
setDesignMode
[oneway] void
setDesignMode( [in] boolean  bOn );

Description
sets the design mode for use in a design editor.

Normally the control will be painted directly without a peer.

isDesignMode
boolean
isDesignMode();

Description
returns true if the control is in design mode, false otherwise.
isTransparent
boolean
isTransparent();

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

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.