diff options
Diffstat (limited to 'offapi/com/sun/star/inspection')
8 files changed, 19 insertions, 19 deletions
diff --git a/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl b/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl index 3737e154855e..e939df39d5df 100644 --- a/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl +++ b/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl @@ -33,7 +33,7 @@ struct PropertyCategoryDescriptor /** contains the programmatic name of the category. <p>This programmatic name is used internally: XPropertyHandler::describePropertyLine() - sets a programmatic category name at <member>LineDescriptor::Category</member>, + sets a programmatic category name at LineDescriptor::Category, and an object inspector uses this to find the proper PropertyCategoryDescriptor.</p> */ string ProgrammaticName; diff --git a/offapi/com/sun/star/inspection/PropertyControlType.idl b/offapi/com/sun/star/inspection/PropertyControlType.idl index 54c72b2136c9..526b2314829b 100644 --- a/offapi/com/sun/star/inspection/PropertyControlType.idl +++ b/offapi/com/sun/star/inspection/PropertyControlType.idl @@ -89,9 +89,9 @@ constants PropertyControlType <p>Additionally, those controls support the XStringListControl interface. If you use this interface to add additional entries to the list box, which have no color associated with it, then you can also exchange values as <code>string</code>. That is, if you write a string into - <member>XPropertyControl::Value</member>, and if this string has previously been added to the list + XPropertyControl::Value, and if this string has previously been added to the list using the XStringListControl interface, this string is selected. Vice versa, if the user - selects one of those non-color strings in the list, then reading <member>XPropertyControl::Value</member> + selects one of those non-color strings in the list, then reading XPropertyControl::Value will retrieve you this string.</p> */ const short ColorListBox = 7; diff --git a/offapi/com/sun/star/inspection/XHyperlinkControl.idl b/offapi/com/sun/star/inspection/XHyperlinkControl.idl index 4a50adf6a384..05e9c96878de 100644 --- a/offapi/com/sun/star/inspection/XHyperlinkControl.idl +++ b/offapi/com/sun/star/inspection/XHyperlinkControl.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module inspection { /** defines the interface for an XPropertyControl which displays its value in a hyperlink-like way - <p>Hyperlink controls exchange their value (<member>XPropertyControl::Value</member>) as strings.</p> + <p>Hyperlink controls exchange their value (XPropertyControl::Value) as strings.</p> @since OOo 2.0.3 */ diff --git a/offapi/com/sun/star/inspection/XObjectInspector.idl b/offapi/com/sun/star/inspection/XObjectInspector.idl index f776e91dc6c4..bea67d040923 100644 --- a/offapi/com/sun/star/inspection/XObjectInspector.idl +++ b/offapi/com/sun/star/inspection/XObjectInspector.idl @@ -92,7 +92,7 @@ interface XObjectInspector <p>If the sequence contains more than one object, the XObjectInspector will create a complete set of property handlers (as indicated by - <member>XObjectInspectorModel::HandlerFactories</member>) for <em>every</em> of + XObjectInspectorModel::HandlerFactories) for <em>every</em> of the objects, and compose their output.</p> @throws com::sun::star::util::VetoException diff --git a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl index 5948773573bb..095bd841cbc1 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl @@ -65,7 +65,7 @@ interface XObjectInspectorModel /** describes the property categories used by the property handlers. - <p>Properties can be sorted into different categories, described by the <member>LineDescriptor::Category</member> + <p>Properties can be sorted into different categories, described by the LineDescriptor::Category attribute, which is filled in XPropertyHandler::describePropertyLine() method of your property handler.<br/> Those names provided by the handlers are programmatic names. All other information diff --git a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl index 070d8b80edab..19946c5242bd 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl @@ -67,7 +67,7 @@ interface XObjectInspectorUI @param Elements a combination of PropertyLineElement flags specifying which elements are to be enabled or disabled.<br/> - Note that if you don't set a particular bit here (say, <member>PropertyLineElement::PrimaryButton</member>), + Note that if you don't set a particular bit here (say, PropertyLineElement::PrimaryButton), this does mean that this element's state is not affected by the call - it does <em>not</em> mean that it is disabled. @param Enable @@ -152,7 +152,7 @@ interface XObjectInspectorUI one. @throws NoSupportException - if the <member>XObjectInspectorModel::HasHelpSection</member> property + if the XObjectInspectorModel::HasHelpSection property requires the help section to be unavailable. @since OOo 2.2 diff --git a/offapi/com/sun/star/inspection/XPropertyControlFactory.idl b/offapi/com/sun/star/inspection/XPropertyControlFactory.idl index 955dc6a42748..abb78655744d 100644 --- a/offapi/com/sun/star/inspection/XPropertyControlFactory.idl +++ b/offapi/com/sun/star/inspection/XPropertyControlFactory.idl @@ -46,9 +46,9 @@ interface XPropertyControlFactory <p>If this argument is <TRUE/>, this does not necessarily mean that the property cannot be changed at all in the ObjectInspector. Instead, an XPropertyHandler can still decide that there is a dedicated UI for entering the property value, - which is usually triggered by a <member>LineDescriptor::PrimaryButton</member>.</p> + which is usually triggered by a LineDescriptor::PrimaryButton.</p> - <p>Note that this parameter might be ignored if the <member>XObjectInspectorModel::IsReadOnly</member> + <p>Note that this parameter might be ignored if the XObjectInspectorModel::IsReadOnly attribute is <TRUE/>, in which case all created property controls must be readonly.</p> @returns diff --git a/offapi/com/sun/star/inspection/XPropertyHandler.idl b/offapi/com/sun/star/inspection/XPropertyHandler.idl index 1d516049d1f4..39d295f118a9 100644 --- a/offapi/com/sun/star/inspection/XPropertyHandler.idl +++ b/offapi/com/sun/star/inspection/XPropertyHandler.idl @@ -163,14 +163,14 @@ interface XPropertyHandler <p>This method converts a property value, which has previously been obtained using getPropertyValue(), into a control-compatible value, which can be used - with XPropertyControl's <member>XPropertyControl::Value</member> attribute.</p> + with XPropertyControl's XPropertyControl::Value attribute.</p> <p>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.</p> - <p>The method is not invoked if the control's value type (<member>XPropertyControl::ValueType</member> + <p>The method is not invoked if the control's value type (XPropertyControl::ValueType equals the property's value type.</p> @param PropertyName @@ -256,7 +256,7 @@ interface XPropertyHandler <p>There is a precedence in the property handlers used by an ObjectInspector, which also is important for the superseded properties. This precedence is implied by the precedence of factories to create the property handlers, as denoted in the - <member>XObjectInspectorModel::HandlerFactories</member> attribute.</p> + XObjectInspectorModel::HandlerFactories attribute.</p> <p>With this in mind, property handlers can only supersede properties which are supported by a handler preceding them, but not properties of handlers succeeding them.</p> @@ -315,8 +315,8 @@ interface XPropertyHandler <p>Property handlers can raise a dedicated UI for entering or somehow changing a property value. Usually, this will be a modal dialog, but it can also be a non-modal user interface component.</p> - <p>Availability of this feature is indicated by the <member>LineDescriptor::HasPrimaryButton</member> - and <member>LineDescriptor::HasSecondaryButton</member> members of a LineDescriptor, + <p>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.</p> <p>When this method is called, the property handler should raise the UI needed to enter the @@ -324,10 +324,10 @@ interface XPropertyHandler <p>It is recommended that property handlers do not directly set the property value which has been obtained from the user, but store it in the output-parameter Data, and return - <member>InteractiveSelectionResult::ObtainedValue</member>.</p> + InteractiveSelectionResult::ObtainedValue.</p> <p>If a handler sets the new property value directly, and returns - <member>InteractiveSelectionResult::ObtainedValue</member>, this implies that the property + 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() will be called at one handler only, however the new property would have to be forwarded to @@ -343,14 +343,14 @@ interface XPropertyHandler <TRUE/> if and only if the primary button has been clicked, <FALSE/> otherwise @param out_Data - If the method returns <member>InteractiveSelectionResult::ObtainedValue</member>, + If the method returns InteractiveSelectionResult::ObtainedValue, then <arg>out_Data</arg> contains the value which has been interactively obtained from the user, and which still needs to be set at the inspected component. @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 <member>InteractiveSelectionResult::Pending</member>, + onInteractivePropertySelection() should return InteractiveSelectionResult::Pending, and the UI for (at least) the property whose input is still pending should be disabled. @return |