offapi/com/sun/star/awt/XControlContainer.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_XControlContainer_idl__
  29 #define __com_sun_star_awt_XControlContainer_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32
  33 #include <com/sun/star/awt/XControl.idl>
  34
  35
  36 //=============================================================================
  37
  38  module com {  module sun {  module star {  module awt {
  39
  40 //=============================================================================
  41
  42 /** Provides access to the controls within an
  43     <type>UnoControlContainer</type>.
  44  */
  45 published interface XControlContainer: com::sun::star::uno::XInterface
  46 {
  47     //-------------------------------------------------------------------------
  48
  49     /** sets the status text in the status bar of the container.
  50      */
  51     [oneway] void setStatusText( [in] string StatusText );
  52
  53     //-------------------------------------------------------------------------
  54
  55     /** returns all controls.
  56      */
  57     sequence<com::sun::star::awt::XControl> getControls();
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** returns the control with the specified name.
  62      */
  63     com::sun::star::awt::XControl getControl( [in] string aName );
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** adds the given control with the specified name to the container.
  68      */
  69     [oneway] void addControl( [in] string Name,
  70              [in] com::sun::star::awt::XControl Control );
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** removes the given control from the container.
  75      */
  76     [oneway] void removeControl( [in] com::sun::star::awt::XControl Control );
  77
  78 };
  79
  80 //=============================================================================
  81
  82 }; }; }; };
  83
  84 #endif
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */