offapi/com/sun/star/awt/XControlContainer.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: XControlContainer.idl,v $
  10  * $Revision: 1.8 $
  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_awt_XControlContainer_idl__
  31 #define __com_sun_star_awt_XControlContainer_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XControl_idl__
  38 #include <com/sun/star/awt/XControl.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module awt {
  45
  46 //=============================================================================
  47
  48 /** Provides access to the controls within an
  49     <type>UnoControlContainer</type>.
  50  */
  51 published interface XControlContainer: com::sun::star::uno::XInterface
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     /** sets the status text in the status bar of the container.
  56      */
  57     [oneway] void setStatusText( [in] string StatusText );
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** returns all controls.
  62      */
  63     sequence<com::sun::star::awt::XControl> getControls();
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** returns the control with the specified name.
  68      */
  69     com::sun::star::awt::XControl getControl( [in] string aName );
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** adds the given control with the specified name to the container.
  74      */
  75     [oneway] void addControl( [in] string Name,
  76              [in] com::sun::star::awt::XControl Control );
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** removes the given control from the container.
  81      */
  82     [oneway] void removeControl( [in] com::sun::star::awt::XControl Control );
  83
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 #endif