LibreOffice
LibreOffice 7.1 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#ifndef __com_sun_star_inspection_XPropertyHandler_idl__
20#define __com_sun_star_inspection_XPropertyHandler_idl__
21
31
32module com { module sun { module star { module inspection {
33
34interface XObjectInspectorUI;
35interface XPropertyControlFactory;
36
51{
59
68
75 any
76 getPropertyValue( [in] string PropertyName )
78
88 void
89 setPropertyValue( [in] string PropertyName, [in] any Value )
92
101 getPropertyState( [in] string PropertyName )
103
121 [in] string PropertyName,
122 [in] XPropertyControlFactory ControlFactory
123 )
125
150 any
152 [in] string PropertyName,
153 [in] any ControlValue
154 )
156
196 any
198 [in] string PropertyName,
199 [in] any PropertyValue,
200 [in] type ControlValueType
201 )
203
221 void
224
228 void
230
241 sequence< com::sun::star::beans::Property >
243
277 sequence< string >
279
295 sequence< string >
297
310 boolean isComposable( [in] string PropertyName )
312
370 [in] string PropertyName,
371 [in] boolean Primary,
372 [out] any outData,
373 [in] XObjectInspectorUI InspectorUI
374 )
376
403 void
405 [in] string ActuatingPropertyName,
406 [in] any NewValue,
407 [in] any OldValue,
408 [in] XObjectInspectorUI InspectorUI,
409 [in] boolean FirstTimeInit
410 )
412
437 boolean suspend( [in] boolean Suspend );
438};
439
440
441}; }; }; };
442
443#endif
444
445
446
447/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception is thrown when a proposed change to a property represents an unacceptable value.
Definition: PropertyVetoException.idl:35
This exception is thrown to indicate that the property name is unknown to the implementation.
Definition: UnknownPropertyException.idl:35
This exception is thrown when an application attempts to use NULL in a case where an object is requir...
Definition: NullPointerException.idl:37
is used to receive PropertyChangeEvents whenever a bound property is changed.
Definition: XPropertyChangeListener.idl:35
grants access to certain aspects of the user interface of an object inspector
Definition: XObjectInspectorUI.idl:45
a factory for XPropertyControls
Definition: XPropertyControlFactory.idl:34
is the basic interface for object inspection.
Definition: XPropertyHandler.idl:51
::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
boolean isComposable([in] string PropertyName)
determines whether a given property, which the handler is responsible for, is composable.
sequence< string > getActuatingProperties()
retrieve the actuating properties which this handler is interested in
any getPropertyValue([in] string PropertyName)
retrieves the current value of a property
sequence< com::sun::star::beans::Property > getSupportedProperties()
returns the properties which the handler can handle
void setPropertyValue([in] string PropertyName, [in] any Value)
sets the value of a property
com::sun::star::beans::PropertyState getPropertyState([in] string PropertyName)
returns the state of a property
any convertToPropertyValue([in] string PropertyName, [in] any ControlValue)
converts a given control-compatible value to a property value
void inspect([in] com::sun::star::uno::XInterface Component)
binds the property handler to a new component
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
void addPropertyChangeListener([in] com::sun::star::beans::XPropertyChangeListener Listener)
registers a listener for notification about property value changes
boolean suspend([in] boolean Suspend)
suspends the handler
any convertToControlValue([in] string PropertyName, [in] any PropertyValue, [in] type ControlValueType)
converts a given property value to a control-compatible value
sequence< string > getSupersededProperties()
returns the properties which are to be superseded by this handler
LineDescriptor describePropertyLine([in] string PropertyName, [in] XPropertyControlFactory ControlFactory)
describes the UI to be used to represent the property
void removePropertyChangeListener([in] com::sun::star::beans::XPropertyChangeListener Listener)
revokes a listener for notification about property value changes
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:43
base interface of all UNO interfaces
Definition: XInterface.idl:48
PropertyState
This enumeration lists the states that a property value can have.
Definition: PropertyState.idl:40
InteractiveSelectionResult
describes possible results of an interactive selection of a property value in an object inspector
Definition: InteractiveSelectionResult.idl:32
Definition: Ambiguous.idl:22
describes the appearance of a line representing a single property in an ObjectInspector.
Definition: LineDescriptor.idl:47