Language Asturianu (ast) Català (ca) Čeština (cs) Dansk (da) Deutsch (de) English [US] (en-US) Español (es) Esperanto (eo) Eesti keel (et) Euskara (eu) Français (fr) Gàidhlig (gd) Galego (gl) Italiano (it) Lietuvių (lt) Magyar (hu) Nederlands (nl) Norsk (no) Polski (pl) Português [do Brasil] (pt-BR) Português [Europeu] (pt) Română (ro) Slovenčina (sk) Slovenščina (sl) Suomi (fi) Svenska (sv) Yкраїнська (uk) Tiếng Việt (vi) Türkçe (tr) ኦሮሚኛ (om) Հայերեն (hy) Ελληνικά (el) български език (bg) Русский (ru) Cрпски [ћирилицом] (sr) עברית (he) हिन्दी (hi) ភាសាខ្មែរ (km) தமிழ் (ta) ภาษาไทย (th) 简体中文 (zh-CN) 正體中文 (zh-TW) 日本語 (ja) 한국어 (ko)

The Free and Open Productivity Suite

• Product
• Download
• Support
• Blog
• Extensions & Templates
• Get Involved
• Focus Areas
• Native Languages

home » api » docs » common » ref » com » sun » star » awt

Overview

Module

Use

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

---

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

---

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

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

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