LibreOffice LibreOffice 25.8 SDK API Reference

XPropertyHandler.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
20module com { module sun { module star { module inspection {
21
22 interface XObjectInspectorUI;
23 interface XPropertyControlFactory;
24
38 interface XPropertyHandler
39{
46 interface com::sun::star::lang::XComponent;
47
54 void inspect( [in] com::sun::star::uno::XInterface Component )
55 raises( com::sun::star::lang::NullPointerException );
56
63 any
64 getPropertyValue( [in] string PropertyName )
65 raises (::com::sun::star::beans::UnknownPropertyException);
66
76 void
77 setPropertyValue( [in] string PropertyName, [in] any Value )
78 raises (::com::sun::star::beans::UnknownPropertyException,
79 ::com::sun::star::beans::PropertyVetoException);
80
88 com::sun::star::beans::PropertyState
89 getPropertyState( [in] string PropertyName )
90 raises (::com::sun::star::beans::UnknownPropertyException);
91
107 LineDescriptor
108 describePropertyLine(
109 [in] string PropertyName,
110 [in] XPropertyControlFactory ControlFactory
111 )
112 raises (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::NullPointerException);
113
138 any
139 convertToPropertyValue(
140 [in] string PropertyName,
141 [in] any ControlValue
142 )
143 raises (::com::sun::star::beans::UnknownPropertyException);
144
184 any
185 convertToControlValue(
186 [in] string PropertyName,
187 [in] any PropertyValue,
188 [in] type ControlValueType
189 )
190 raises (::com::sun::star::beans::UnknownPropertyException);
191
209 void
210 addPropertyChangeListener( [in] com::sun::star::beans::XPropertyChangeListener Listener )
211 raises ( com::sun::star::lang::NullPointerException );
212
216 void
217 removePropertyChangeListener( [in] com::sun::star::beans::XPropertyChangeListener Listener );
218
229 sequence< com::sun::star::beans::Property >
230 getSupportedProperties();
231
265 sequence< string >
266 getSupersededProperties( );
267
283 sequence< string >
284 getActuatingProperties( );
285
298 boolean isComposable( [in] string PropertyName )
299 raises (::com::sun::star::beans::UnknownPropertyException);
300
356 ::com::sun::star::inspection::InteractiveSelectionResult
357 onInteractivePropertySelection(
358 [in] string PropertyName,
359 [in] boolean Primary,
360 [out] any outData,
361 [in] XObjectInspectorUI InspectorUI
362 )
363 raises (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::NullPointerException);
364
391 void
392 actuatingPropertyChanged(
393 [in] string ActuatingPropertyName,
394 [in] any NewValue,
395 [in] any OldValue,
396 [in] XObjectInspectorUI InspectorUI,
397 [in] boolean FirstTimeInit
398 )
399 raises (::com::sun::star::lang::NullPointerException);
400
425 boolean suspend( [in] boolean Suspend );
426};
427
428
429}; }; }; };
430
431
432
433/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::PropertyVetoException
This exception is thrown when a proposed change to a property represents an unacceptable value.
Definition: PropertyVetoException.idl:31
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::NullPointerException
This exception is thrown when an application attempts to use NULL in a case where an object is requir...
Definition: NullPointerException.idl:33
com::sun::star::beans::XPropertyChangeListener
is used to receive PropertyChangeEvents whenever a bound property is changed.
Definition: XPropertyChangeListener.idl:29
com::sun::star::inspection::XObjectInspectorUI
grants access to certain aspects of the user interface of an object inspector
Definition: XObjectInspectorUI.idl:38
com::sun::star::inspection::XPropertyControlFactory
a factory for XPropertyControls
Definition: XPropertyControlFactory.idl:29
com::sun::star::inspection::XPropertyHandler
is the basic interface for object inspection.
Definition: XPropertyHandler.idl:39
com::sun::star::inspection::XPropertyHandler::onInteractivePropertySelection
::com::sun::star::inspection::InteractiveSelectionResult onInteractivePropertySelection([in] string PropertyName, [in] boolean Primary, [out] any outData, [in] XObjectInspectorUI InspectorUI)
called when a browse button belonging to a property UI representation has been clicked
com::sun::star::inspection::XPropertyHandler::isComposable
boolean isComposable([in] string PropertyName)
determines whether a given property, which the handler is responsible for, is composable.
com::sun::star::inspection::XPropertyHandler::getActuatingProperties
sequence< string > getActuatingProperties()
retrieve the actuating properties which this handler is interested in
com::sun::star::inspection::XPropertyHandler::getPropertyValue
any getPropertyValue([in] string PropertyName)
retrieves the current value of a property
com::sun::star::inspection::XPropertyHandler::getSupportedProperties
sequence< com::sun::star::beans::Property > getSupportedProperties()
returns the properties which the handler can handle
com::sun::star::inspection::XPropertyHandler::setPropertyValue
void setPropertyValue([in] string PropertyName, [in] any Value)
sets the value of a property
com::sun::star::inspection::XPropertyHandler::getPropertyState
com::sun::star::beans::PropertyState getPropertyState([in] string PropertyName)
returns the state of a property
com::sun::star::inspection::XPropertyHandler::convertToPropertyValue
any convertToPropertyValue([in] string PropertyName, [in] any ControlValue)
converts a given control-compatible value to a property value
com::sun::star::inspection::XPropertyHandler::inspect
void inspect([in] com::sun::star::uno::XInterface Component)
binds the property handler to a new component
com::sun::star::inspection::XPropertyHandler::actuatingPropertyChanged
void actuatingPropertyChanged([in] string ActuatingPropertyName, [in] any NewValue, [in] any OldValue, [in] XObjectInspectorUI InspectorUI, [in] boolean FirstTimeInit)
updates the UI of dependent properties when the value of a certain actuating property changed
com::sun::star::inspection::XPropertyHandler::addPropertyChangeListener
void addPropertyChangeListener([in] com::sun::star::beans::XPropertyChangeListener Listener)
registers a listener for notification about property value changes
com::sun::star::inspection::XPropertyHandler::suspend
boolean suspend([in] boolean Suspend)
suspends the handler
com::sun::star::inspection::XPropertyHandler::convertToControlValue
any convertToControlValue([in] string PropertyName, [in] any PropertyValue, [in] type ControlValueType)
converts a given property value to a control-compatible value
com::sun::star::inspection::XPropertyHandler::getSupersededProperties
sequence< string > getSupersededProperties()
returns the properties which are to be superseded by this handler
com::sun::star::inspection::XPropertyHandler::describePropertyLine
LineDescriptor describePropertyLine([in] string PropertyName, [in] XPropertyControlFactory ControlFactory)
describes the UI to be used to represent the property
com::sun::star::inspection::XPropertyHandler::removePropertyChangeListener
void removePropertyChangeListener([in] com::sun::star::beans::XPropertyChangeListener Listener)
revokes a listener for notification about property value changes
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:39
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::sun::star::inspection::InteractiveSelectionResult
InteractiveSelectionResult
describes possible results of an interactive selection of a property value in an object inspector
Definition: InteractiveSelectionResult.idl:30
com
Definition: Ambiguous.idl:20
com::sun::star::inspection::LineDescriptor
describes the appearance of a line representing a single property in an ObjectInspector.
Definition: LineDescriptor.idl:42