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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_XControlContainer_idl__
  20 #define __com_sun_star_awt_XControlContainer_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/awt/XControl.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module awt {
  29
  30
  31 /** Provides access to the controls within an
  32     <type>UnoControlContainer</type>.
  33  */
  34 published interface XControlContainer: com::sun::star::uno::XInterface
  35 {
  36
  37     /** sets the status text in the status bar of the container.
  38      */
  39     void setStatusText( [in] string StatusText );
  40
  41
  42     /** returns all controls.
  43      */
  44     sequence<com::sun::star::awt::XControl> getControls();
  45
  46
  47     /** returns the control with the specified name.
  48      */
  49     com::sun::star::awt::XControl getControl( [in] string aName );
  50
  51
  52     /** adds the given control with the specified name to the container.
  53      */
  54     void addControl( [in] string Name,
  55              [in] com::sun::star::awt::XControl Control );
  56
  57
  58     /** removes the given control from the container.
  59      */
  60     void removeControl( [in] com::sun::star::awt::XControl Control );
  61
  62 };
  63
  64
  65 }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */