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

identifies a control. More...

import"XControl.idl";

Inheritance diagram for XControl:
XComponent XInterface UnoControl XUnoControlDialog FilterControl AnimatedImagesControl UnoControlGrid UnoControlTabPageContainer UnoControlButton UnoControlCheckBox UnoControlContainer UnoControlEdit UnoControlFixedHyperlink UnoControlFixedLine UnoControlFixedText UnoControlGroupBox UnoControlImageControl UnoControlListBox UnoControlProgressBar UnoControlRadioButton UnoControlRoadmap UnoControlScrollBar UnoControlSpinButton GridControl NavigationToolBar FrameControl ColumnDescriptorControl UnoControlDialog

Public Member Functions

void setContext ([in] com::sun::star::uno::XInterface Context)
 sets the context of the control. More...
 
com::sun::star::uno::XInterface getContext ()
 gets the context of the control. More...
 
void createPeer ([in] com::sun::star::awt::XToolkit Toolkit, [in] com::sun::star::awt::XWindowPeer Parent)
 creates a "child" window on the screen. More...
 
com::sun::star::awt::XWindowPeer getPeer ()
 returns the peer which was previously created or set. More...
 
boolean setModel ([in] com::sun::star::awt::XControlModel Model)
 sets a model for the control. More...
 
com::sun::star::awt::XControlModel getModel ()
 returns the model for this control. More...
 
com::sun::star::awt::XView getView ()
 returns the view of this control. More...
 
void setDesignMode ([in] boolean bOn)
 sets the design mode for use in a design editor. More...
 
boolean isDesignMode ()
 returns TRUE if the control is in design mode, FALSE otherwise. More...
 
boolean isTransparent ()
 returns TRUE if the control is transparent, FALSE otherwise. 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

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 XControl::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.

Member Function Documentation

void createPeer ( [in] com::sun::star::awt::XToolkit  Toolkit,
[in] com::sun::star::awt::XWindowPeer  Parent 
)

creates a "child" window on the screen.

If the parent is NULL, then the desktop window of the toolkit is the parent.

gets the context of the control.

returns the model for this control.

returns the peer which was previously created or set.

returns the view of this control.

boolean isDesignMode ( )

returns TRUE if the control is in design mode, FALSE otherwise.

boolean isTransparent ( )

returns TRUE if the control is transparent, FALSE otherwise.

void setContext ( [in] com::sun::star::uno::XInterface  Context)

sets the context of the control.

void setDesignMode ( [in] boolean  bOn)

sets the design mode for use in a design editor.

Normally the control will be painted directly without a peer.

boolean setModel ( [in] com::sun::star::awt::XControlModel  Model)

sets a model for the control.


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