offapi/com/sun/star/style/XStyle.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_style_XStyle_idl__
  29 #define __com_sun_star_style_XStyle_idl__
  30
  31 #include <com/sun/star/container/XNamed.idl>
  32
  33 #include <com/sun/star/container/NoSuchElementException.idl>
  34
  35
  36 //=============================================================================
  37
  38  module com {  module sun {  module star {  module style {
  39
  40 //=============================================================================
  41
  42 /** specifies a template for a style (aka style sheet).
  43  */
  44 published interface XStyle: com::sun::star::container::XNamed
  45 {
  46     //-------------------------------------------------------------------------
  47
  48     /** identifies a style as defined by the user.
  49      */
  50     boolean isUserDefined();
  51
  52     //-------------------------------------------------------------------------
  53
  54     /** @returns
  55                     <TRUE/> if this type is used in the document.
  56      */
  57     boolean isInUse();
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** @returns
  62                     the name of the parent style, probably empty.
  63      */
  64     string getParentStyle();
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** sets the name of the parent style.
  69      */
  70     void setParentStyle( [in] string aParentStyle )
  71             raises( com::sun::star::container::NoSuchElementException );
  72
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 /*=============================================================================
  80
  81 =============================================================================*/
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */