offapi/com/sun/star/drawing/XControlShape.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XControlShape.idl,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_drawing_XControlShape_idl__
  31 #define __com_sun_star_drawing_XControlShape_idl__
  32
  33 #ifndef __com_sun_star_drawing_XShape_idl__
  34 #include <com/sun/star/drawing/XShape.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XControlModel_idl__
  38 #include <com/sun/star/awt/XControlModel.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module drawing {
  45
  46 //=============================================================================
  47
  48 /** is implemented by a <type>ControlShape</type> to access the controls model.
  49
  50     @see com::sun::star::drawing::ControlShape
  51     @see com::sun::star::awt::UnoControlModel
  52 */
  53 published interface XControlShape: com::sun::star::drawing::XShape
  54 {
  55     //-------------------------------------------------------------------------
  56
  57     /** returns the control model of this <type>Shape</type>.
  58
  59         @return
  60             if there is already a control model assigned
  61             to this <type>ControlShape</type>, than its returned.
  62             Otherwise you get an empty reference.
  63      */
  64     com::sun::star::awt::XControlModel getControl();
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** sets the control model for this <type>Shape</type>.
  69
  70         @param xControl
  71             this will be the new control model that is
  72             displayed with this shape. You may change
  73             the model more than once during the lifetime
  74             of a <type>ControlShape</type>
  75
  76      */
  77     [oneway] void setControl( [in] com::sun::star::awt::XControlModel xControl );
  78
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; };
  84
  85 #endif
  86