From b352a8bf0321c13919c9882484a1c4d4d65cfd33 Mon Sep 17 00:00:00 2001 From: Michael Stahl Date: Sat, 27 Apr 2013 22:20:42 +0200 Subject: *api: convert method to method() Doxygen will only recognize a un-qualified method name as such if it is followed by "()". sed -i "s,\([a-z][^<]\+[^)]\),\1(),g" Change-Id: I69bc17849e76f3a3d91c6daf0f1be8168a83cfc5 --- .../com/sun/star/inspection/XHyperlinkControl.idl | 2 +- .../sun/star/inspection/XObjectInspectorModel.idl | 2 +- .../com/sun/star/inspection/XObjectInspectorUI.idl | 4 +-- .../com/sun/star/inspection/XPropertyHandler.idl | 40 +++++++++++----------- 4 files changed, 24 insertions(+), 24 deletions(-) (limited to 'offapi/com/sun/star/inspection') diff --git a/offapi/com/sun/star/inspection/XHyperlinkControl.idl b/offapi/com/sun/star/inspection/XHyperlinkControl.idl index 3e1114e1330e..4a50adf6a384 100644 --- a/offapi/com/sun/star/inspection/XHyperlinkControl.idl +++ b/offapi/com/sun/star/inspection/XHyperlinkControl.idl @@ -40,7 +40,7 @@ interface XHyperlinkControl : XPropertyControl */ void addActionListener( [in] com::sun::star::awt::XActionListener listener ); - /** removes a listener which was previously added via addActionListener + /** removes a listener which was previously added via addActionListener() @param listener the listener to revoke */ diff --git a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl index e5169c5c4635..d27e7a82b68d 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl @@ -70,7 +70,7 @@ interface XObjectInspectorModel method of your property handler.
Those names provided by the handlers are programmatic names. All other information about categories is part of the PropertyCategoryDescriptor, and - describeCategories assembles information about all categories which + describeCategories() assembles information about all categories which all property handlers provided by the model use.

@return diff --git a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl index f696fdb2d93e..dd3e549d3965 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl @@ -58,8 +58,8 @@ interface XObjectInspectorUI /** enables or disables the single elements which can be part of the UI representation of a property

Note that the complete UI for the property must be enabled in order for these settings to - be evaluated. That is, enablePropertyUIElements does not have any effect if - somebody previously disabled the complete UI for this property with enablePropertyUI.

+ be evaluated. That is, enablePropertyUIElements() does not have any effect if + somebody previously disabled the complete UI for this property with enablePropertyUI().

@param PropertyName the name of the property whose user interface elements are to be enabled or disabled diff --git a/offapi/com/sun/star/inspection/XPropertyHandler.idl b/offapi/com/sun/star/inspection/XPropertyHandler.idl index febaf2419e02..9207f2a694a3 100644 --- a/offapi/com/sun/star/inspection/XPropertyHandler.idl +++ b/offapi/com/sun/star/inspection/XPropertyHandler.idl @@ -125,13 +125,13 @@ interface XPropertyHandler /** converts a given control-compatible value to a property value -

In describePropertyLine, a property handler declared which type of control +

In describePropertyLine(), a property handler declared which type of control should be used to display the value of a certain property. To allow to use the same control type for different properties, and in particular, for properties of different type, conversions between controls values and property values are needed.

This method converts a control value into a property value, which subsequently can be used - in conjunction with setPropertyValue.

+ in conjunction with setPropertyValue().

@param PropertyName The name of the conversion's target property. @@ -156,19 +156,19 @@ interface XPropertyHandler /** converts a given property value to a control-compatible value -

In describePropertyLine, a property handler declared which type of control +

In describePropertyLine(), a property handler declared which type of control should be used to display the value of a certain property. To allow to use the same control type for different properties, and in particular, for properties of different type, conversions between controls values and property values are needed.

This method converts a property value, which has previously been obtained using - getPropertyValue, into a control-compatible value, which can be used + getPropertyValue(), into a control-compatible value, which can be used with XPropertyControl's XPropertyControl::Value attribute.

A usual application of this method are list boxes: There is a generic list box implementation, which is able to display a simple list of strings. Usually, every string represents one possible property value. To translate between those property values and the displayed strings, - convertToControlValue and convertToPropertyValue are used.

+ convertToControlValue() and convertToPropertyValue() are used.

The method is not invoked if the control's value type (XPropertyControl::ValueType equals the property's value type.

@@ -180,10 +180,10 @@ interface XPropertyHandler @param ControlValueType The target type of the conversion. This type is determined by the control which is used to display the property, which in turn is determined by the handler itself - in describePropertyLine.
+ in describePropertyLine().
Speaking strictly, this is passed for convenience only, since every XPropertyHandler implementation should know exactly which type to expect, since it implicitly determined this type - in describePropertyLine by creating an appropriate XPropertyControl. + in describePropertyLine() by creating an appropriate XPropertyControl. @throws com::sun::star::beans::UnknownPropertyException if the given property is not supported by the property handler @@ -208,9 +208,9 @@ interface XPropertyHandler reflected in the object inspector.

If a handler implementation supports property change listeners, it must be able to cope - with a call to addPropertyChangeListener even if currently no component is + with a call to addPropertyChangeListener() even if currently no component is being inspected. In this case, the listener must become active as soon as a new introspection - is set in the next inspect call.

+ is set in the next inspect() call.

@param Listener the listener to notify about property changes @@ -243,7 +243,7 @@ interface XPropertyHandler /** returns the properties which are to be superseded by this handler -

Besides defining an own set of properties (see getSupportedProperties), +

Besides defining an own set of properties (see getSupportedProperties()), a property handler can also declare that foreign properties (which it is not responsible for) are superseded by its own properties.

@@ -269,7 +269,7 @@ interface XPropertyHandler C, so it cannot, by definition, supersede properties which are supported by C.

-

If getSupportedProperties returned an empty sequence, this method will +

If getSupportedProperties() returned an empty sequence, this method will not be called.

@see XObjectInspectorModel::HandlerFactories @@ -287,9 +287,9 @@ interface XPropertyHandler

Whenever the value of an actuating property changes, all handlers which expressed their interest in this particular actuating properties are called with their - actuatingPropertyChanged method.

+ actuatingPropertyChanged() method.

-

If getSupportedProperties returned an empty sequence, this method will +

If getSupportedProperties() returned an empty sequence, this method will not be called

*/ sequence< string > @@ -317,7 +317,7 @@ interface XPropertyHandler

Availability of this feature is indicated by the LineDescriptor::HasPrimaryButton and LineDescriptor::HasSecondaryButton members of a LineDescriptor, - which the XPropertyHandler fills in its describePropertyLine method.

+ which the XPropertyHandler fills in its describePropertyLine() method.

When this method is called, the property handler should raise the UI needed to enter the property value, and return the result of this (see InteractiveSelectionResult).

@@ -329,7 +329,7 @@ interface XPropertyHandler

If a handler sets the new property value directly, and returns InteractiveSelectionResult::ObtainedValue, this implies that the property cannot properly be handled in case the object inspector is inspecting an intersection of - multiple components, since in this case onInteractivePropertySelection + multiple components, since in this case onInteractivePropertySelection() will be called at one handler only, however the new property would have to be forwarded to all handlers.

@@ -350,7 +350,7 @@ interface XPropertyHandler @param InspectorUI provides access to the object inspector UI. Implementations should use this if the property selection requires non-modal user input. In those cases, - onInteractivePropertySelection should return InteractiveSelectionResult::Pending, + onInteractivePropertySelection() should return InteractiveSelectionResult::Pending, and the UI for (at least) the property whose input is still pending should be disabled. @return @@ -377,7 +377,7 @@ interface XPropertyHandler /** updates the UI of dependent properties when the value of a certain actuating property changed

This method is called whenever a property value changes, limited to those properties - whose changes the handler expressed interest in (see getActuatingProperties).

+ whose changes the handler expressed interest in (see getActuatingProperties()).

@param ActuatingPropertyName the id of the actuating property. @@ -419,12 +419,12 @@ interface XPropertyHandler

The usual use case for this method are non-modal user interface components used for property value input. Such a component might have been opened during - onInteractivePropertySelection. If a property handler receives a - suspend call, it should forward the suspension request to the UI + onInteractivePropertySelection(). If a property handler receives a + suspend() call, it should forward the suspension request to the UI component, and veto suspension of the XObjectInspector as appropriate.

If suspension is not to be vetoed, then all non-modal UI components opened - by the handler should have been closed when it returns from the suspend call.

+ by the handler should have been closed when it returns from the suspend() call.

@param Suspend Whether the handler is to be suspended or reactivated (). The -- cgit