office-gobmx/offapi/com/sun/star/embed/XClassifiedObject.idl
Jens-Heiner Rechtien 52590ed1e5 INTEGRATION: CWS fwkbugfix02 (1.2.148); FILE MERGED
2004/03/25 09:15:41 mav 1.2.148.2: #116056# interfaces review
2004/03/22 10:14:30 mav 1.2.148.1: #115011# review idl files
2004-05-10 17:03:43 +00:00

120 lines
4.2 KiB
Text

/*************************************************************************
*
* $RCSfile: XClassifiedObject.idl,v $
*
* $Revision: 1.3 $
*
* last change: $Author: hr $ $Date: 2004-05-10 18:03:43 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_embed_XClassifiedObject_idl__
#define __com_sun_star_embed_XClassifiedObject_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_lang_NoSupportException_idl__
#include <com/sun/star/lang/NoSupportException.idl>
#endif
//============================================================================
module com { module sun { module star { module embed {
//============================================================================
/** represents common functionality for embedded objects
*/
interface XClassifiedObject: com::sun::star::uno::XInterface
{
// -----------------------------------------------------------------------
/** retrieves class ID of the object.
@return
unique class ID of the object
*/
sequence< byte > getClassID();
// -----------------------------------------------------------------------
/** retrieves symbolic name for the object type to be used in UI.
@return
the symbolic name for the object
*/
string getClassName();
// -----------------------------------------------------------------------
/** sets the class ID and symbolic name to an object.
@param aClassID
the new class ID
@param sClassName
the new symbolic name
@throws ::com::sun::star::lang::NoSupportException
in case changing of class information is not allowed
*/
void setClassInfo( [in] sequence< byte > aClassID,
[in] string sClassName )
raises( ::com::sun::star::lang::NoSupportException );
};
//=============================================================================
}; }; }; };
#endif