offapi/com/sun/star/embed/XClassifiedObject.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 embed {
  23
  24 /** represents common functionality for embedded objects
  25  */
  26 published interface XClassifiedObject: com::sun::star::uno::XInterface
  27 {
  28     /** retrieves class ID of the object.
  29
  30         @return
  31             unique class ID of the object
  32      */
  33     sequence< byte > getClassID();
  34
  35     /** retrieves symbolic name for the object type to be used in UI.
  36
  37         @return
  38             the symbolic name for the object
  39      */
  40     string getClassName();
  41
  42     /** sets the class ID and symbolic name to an object.
  43
  44         @param aClassID
  45             the new class ID
  46
  47         @param sClassName
  48             the new symbolic name
  49
  50         @throws ::com::sun::star::lang::NoSupportException
  51             in case changing of class information is not allowed
  52      */
  53     void setClassInfo(  [in] sequence< byte > aClassID,
  54                         [in] string sClassName )
  55         raises( ::com::sun::star::lang::NoSupportException );
  56 };
  57
  58
  59 }; }; }; };
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */