offapi/com/sun/star/drawing/XControlShape.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
  20
  21
  22  module com {  module sun {  module star {  module drawing {
  23
  24
  25 /** is implemented by a ControlShape to access the controls model.
  26
  27     @see com::sun::star::drawing::ControlShape
  28     @see com::sun::star::awt::UnoControlModel
  29 */
  30 published interface XControlShape: com::sun::star::drawing::XShape
  31 {
  32
  33     /** returns the control model of this Shape.
  34
  35         @return
  36             if there is already a control model assigned
  37             to this ControlShape, then it's returned.
  38             Otherwise you get an empty reference.
  39      */
  40     com::sun::star::awt::XControlModel getControl();
  41
  42
  43     /** sets the control model for this Shape.
  44
  45         @param xControl
  46             this will be the new control model that is
  47             displayed with this shape. You may change
  48             the model more than once during the lifetime
  49             of a ControlShape
  50
  51      */
  52     void setControl( [in] com::sun::star::awt::XControlModel xControl );
  53
  54 };
  55
  56
  57 }; }; }; };
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */