diff options
Diffstat (limited to 'offapi/com/sun/star/awt/XControl.idl')
| -rw-r--r-- | offapi/com/sun/star/awt/XControl.idl | 229 |
1 files changed, 229 insertions, 0 deletions
diff --git a/offapi/com/sun/star/awt/XControl.idl b/offapi/com/sun/star/awt/XControl.idl new file mode 100644 index 000000000000..914a49f567f2 --- /dev/null +++ b/offapi/com/sun/star/awt/XControl.idl @@ -0,0 +1,229 @@ +/************************************************************************* + * + * $RCSfile: XControl.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:21:05 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_awt_XControl_idl__ +#define __com_sun_star_awt_XControl_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_awt_XToolkit_idl__ +#include <com/sun/star/awt/XToolkit.idl> +#endif + +#ifndef __com_sun_star_awt_XWindowPeer_idl__ +#include <com/sun/star/awt/XWindowPeer.idl> +#endif + +#ifndef __com_sun_star_awt_XControlModel_idl__ +#include <com/sun/star/awt/XControlModel.idl> +#endif + +#ifndef __com_sun_star_awt_XView_idl__ +#include <com/sun/star/awt/XView.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module awt { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::awt::XControl +/** Implementations of this interface are abstract windows. + + The main reason to instanciate this implementation is to show it + on a screen. A control has a context. Set the context with the + "set context" method.<br> + + Before the window appears on a screen, the createPeer(...) must + be called.<br> + + If the implementation of the control does not distinguish + between model, view or controller, then it must allow you to set + a new XGraphics in the view so you can print the control. + */ +[ uik(E227A468-33D6-11D1-AABE00A0-249D5590), ident( "XControl", 1.0 ) ] +interface XControl: com::sun::star::lang::XComponent +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::awt::XControl::setContext + /** sets the context for the control. + */ + [oneway] void setContext( [in] com::sun::star::uno::XInterface Context ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::awt::XControl::getContext + /** gets the context which was previously set with + setContext. + */ + [const] com::sun::star::uno::XInterface getContext(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::awt::XControl::createPeer + /** creates a "child" window on the screen. If the + parent is NULL, then the desktop window of the toolkit + is the parent. + */ + [oneway] void createPeer( [in] com::sun::star::awt::XToolkit Toolkit, + [in] com::sun::star::awt::XWindowPeer Parent ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::awt::XControl::getPeer + /** returns the peer which was previously created or set. + */ + [const] com::sun::star::awt::XWindowPeer getPeer(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::awt::XControl::setModel + /** sets a model for the control. The control gets + the persistent data from this interface and sets update + links to the model data. The main interface to the + model is the XPropertySet. + */ + boolean setModel( [in] com::sun::star::awt::XControlModel Model ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::awt::XControl::getModel + /** returns the model for this control. The model + allows access to data like "test," "font," etc. for the + control. If there is no extra model, this method must + return the "com::sun::star::uno::XInterface" from the control. + */ + [const] com::sun::star::awt::XControlModel getModel(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::awt::XControl::getView + /** returns the view of this control. + */ + [const] com::sun::star::awt::XView getView(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::awt::XControl::setDesignMode + /** sets the design mode for use in a design editor. + Normally the control will be painted directly without a peer. + */ + [oneway] void setDesignMode( [in] boolean bOn ); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::awt::XControl::isDesignMode + /** @returns + <true/> if the control is in design mode, + <false/> otherwise. + */ + boolean isDesignMode(); + + //------------------------------------------------------------------------- + + // DocMerge from idl: method com::sun::star::awt::XControl::isTransparent + /** @returns + <true/> if the control is transparent, + <false/> otherwise. + */ + boolean isTransparent(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.2 2000/10/09 14:24:53 mi + #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) + + Revision 1.1.1.1 2000/09/18 23:34:52 hjs + initial import + + Revision 1.6 2000/09/11 11:52:08 mi + documentation merged from XML + + Revision 1.4 2000/05/16 12:19:52 mi + documentation + + Revision 1.3 2000/02/07 11:24:15 mi + zu #70728# missing documentation marked + + Revision 1.2 1999/11/18 11:49:54 mi + XComponent now in module lang + + Revision 1.1.1.1 1999/11/11 09:48:40 jsc + new + + +=============================================================================*/ +#endif |