xref: /aoo41x/main/offapi/com/sun/star/style/XStyle.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_style_XStyle_idl__
24#define __com_sun_star_style_XStyle_idl__
25
26#ifndef __com_sun_star_container_XNamed_idl__
27#include <com/sun/star/container/XNamed.idl>
28#endif
29
30#ifndef __com_sun_star_container_NoSuchElementException_idl__
31#include <com/sun/star/container/NoSuchElementException.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module style {
38
39//=============================================================================
40
41/** specifies a template for a style (aka style sheet).
42 */
43published interface XStyle: com::sun::star::container::XNamed
44{
45	//-------------------------------------------------------------------------
46
47	/** identifies a style as defined by the user.
48	 */
49	boolean isUserDefined();
50
51	//-------------------------------------------------------------------------
52
53	/** @returns
54					<TRUE/> if this type is used in the document.
55	 */
56	boolean isInUse();
57
58	//-------------------------------------------------------------------------
59
60	/** @returns
61					the name of the parent style, probably empty.
62	 */
63	string getParentStyle();
64
65	//-------------------------------------------------------------------------
66
67	/** sets the name of the parent style.
68	 */
69	void setParentStyle( [in] string aParentStyle )
70			raises( com::sun::star::container::NoSuchElementException );
71
72};
73
74//=============================================================================
75
76}; }; }; };
77
78/*=============================================================================
79
80=============================================================================*/
81#endif
82