offapi/com/sun/star/embed/XClassifiedObject.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_embed_XClassifiedObject_idl__
  28 #define __com_sun_star_embed_XClassifiedObject_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_lang_NoSupportException_idl__
  35 #include <com/sun/star/lang/NoSupportException.idl>
  36 #endif
  37
  38
  39 //============================================================================
  40
  41  module com {  module sun {  module star {  module embed {
  42
  43 //============================================================================
  44 /** represents common functionality for embedded objects
  45  */
  46 published interface XClassifiedObject: com::sun::star::uno::XInterface
  47 {
  48     // -----------------------------------------------------------------------
  49     /** retrieves class ID of the object.
  50
  51         @return
  52             unique class ID of the object
  53      */
  54     sequence< byte > getClassID();
  55
  56     // -----------------------------------------------------------------------
  57     /** retrieves symbolic name for the object type to be used in UI.
  58
  59         @return
  60             the symbolic name for the object
  61      */
  62     string getClassName();
  63
  64     // -----------------------------------------------------------------------
  65     /** sets the class ID and symbolic name to an object.
  66
  67         @param aClassID
  68             the new class ID
  69
  70         @param sClassName
  71             the new symbolic name
  72
  73         @throws ::com::sun::star::lang::NoSupportException
  74             in case changing of class information is not allowed
  75      */
  76     void setClassInfo(  [in] sequence< byte > aClassID,
  77                         [in] string sClassName )
  78         raises( ::com::sun::star::lang::NoSupportException );
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; };
  84
  85 #endif
  86