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