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