offapi/com/sun/star/style/XStyle.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: XStyle.idl,v $
  10  * $Revision: 1.9 $
  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_style_XStyle_idl__
  31 #define __com_sun_star_style_XStyle_idl__
  32
  33 #ifndef __com_sun_star_container_XNamed_idl__
  34 #include <com/sun/star/container/XNamed.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  38 #include <com/sun/star/container/NoSuchElementException.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module style {
  45
  46 //=============================================================================
  47
  48 /** specifies a template for a style (aka style sheet).
  49  */
  50 published interface XStyle: com::sun::star::container::XNamed
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** identifies a style as defined by the user.
  55      */
  56     boolean isUserDefined();
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** @returns
  61                     <TRUE/> if this type is used in the document.
  62      */
  63     boolean isInUse();
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** @returns
  68                     the name of the parent style, probably empty.
  69      */
  70     string getParentStyle();
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** sets the name of the parent style.
  75      */
  76     void setParentStyle( [in] string aParentStyle )
  77             raises( com::sun::star::container::NoSuchElementException );
  78
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; };
  84
  85 /*=============================================================================
  86
  87 =============================================================================*/
  88 #endif