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