LibreOffice LibreOffice 25.2 SDK API Reference

XPropertyState.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21
22module com { module sun { module star { module beans {
23
24
36published interface XPropertyState: com::sun::star::uno::XInterface
37{
38
48 com::sun::star::beans::PropertyState getPropertyState(
49 [in] string PropertyName )
50 raises( com::sun::star::beans::UnknownPropertyException );
51
52
66 sequence<com::sun::star::beans::PropertyState> getPropertyStates(
67 [in] sequence<string> aPropertyName )
68 raises( com::sun::star::beans::UnknownPropertyException );
69
70
85 void setPropertyToDefault( [in] string PropertyName )
86 raises( com::sun::star::beans::UnknownPropertyException );
87
88
106 any getPropertyDefault( [in] string aPropertyName )
107 raises( com::sun::star::beans::UnknownPropertyException,
108 com::sun::star::lang::WrappedTargetException );
109};
110
111
112}; }; }; };
113
114/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::UnknownPropertyException
This exception is thrown to indicate that the property name is unknown to the implementation.
Definition: UnknownPropertyException.idl:31
com::sun::star::lang::WrappedTargetException
This is a checked exception that wraps an exception thrown by the original target.
Definition: WrappedTargetException.idl:34
com::sun::star::beans::XPropertyState
makes it possible to query information about the state of one or more properties.
Definition: XPropertyState.idl:37
com::sun::star::beans::XPropertyState::getPropertyState
com::sun::star::beans::PropertyState getPropertyState([in] string PropertyName)
com::sun::star::beans::XPropertyState::getPropertyDefault
any getPropertyDefault([in] string aPropertyName)
com::sun::star::beans::XPropertyState::getPropertyStates
sequence< com::sun::star::beans::PropertyState > getPropertyStates([in] sequence< string > aPropertyName)
com::sun::star::beans::XPropertyState::setPropertyToDefault
void setPropertyToDefault([in] string PropertyName)
Sets the property to default value.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com::sun::star::beans::PropertyState
PropertyState
This enumeration lists the states that a property value can have.
Definition: PropertyState.idl:38
com
Definition: Ambiguous.idl:20