summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/inspection
diff options
context:
space:
mode:
authorMichael Stahl <mstahl@redhat.com>2013-04-27 21:47:17 +0200
committerMichael Stahl <mstahl@redhat.com>2013-06-04 12:00:59 +0200
commit944eb9902788d8afec9e3f0f65d3b680041e039b (patch)
tree3bbb926890561b81d9f6ae611be4677876799a36 /offapi/com/sun/star/inspection
parentcdbbbdce9956e290b4a849af332df55da1be8d36 (diff)
*api: convert <type>Foo</type>
Doxygen does not know type element and will recognize strings that contain capital letter (all API types do) automatically as type. This patch removes 15k doxygen warnings. git ls-files | grep \\.idl | xargs sed -i "s,<type>\([^<]\+\)</type>,\1," Change-Id: I45c07cf0b115d5fb5353f4aa9719839615ea1150
Diffstat (limited to 'offapi/com/sun/star/inspection')
-rw-r--r--offapi/com/sun/star/inspection/DefaultHelpProvider.idl8
-rw-r--r--offapi/com/sun/star/inspection/LineDescriptor.idl12
-rw-r--r--offapi/com/sun/star/inspection/ObjectInspector.idl6
-rw-r--r--offapi/com/sun/star/inspection/ObjectInspectorModel.idl6
-rw-r--r--offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl2
-rw-r--r--offapi/com/sun/star/inspection/PropertyControlType.idl16
-rw-r--r--offapi/com/sun/star/inspection/XHyperlinkControl.idl2
-rw-r--r--offapi/com/sun/star/inspection/XNumericControl.idl2
-rw-r--r--offapi/com/sun/star/inspection/XObjectInspector.idl12
-rw-r--r--offapi/com/sun/star/inspection/XObjectInspectorModel.idl24
-rw-r--r--offapi/com/sun/star/inspection/XObjectInspectorUI.idl14
-rw-r--r--offapi/com/sun/star/inspection/XPropertyControl.idl10
-rw-r--r--offapi/com/sun/star/inspection/XPropertyControlContext.idl4
-rw-r--r--offapi/com/sun/star/inspection/XPropertyControlFactory.idl12
-rw-r--r--offapi/com/sun/star/inspection/XPropertyControlObserver.idl6
-rw-r--r--offapi/com/sun/star/inspection/XPropertyHandler.idl30
-rw-r--r--offapi/com/sun/star/inspection/XStringListControl.idl4
17 files changed, 85 insertions, 85 deletions
diff --git a/offapi/com/sun/star/inspection/DefaultHelpProvider.idl b/offapi/com/sun/star/inspection/DefaultHelpProvider.idl
index 2884d32d7b92..2e365def0c46 100644
--- a/offapi/com/sun/star/inspection/DefaultHelpProvider.idl
+++ b/offapi/com/sun/star/inspection/DefaultHelpProvider.idl
@@ -28,11 +28,11 @@ interface XObjectInspectorUI;
/** implements a component which can default-fill the help section of an
- <type>ObjectInspector</type>.
+ ObjectInspector.
- <p>The component registers a <type>XPropertyControlObserver</type> at an
- <type>XObjectInspectoryUI</type> interface. Whenever it then is notified
- of a <type>XPropertyControl</type> getting the focus, it will try to deduce
+ <p>The component registers a XPropertyControlObserver at an
+ XObjectInspectoryUI interface. Whenever it then is notified
+ of a XPropertyControl getting the focus, it will try to deduce
the extended help text of this control's window, and set this help text at the
object inspector's help section.</p>
*/
diff --git a/offapi/com/sun/star/inspection/LineDescriptor.idl b/offapi/com/sun/star/inspection/LineDescriptor.idl
index fc86f0acec47..fcfb133c774b 100644
--- a/offapi/com/sun/star/inspection/LineDescriptor.idl
+++ b/offapi/com/sun/star/inspection/LineDescriptor.idl
@@ -26,7 +26,7 @@ module com { module sun { module star { module inspection {
interface XPropertyControl;
-/** describes the appearance of a line representing a single property in an <type>ObjectInspector</type>.
+/** describes the appearance of a line representing a single property in an ObjectInspector.
Such a line consists of
<ul><li>a label with a human-readable name for the property</li>
@@ -160,20 +160,20 @@ struct LineDescriptor
can be used to visually represent this fact. For this, the dependent property's
indent level would be one larger than the indent level of the other property.</p>
- <p>Normally, <type>XPropertyHandler</type>s will set this to <code>0</code> when describing
+ <p>Normally, XPropertyHandlers will set this to <code>0</code> when describing
the UI for a normal property.
*/
short IndentLevel;
- /** describes the category into which the property should be sorted by the <type>ObjectInspector</type>.
+ /** describes the category into which the property should be sorted by the ObjectInspector.
- <p>An <type>ObjectInspector</type> can visually group properties which semantically belong
+ <p>An ObjectInspector can visually group properties which semantically belong
together (for instance using tab pages). The decision which properties actually belong together
is made using this <member>Category</member> attribute.</p>
- <p>For your implementation of <type>XPropertyHandler</type>, it's recommended that you document the programmatic
+ <p>For your implementation of XPropertyHandler, it's recommended that you document the programmatic
names used for property categories. This way, your handler might be re-used in
- different contexts, where only the <type>XObjectInspectorModel</type> needs to provide consistent
+ different contexts, where only the XObjectInspectorModel needs to provide consistent
UI names for the categories.</p>
@see XObjectInspectorModel::describeCategories
diff --git a/offapi/com/sun/star/inspection/ObjectInspector.idl b/offapi/com/sun/star/inspection/ObjectInspector.idl
index 8681b73aa3c2..bb013894c985 100644
--- a/offapi/com/sun/star/inspection/ObjectInspector.idl
+++ b/offapi/com/sun/star/inspection/ObjectInspector.idl
@@ -42,7 +42,7 @@ module com { module sun { module star { module inspection {
<p>Even more, the inspector can optionally display a help section at the bottom of its
window, which can display arbitrary (context-sensitive) help texts.</p>
- <p>An <type>ObjectInspector</type> needs one or more property handlers which describe
+ <p>An ObjectInspector needs one or more property handlers which describe
the facets of an inspected component - without such handlers, the inspector window will simply
stay empty.</p>
@@ -53,7 +53,7 @@ module com { module sun { module star { module inspection {
<p>Since property handlers might have the need to raise UI, they will be created with a context
value named "DialogParentWindow", which contains an XWindow which should be used as parent of
any windows to raise.<br/>
- If the <type scope="com::sun::star::uno">XComponentContext</type> in which the <type>ObjectInspector</type>
+ If the <type scope="com::sun::star::uno">XComponentContext</type> in which the ObjectInspector
was created already contains such a value, it is not overwritten. Only if it doesn't, the inspector
will add an own value - which contains the inspector's main window - to the context when creating
handlers.</p>
@@ -75,7 +75,7 @@ service ObjectInspector : XObjectInspector
*/
createDefault();
- /** creates an instance of the ObjectInspector, using a given <type>ObjectInspectorModel</type>
+ /** creates an instance of the ObjectInspector, using a given ObjectInspectorModel
@throws ::com::sun::star::lang::IllegalArgumentException
if <arg>Model</arg> is <NULL/>.
diff --git a/offapi/com/sun/star/inspection/ObjectInspectorModel.idl b/offapi/com/sun/star/inspection/ObjectInspectorModel.idl
index 21e717453d4e..4aaf87b0a5d9 100644
--- a/offapi/com/sun/star/inspection/ObjectInspectorModel.idl
+++ b/offapi/com/sun/star/inspection/ObjectInspectorModel.idl
@@ -27,9 +27,9 @@ module com { module sun { module star { module inspection {
/** describes a default implementation of an ObjectInspectorModel
- <p>This service simplifies usage of an <type>ObjectInspector</type>.</p>
+ <p>This service simplifies usage of an ObjectInspector.</p>
- <p>The <type>XObjectInspectorModel</type> implemented by this service will not provide any property
+ <p>The XObjectInspectorModel implemented by this service will not provide any property
categories, nor apply any particular order to the properties provided by its handler(s).</p>
@see ObjectInspector
@@ -42,7 +42,7 @@ module com { module sun { module star { module inspection {
service ObjectInspectorModel : XObjectInspectorModel
{
/** creates a default ObjectInspectorModel, whose one and only handler factory
- creates a <type>GenericPropertyHandler</type>.
+ creates a GenericPropertyHandler.
*/
createDefault();
diff --git a/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl b/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl
index 05d782820dc2..54bf61b0c8c7 100644
--- a/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl
+++ b/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl
@@ -34,7 +34,7 @@ struct PropertyCategoryDescriptor
<p>This programmatic name is used internally: <member>XPropertyHandler::describePropertyLine</member>
sets a programmatic category name at <member>LineDescriptor::Category</member>,
- and an object inspector uses this to find the proper <type>PropertyCategoryDescriptor</type>.</p>
+ 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 5691885fd9de..de6ac8bb3d50 100644
--- a/offapi/com/sun/star/inspection/PropertyControlType.idl
+++ b/offapi/com/sun/star/inspection/PropertyControlType.idl
@@ -23,7 +23,7 @@
module com { module sun { module star { module inspection {
/** describes pre-defined possible control types to be used to display and enter
- property values within a <type>ObjectInspector</type>.
+ property values within a ObjectInspector.
<p>The type of a control determines its visual appearance, its behavior, and - important
for property handlers using a control - the expected type when reading and writing the
@@ -42,7 +42,7 @@ constants PropertyControlType
<p>Controls of type <member>ListBox</member> exchange their values as <code>string</code>.</p>
- <p>Additionally, those controls support the <type>XStringListControl</type> interface.</p>
+ <p>Additionally, those controls support the XStringListControl interface.</p>
*/
const short ListBox = 1;
@@ -52,7 +52,7 @@ constants PropertyControlType
<p>Controls of type <member>ComboBox</member> exchange their values as <code>string</code>.</p>
- <p>Additionally, those controls support the <type>XStringListControl</type> interface.</p>
+ <p>Additionally, those controls support the XStringListControl interface.</p>
*/
const short ComboBox = 2;
@@ -86,11 +86,11 @@ constants PropertyControlType
<p>Controls of type <member>ColorListBox</member> usually exchange their values as
<type scope="com::sun::star::util">Color</type>.</p>
- <p>Additionally, those controls support the <type>XStringListControl</type> interface. If you use
+ <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
- using the <type>XStringListControl</type> interface, this string is selected. Vice versa, if the user
+ 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>
will retrieve you this string.</p>
*/
@@ -100,7 +100,7 @@ constants PropertyControlType
<p>Controls of type <member>NumericField</member> exchange their values as <code>double</code>.</p>
- <p>Additionally, those controls support the <type>XNumericControl</type> interface.</p>
+ <p>Additionally, those controls support the XNumericControl interface.</p>
*/
const short NumericField = 8;
@@ -126,11 +126,11 @@ constants PropertyControlType
<p>Controls of type <member>HyperlinkField</member> exchange their values as <code>string</code>.</p>
- <p>Additionally, those controls support the <type>XHyperlinkControl</type> interface.</p>
+ <p>Additionally, those controls support the XHyperlinkControl interface.</p>
*/
const short HyperlinkField = 12;
- /** denotes a non-standard property control, which is usually provided by an <type>XPropertyHandler</type>
+ /** denotes a non-standard property control, which is usually provided by an XPropertyHandler
*/
const short Unknown = 13;
};
diff --git a/offapi/com/sun/star/inspection/XHyperlinkControl.idl b/offapi/com/sun/star/inspection/XHyperlinkControl.idl
index b3e876c06a19..3e1114e1330e 100644
--- a/offapi/com/sun/star/inspection/XHyperlinkControl.idl
+++ b/offapi/com/sun/star/inspection/XHyperlinkControl.idl
@@ -25,7 +25,7 @@
module com { module sun { module star { module inspection {
-/** defines the interface for an <type>XPropertyControl</type> which displays its value
+/** 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>
diff --git a/offapi/com/sun/star/inspection/XNumericControl.idl b/offapi/com/sun/star/inspection/XNumericControl.idl
index 755c8d55822b..c2f64bb5e2fc 100644
--- a/offapi/com/sun/star/inspection/XNumericControl.idl
+++ b/offapi/com/sun/star/inspection/XNumericControl.idl
@@ -26,7 +26,7 @@
module com { module sun { module star { module inspection {
-/** defines the interface for an <type>XPropertyControl</type> which supports
+/** defines the interface for an XPropertyControl which supports
displaying and entering numerical values.
@since OOo 2.0.3
diff --git a/offapi/com/sun/star/inspection/XObjectInspector.idl b/offapi/com/sun/star/inspection/XObjectInspector.idl
index 7c1cf5fe5ee8..e005874b0a4d 100644
--- a/offapi/com/sun/star/inspection/XObjectInspector.idl
+++ b/offapi/com/sun/star/inspection/XObjectInspector.idl
@@ -29,7 +29,7 @@ module com { module sun { module star { module inspection {
interface XObjectInspectorModel;
interface XObjectInspectorUI;
-/** describes the main interface of an <type>ObjectInspector</type>.
+/** describes the main interface of an ObjectInspector.
@see ObjectInspector
@@ -40,7 +40,7 @@ interface XObjectInspector
/** allows to plug the inspector into an <type scope="com::sun::star::frame">XFrame</type>
<p>The <member scope="com::sun::star::frame">XController::setModel</member> method
- accepts only <type>XObjectInspectorModel</type>s, and will return <FALSE/> if the
+ accepts only XObjectInspectorModels, and will return <FALSE/> if the
to-be-attached model is not <NULL/>, but does not support this interface.</p>
<p>If you do not want to support a full-blown <type scope="com::sun::star::frame">XModel</type>,
@@ -55,7 +55,7 @@ interface XObjectInspector
/** allows to intercept functionality
<p>This interface is inherited from the <type scope="com::sun::star::frame">Controller</type>
- service, currently, there is no functionality to intercept at an <type>XObjectInspector</type>.</p>
+ service, currently, there is no functionality to intercept at an XObjectInspector.</p>
*/
interface com::sun::star::frame::XDispatchProvider;
@@ -87,17 +87,17 @@ interface XObjectInspector
/** inspects a new collection of one or more objects.
- <p>If the sequence is empty, the UI of the <type>ObjectInspector</type> will be
+ <p>If the sequence is empty, the UI of the ObjectInspector will be
cleared.</p>
- <p>If the sequence contains more than one object, the <type>XObjectInspector</type>
+ <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
the objects, and compose their output.</p>
@throws com::sun::star::util::VetoException
if the inspector cannot switch to another object set. This typically happens if
- one of the active <type>XPropertyHandler</type>'s raised a non-modal user interface,
+ one of the active XPropertyHandler's raised a non-modal user interface,
and vetoed suspension of this UI.
@see XPropertyHandler::isComposable
diff --git a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl
index 362c6056b9a7..d59c19326d51 100644
--- a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl
+++ b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl
@@ -27,7 +27,7 @@ module com { module sun { module star { module inspection {
interface XPropertyHandler;
-/** describes the model of an <type>ObjectInspector</type>
+/** describes the model of an ObjectInspector
@see ObjectInspector
@@ -35,10 +35,10 @@ interface XPropertyHandler;
*/
interface XObjectInspectorModel
{
- /** describes a set of factories for creating <type>XPropertyHandler</type>s
+ /** describes a set of factories for creating XPropertyHandlers
<p>Every element of the sequence must contain information to create a
- <type>XPropertyHandler</type> instance. Two ways are currently supported:
+ XPropertyHandler instance. Two ways are currently supported:
<ul>
<li>A service name:</br>
If a sequence element contains a string, this string is interpreted
@@ -50,7 +50,7 @@ interface XObjectInspectorModel
is used to create a property handler.</li>
</ul></p>
- <p>This attribute is usually only evaluated by the <type>ObjectInspector</type> instance
+ <p>This attribute is usually only evaluated by the ObjectInspector instance
which the model is currently bound to.</p>
<p>The order of factories is important: If two property handlers declare themselves responsible
@@ -69,13 +69,13 @@ interface XObjectInspectorModel
attribute, which is filled in <member>XPropertyHandler::describePropertyLine</member>
method of your property handler.<br/>
Those names provided by the handlers are programmatic names. All other information
- about categories is part of the <type>PropertyCategoryDescriptor</type>, and
+ about categories is part of the PropertyCategoryDescriptor, and
<member>describeCategories</member> assembles information about all categories which
all property handlers provided by the model use.</p>
@return
a sequence of category descriptors. Their relative ordering also describes
- the relative ordering of the categories in the <type>ObjectInspector</type>'s
+ the relative ordering of the categories in the ObjectInspector's
user interface.<br/>
The sequence must not contain two entries with the same programmatic name.<br/>
<br/>
@@ -92,7 +92,7 @@ interface XObjectInspectorModel
<p>In the user interface of an ObjectInspector, single properties are represented by
single lines, and those lines are displayed successively. To determine an order of
the property lines, the inspector model can associate an "order index" with each property.
- The <type>ObjectInspector</type> will then sort the property lines in a way that they
+ The ObjectInspector will then sort the property lines in a way that they
have the same relative ordering as the "order indexes" of their properties.</p>
<p>Note that the concrete value the model returns for a given property does not
@@ -101,7 +101,7 @@ interface XObjectInspectorModel
of <code>Foo</code> should be greater than the order index of <code>Bar</code>.
<p>If for two different properties the same order index is returned, the
- <type>ObjectInspector</type> will assume the order in which those properties
+ ObjectInspector will assume the order in which those properties
were provided by the respective property handler
(<member>XPropertyHandler::getSupportedProperties</member>).<br/>
If two such properties originate from different handlers, they will be ordered according
@@ -129,10 +129,10 @@ interface XObjectInspectorModel
/** denotes the minimum number of lines of text to be reserved for the help
section.
- <p>This property is ignored by the <type>ObjectInspector</type> if
+ <p>This property is ignored by the ObjectInspector if
<member>HasHelpSection</member> is <FALSE/>.</p>
- <p>The layout of the <type>ObjectInspector</type> is undefined if
+ <p>The layout of the ObjectInspector is undefined if
<member>MinHelpTextLines</member> is larger than
<member>MaxHelpTextLines</member>.</p>
@@ -143,10 +143,10 @@ interface XObjectInspectorModel
/** denotes the maximum number of lines of text to be reserved for the help
section.
- <p>This property is ignored by the <type>ObjectInspector</type> if
+ <p>This property is ignored by the ObjectInspector if
<member>HasHelpSection</member> is <FALSE/>.</p>
- <p>The layout of the <type>ObjectInspector</type> is undefined if
+ <p>The layout of the ObjectInspector is undefined if
<member>MaxHelpTextLines</member> is smaller than
<member>MinHelpTextLines</member>.</p>
diff --git a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl
index e0bdc352ccae..f696fdb2d93e 100644
--- a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl
+++ b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl
@@ -31,12 +31,12 @@ interface XPropertyControlObserver;
/** grants access to certain aspects of the user interface of an object
inspector
- <p>This interface is used as callback for <type>XPropertyHandler</type>s.</p>
+ <p>This interface is used as callback for XPropertyHandlers.</p>
<p>As a consequence, methods operating on the UI for a property, and taking the name of this property,
are tolerant against properties which do not exist. For instance, if a property handler tries to
disable the UI for property <code>Foo</code>, but another handler has superseded this property, then
- the <type>ObjectInspector</type> will not <em>have</em> any UI for it. In this case, the call to
+ the ObjectInspector will not <em>have</em> any UI for it. In this case, the call to
<code>enablePropertyUI( "Foo" )</code> will simply be ignored.</p>
@since OOo 2.0.3
@@ -45,7 +45,7 @@ interface XObjectInspectorUI
{
/** enables or disables all components belonging to the UI representation of a property
- <p>This is usually used by an <type>XPropertyHandler</type> if it handles properties,
+ <p>This is usually used by an XPropertyHandler if it handles properties,
where one does only make sense if another one has a certain value.</p>
@param PropertyName
@@ -65,7 +65,7 @@ interface XObjectInspectorUI
the name of the property whose user interface elements are to be enabled or disabled
@param Elements
- a combination of <type>PropertyLineElement</type> flags specifying which elements are to be
+ 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>),
this does mean that this element's state is not affected by the call - it does
@@ -82,8 +82,8 @@ interface XObjectInspectorUI
/** completely rebuilds the UI for the given property.
- <p>This method might be used by an <type>XPropertyHandler</type> if it wants to change the type
- of control (see <type>PropertyControlType</type>) used to display a certain property.</p>
+ <p>This method might be used by an XPropertyHandler if it wants to change the type
+ of control (see PropertyControlType) used to display a certain property.</p>
<p>The object inspector will then call describePropertyLine again, and update its UI accordingly.</p>
@@ -123,7 +123,7 @@ interface XObjectInspectorUI
the name of the property whose control should be retrieved
@return
- the <type>XPropertyControl</type> representing the given property, or <NULL/>
+ the XPropertyControl representing the given property, or <NULL/>
if there is no such property control.
*/
XPropertyControl
diff --git a/offapi/com/sun/star/inspection/XPropertyControl.idl b/offapi/com/sun/star/inspection/XPropertyControl.idl
index 354f053d4254..8543bc8e9e76 100644
--- a/offapi/com/sun/star/inspection/XPropertyControl.idl
+++ b/offapi/com/sun/star/inspection/XPropertyControl.idl
@@ -27,13 +27,13 @@ module com { module sun { module star { module inspection {
interface XPropertyControlContext;
-/** defines the interface for a single control in an <type>ObjectInspector</type>
+/** defines the interface for a single control in an ObjectInspector
@since OOo 2.0.3
*/
interface XPropertyControl
{
- /** denotes the type of the control, as one of the <type>PropertyControlType</type>
+ /** denotes the type of the control, as one of the PropertyControlType
constants
*/
[attribute, readonly] short ControlType;
@@ -58,7 +58,7 @@ interface XPropertyControl
*/
[attribute, readonly] type ValueType;
- /** specifies the context of the control within the <type>ObjectInspector</type>.
+ /** specifies the context of the control within the ObjectInspector.
<p>The property control should actively notify its state changes to the context.
In particular, changes in the focus and the value of the control must be notified.
@@ -67,7 +67,7 @@ interface XPropertyControl
/** determines whether the control content is currently modified
- <p>An <type>XPropertyControl</type> internally manages a flag indicating whether
+ <p>An XPropertyControl internally manages a flag indicating whether
its content is modified. This flag is reset to <FALSE/> every time our
<member>ControlContext</member> is notified of our current value. Also, the control
implementation must set this flag to <TRUE/> if and only if the user changed the
@@ -90,7 +90,7 @@ interface XPropertyControl
/** denotes the window which is the real UI representation of the property control.
- <p>The <type>ObjectInspector</type> will automatically position and size this control
+ <p>The ObjectInspector will automatically position and size this control
as needed, care for its Z-order, and so on.</p>
<p>This Window must not be <NULL/>, else the whole control is not usable.</p>
diff --git a/offapi/com/sun/star/inspection/XPropertyControlContext.idl b/offapi/com/sun/star/inspection/XPropertyControlContext.idl
index 2fe3753f4f7a..878710c0b658 100644
--- a/offapi/com/sun/star/inspection/XPropertyControlContext.idl
+++ b/offapi/com/sun/star/inspection/XPropertyControlContext.idl
@@ -24,7 +24,7 @@
module com { module sun { module star { module inspection {
-/** specifies the interface of the context of an <type>XPropertyControl</type>.
+/** specifies the interface of the context of an XPropertyControl.
@see XPropertyControl::ControlContext
@@ -32,7 +32,7 @@ module com { module sun { module star { module inspection {
*/
interface XPropertyControlContext : XPropertyControlObserver
{
- /** instructs the <type>XPropertyControlContext</type> to active the next control
+ /** instructs the XPropertyControlContext to active the next control
@param CurrentControl
denotes the control which initiated the request.
diff --git a/offapi/com/sun/star/inspection/XPropertyControlFactory.idl b/offapi/com/sun/star/inspection/XPropertyControlFactory.idl
index 69aa638ea9a0..955dc6a42748 100644
--- a/offapi/com/sun/star/inspection/XPropertyControlFactory.idl
+++ b/offapi/com/sun/star/inspection/XPropertyControlFactory.idl
@@ -26,16 +26,16 @@ module com { module sun { module star { module inspection {
interface XPropertyControl;
-/** a factory for <type>XPropertyControl</type>s
+/** a factory for XPropertyControls
@since OOo 2.0.3
*/
interface XPropertyControlFactory
{
- /** creates a <type>XPropertyControl</type>
+ /** creates a XPropertyControl
- <p>A <type>XPropertyControlFactory</type> can create any of the control types denoted by
- the <type>PropertyControlType</type> constants.</p>
+ <p>A XPropertyControlFactory can create any of the control types denoted by
+ the PropertyControlType constants.</p>
@param ControlType
the type of the requested control
@@ -44,7 +44,7 @@ interface XPropertyControlFactory
determines whether the newly created control should be readonly.
<p>If this argument is <TRUE/>, this does not necessarily mean that the property cannot be
- changed at all in the <type>ObjectInspector</type>. Instead, an <type>XPropertyHandler</type>
+ 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>
@@ -55,7 +55,7 @@ interface XPropertyControlFactory
a control of the given type.
@throws com::sun::star::lang::IllegalArgumentException
- if the given <arg>ControlType</arg> is not a value <type>PropertyControlType</type>
+ if the given <arg>ControlType</arg> is not a value PropertyControlType
*/
XPropertyControl createPropertyControl( [in] short ControlType, [in] boolean CreateReadOnly )
raises ( com::sun::star::lang::IllegalArgumentException );
diff --git a/offapi/com/sun/star/inspection/XPropertyControlObserver.idl b/offapi/com/sun/star/inspection/XPropertyControlObserver.idl
index 3e99e74c5d19..d9805dbd0638 100644
--- a/offapi/com/sun/star/inspection/XPropertyControlObserver.idl
+++ b/offapi/com/sun/star/inspection/XPropertyControlObserver.idl
@@ -29,13 +29,13 @@ interface XPropertyControl;
/** specifies an interface for components to observer certain aspects
- of an <type>XPropertyControl</type>.
+ of an XPropertyControl.
@since OOo 2.2
*/
interface XPropertyControlObserver
{
- /** notifies the observer that a certain <type>XPropertyControl</type>'s UI
+ /** notifies the observer that a certain XPropertyControl's UI
representation gained the focus.
@param Control
@@ -43,7 +43,7 @@ interface XPropertyControlObserver
*/
void focusGained( [in] XPropertyControl Control );
- /** notifies the observer that a certain <type>XPropertyControl</type>'s value
+ /** notifies the observer that a certain XPropertyControl's value
changed.
@param Control
diff --git a/offapi/com/sun/star/inspection/XPropertyHandler.idl b/offapi/com/sun/star/inspection/XPropertyHandler.idl
index 40f721068641..febaf2419e02 100644
--- a/offapi/com/sun/star/inspection/XPropertyHandler.idl
+++ b/offapi/com/sun/star/inspection/XPropertyHandler.idl
@@ -36,8 +36,8 @@ interface XPropertyControlFactory;
/** is the basic interface for object inspection.
- <p>The <type>ObjectInspector</type> itself does not know anything about the object
- it is inspecting, all information is obtained via <type>XPropertyHandler</type>s.
+ <p>The ObjectInspector itself does not know anything about the object
+ it is inspecting, all information is obtained via XPropertyHandlers.
Also, property handlers are responsible for describing the user interface which should
be used to interact with the user, with respect to a given aspect of the inspected
component.</p>
@@ -106,7 +106,7 @@ interface XPropertyHandler
the name of the property whose user interface is to be described
implementation
@param ControlFactory
- a factory for creating <type>XPropertyControl</type> instances. Must not be <NULL/>.
+ a factory for creating XPropertyControl instances. Must not be <NULL/>.
@return
the descriptor of the property line.
@throws com::sun::star::beans::UnknownPropertyException
@@ -136,7 +136,7 @@ interface XPropertyHandler
@param PropertyName
The name of the conversion's target property.
@param ControlValue
- The to-be-converted control value. This value has been obtained from an <type>XPropertyControl</type>,
+ The to-be-converted control value. This value has been obtained from an XPropertyControl,
using its <member>Value</member> attribute.
@throws com::sun::star::beans::UnknownPropertyException
@@ -163,7 +163,7 @@ interface XPropertyHandler
<p>This method converts a property value, which has previously been obtained using
<member>getPropertyValue</member>, into a control-compatible value, which can be used
- with <type>XPropertyControl</type>'s <member>XPropertyControl::Value</member> attribute.</p>
+ with XPropertyControl's <member>XPropertyControl::Value</member> 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
@@ -181,9 +181,9 @@ interface XPropertyHandler
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 <member>describePropertyLine</member>.<br/>
- Speaking strictly, this is passed for convenience only, since every <type>XPropertyHandler</type>
+ 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 <member>describePropertyLine</member> by creating an appropriate <type>XPropertyControl</type>.
+ in <member>describePropertyLine</member> by creating an appropriate XPropertyControl.
@throws com::sun::star::beans::UnknownPropertyException
if the given property is not supported by the property handler
@@ -203,7 +203,7 @@ interface XPropertyHandler
/** registers a listener for notification about property value changes
- <p>An <type>XPropertyHandler</type> implementation might decide to ignore this call.
+ <p>An XPropertyHandler implementation might decide to ignore this call.
However, in this case property value changes made by third party components are not
reflected in the object inspector.</p>
@@ -253,7 +253,7 @@ interface XPropertyHandler
<p>In such a case, simply return those properties here.</p>
- <p>There is a precedence in the property handlers used by an <type>ObjectInspector</type>,
+ <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>
@@ -261,7 +261,7 @@ interface XPropertyHandler
<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>
- <p>For instance, imaging an <type>XObjectInspectorModel</type> which provides three
+ <p>For instance, imaging an XObjectInspectorModel which provides three
factories, for handler <code>A</code>, <code>B</code>, and <code>C</code> - in this order.
Now if <code>A</code> supports the property <code>Foo</code>, <code>C</code> supports
<code>Bar</code>, and <code>B</code> supersedes both <code>Foo</code> and <code>Bar</code>,
@@ -316,11 +316,11 @@ interface XPropertyHandler
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 <type>LineDescriptor</type>,
- which the <type>XPropertyHandler</type> fills in its <member>describePropertyLine</member> method.</p>
+ and <member>LineDescriptor::HasSecondaryButton</member> members of a LineDescriptor,
+ which the XPropertyHandler fills in its <member>describePropertyLine</member> method.</p>
<p>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 <type>InteractiveSelectionResult</type>).</p>
+ property value, and return the result of this (see InteractiveSelectionResult).</p>
<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
@@ -412,7 +412,7 @@ interface XPropertyHandler
/** suspends the handler
- <p>A <type>XPropertyHandler</type> is used by a <type>XObjectInspector</type> instance,
+ <p>A XPropertyHandler is used by a XObjectInspector instance,
which implements the XController interface. By definition, a XObjectInspector always forwards
all suspend requests (<member scope="com::sun::star::frame">XController::suspend</member>) to
all it's handlers.</p>
@@ -421,7 +421,7 @@ interface XPropertyHandler
for property value input. Such a component might have been opened during
<member>onInteractivePropertySelection</member>. If a property handler receives a
<member>suspend</member> call, it should forward the suspension request to the UI
- component, and veto suspension of the <type>XObjectInspector</type> as appropriate.</p>
+ component, and veto suspension of the XObjectInspector as appropriate.</p>
<p>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 <member>suspend</member> call.</p>
diff --git a/offapi/com/sun/star/inspection/XStringListControl.idl b/offapi/com/sun/star/inspection/XStringListControl.idl
index b6b21d2e9375..caf38d601a6a 100644
--- a/offapi/com/sun/star/inspection/XStringListControl.idl
+++ b/offapi/com/sun/star/inspection/XStringListControl.idl
@@ -24,12 +24,12 @@
module com { module sun { module star { module inspection {
-/** defines the interface for an <type>XPropertyControl</type> which, additionally
+/** defines the interface for an XPropertyControl which, additionally
to the basic behavior, supports a list of strings interpreted as possible
property values.
<p>A control which would canonically implement this interface is a list box control:
- The string list defined by <type>XStringListControl</type> would in the control be
+ The string list defined by XStringListControl would in the control be
represented as drop-down list containing all the strings.</p>
@since OOo 2.0.3