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

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