1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_awt_XControl_idl__ 24cdf0e10cSrcweir#define __com_sun_star_awt_XControl_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_lang_XComponent_idl__ 27cdf0e10cSrcweir#include <com/sun/star/lang/XComponent.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 31cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_awt_XToolkit_idl__ 35cdf0e10cSrcweir#include <com/sun/star/awt/XToolkit.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_awt_XWindowPeer_idl__ 39cdf0e10cSrcweir#include <com/sun/star/awt/XWindowPeer.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_awt_XControlModel_idl__ 43cdf0e10cSrcweir#include <com/sun/star/awt/XControlModel.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir#ifndef __com_sun_star_awt_XView_idl__ 47cdf0e10cSrcweir#include <com/sun/star/awt/XView.idl> 48cdf0e10cSrcweir#endif 49cdf0e10cSrcweir 50cdf0e10cSrcweir 51cdf0e10cSrcweir//============================================================================= 52cdf0e10cSrcweir 53cdf0e10cSrcweir module com { module sun { module star { module awt { 54cdf0e10cSrcweir 55cdf0e10cSrcweir//============================================================================= 56cdf0e10cSrcweir 57cdf0e10cSrcweir/** identifies a control. 58cdf0e10cSrcweir 59cdf0e10cSrcweir <p>Implementations of this interface are abstract windows. 60cdf0e10cSrcweir The main reason to instantiate this implementation is to show the window 61cdf0e10cSrcweir on the screen. Before the window appears on the screen, the 62cdf0e10cSrcweir <member>XControl::createPeer</member> method must be called.</p> 63cdf0e10cSrcweir 64cdf0e10cSrcweir <p>If the implementation of the control does not distinguish 65cdf0e10cSrcweir between model, view and controller, it must allow to set 66cdf0e10cSrcweir a new XGraphics in the view, so that the control can be printed.</p> 67cdf0e10cSrcweir */ 68cdf0e10cSrcweirpublished interface XControl: com::sun::star::lang::XComponent 69cdf0e10cSrcweir{ 70cdf0e10cSrcweir //------------------------------------------------------------------------- 71cdf0e10cSrcweir 72cdf0e10cSrcweir /** sets the context of the control. 73cdf0e10cSrcweir */ 74cdf0e10cSrcweir [oneway] void setContext( [in] com::sun::star::uno::XInterface Context ); 75cdf0e10cSrcweir 76cdf0e10cSrcweir //------------------------------------------------------------------------- 77cdf0e10cSrcweir 78cdf0e10cSrcweir /** gets the context of the control. 79cdf0e10cSrcweir */ 80cdf0e10cSrcweir com::sun::star::uno::XInterface getContext(); 81cdf0e10cSrcweir 82cdf0e10cSrcweir //------------------------------------------------------------------------- 83cdf0e10cSrcweir 84cdf0e10cSrcweir /** creates a "child" window on the screen. 85cdf0e10cSrcweir 86cdf0e10cSrcweir <p>If the parent is NULL, then the desktop window of the toolkit 87cdf0e10cSrcweir is the parent.</p> 88cdf0e10cSrcweir */ 89cdf0e10cSrcweir [oneway] void createPeer( [in] com::sun::star::awt::XToolkit Toolkit, 90cdf0e10cSrcweir [in] com::sun::star::awt::XWindowPeer Parent ); 91cdf0e10cSrcweir 92cdf0e10cSrcweir //------------------------------------------------------------------------- 93cdf0e10cSrcweir 94cdf0e10cSrcweir /** returns the peer which was previously created or set. 95cdf0e10cSrcweir */ 96cdf0e10cSrcweir com::sun::star::awt::XWindowPeer getPeer(); 97cdf0e10cSrcweir 98cdf0e10cSrcweir //------------------------------------------------------------------------- 99cdf0e10cSrcweir 100cdf0e10cSrcweir /** sets a model for the control. 101cdf0e10cSrcweir */ 102cdf0e10cSrcweir boolean setModel( [in] com::sun::star::awt::XControlModel Model ); 103cdf0e10cSrcweir 104cdf0e10cSrcweir //------------------------------------------------------------------------- 105cdf0e10cSrcweir 106cdf0e10cSrcweir /** returns the model for this control. 107cdf0e10cSrcweir */ 108cdf0e10cSrcweir com::sun::star::awt::XControlModel getModel(); 109cdf0e10cSrcweir 110cdf0e10cSrcweir //------------------------------------------------------------------------- 111cdf0e10cSrcweir 112cdf0e10cSrcweir /** returns the view of this control. 113cdf0e10cSrcweir */ 114cdf0e10cSrcweir com::sun::star::awt::XView getView(); 115cdf0e10cSrcweir 116cdf0e10cSrcweir //------------------------------------------------------------------------- 117cdf0e10cSrcweir 118cdf0e10cSrcweir /** sets the design mode for use in a design editor. 119cdf0e10cSrcweir 120cdf0e10cSrcweir <p>Normally the control will be painted directly without a peer.</p> 121cdf0e10cSrcweir */ 122cdf0e10cSrcweir [oneway] void setDesignMode( [in] boolean bOn ); 123cdf0e10cSrcweir 124cdf0e10cSrcweir //------------------------------------------------------------------------- 125cdf0e10cSrcweir 126cdf0e10cSrcweir /** returns <true/> if the control is in design mode, <false/> otherwise. 127cdf0e10cSrcweir */ 128cdf0e10cSrcweir boolean isDesignMode(); 129cdf0e10cSrcweir 130cdf0e10cSrcweir //------------------------------------------------------------------------- 131cdf0e10cSrcweir 132cdf0e10cSrcweir /** returns <true/> if the control is transparent, <false/> otherwise. 133cdf0e10cSrcweir */ 134cdf0e10cSrcweir boolean isTransparent(); 135cdf0e10cSrcweir 136cdf0e10cSrcweir}; 137cdf0e10cSrcweir 138cdf0e10cSrcweir//============================================================================= 139cdf0e10cSrcweir 140cdf0e10cSrcweir}; }; }; }; 141cdf0e10cSrcweir 142cdf0e10cSrcweir#endif 143