diff options
| author | Michael Stahl <mstahl@redhat.com> | 2013-04-28 00:27:46 +0200 |
|---|---|---|
| committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:04 +0200 |
| commit | 6e1d239ae04bbb1b639ae8d04c59d3375f867712 (patch) | |
| tree | f4ce26e51900176ae95320652fb31404144a54eb /offapi | |
| parent | be7f280ea7034a1cb1195a3d27b51d1b9626b905 (diff) | |
*api: convert <true/> <false/> <void/>
sed -i 's,<\(true\|false\|void\)/>,`\U\1`,g'
Change-Id: I87a6e81ff22b47ea979322d01c49350892d3945f
Diffstat (limited to 'offapi')
45 files changed, 120 insertions, 120 deletions
diff --git a/offapi/com/sun/star/accessibility/XAccessibleText.idl b/offapi/com/sun/star/accessibility/XAccessibleText.idl index b0df77f94083..d43255f4f3f3 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleText.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleText.idl @@ -478,7 +478,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface The valid range is 0..length. @return - Returns <true/> if the specified text has been copied + Returns `TRUE` if the specified text has been copied successfully into the clipboard. @throws ::com::sun::star::lang::IndexOutOfBoundsException diff --git a/offapi/com/sun/star/animations/XAnimateColor.idl b/offapi/com/sun/star/animations/XAnimateColor.idl index a2bc57f72cad..5bf3084476ef 100644 --- a/offapi/com/sun/star/animations/XAnimateColor.idl +++ b/offapi/com/sun/star/animations/XAnimateColor.idl @@ -47,7 +47,7 @@ interface XAnimateColor : XAnimate /** defines the direction which is used to perform the interpolation inside the color space defined with #ColorSpace. <br> - Values could be <true/> for clockwise and <false/> for counterclockwise. + Values could be `TRUE` for clockwise and `FALSE` for counterclockwise. This attribute will be ignored for color spaces where this does not make any sense. diff --git a/offapi/com/sun/star/animations/XAnimationNode.idl b/offapi/com/sun/star/animations/XAnimationNode.idl index 06b5454cee5a..7658e2e5d088 100644 --- a/offapi/com/sun/star/animations/XAnimationNode.idl +++ b/offapi/com/sun/star/animations/XAnimationNode.idl @@ -50,7 +50,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild external event to the element.</li> <li>sequence<any> a sequence of values described above if more than one begin value is defined for this element.</li> - <li><void/> if no begin behavior is defined for this element.</li> + <li>`VOID` if no begin behavior is defined for this element.</li> </ul> @see http://www.w3.org/TR/smil20/smil-timing.html#adef-begin @@ -64,7 +64,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild <li>`double` specifies the length of the simple duration in seconds.</li> <li>Timing::INDEFINITE specifies the simple duration as indefinite.</li> <li>Timing::MEDIA specifies the simple duration as the intrinsic media duration. This is only valid for elements that define media.</li> - <li><void/> the simple duration for the element is defined to be the implicit duration of the element.</li> + <li>`VOID` the simple duration for the element is defined to be the implicit duration of the element.</li> </ul> @see http://www.w3.org/TR/smil20/smil-timing.html#adef-dur @@ -85,7 +85,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild external event to the element.</li> <li>sequence<any> a sequence of values described above if more than one begin value is defined for this element.</li> - <li><void/> if no end behavior is defined for this element.</li> + <li>`VOID` if no end behavior is defined for this element.</li> </ul> @see http://www.w3.org/TR/smil20/smil-timing.html#adef-end @@ -102,7 +102,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild #EndSync is either a `short` constant from EndSync, an interface reference to a child XTimeContainer - or <void/>. + or `VOID`. @see http://www.w3.org/TR/smil20/smil-timing.html#adef-endsync */ @@ -119,7 +119,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild Values must be greater than 0.</li> <li>Timing::INDEFINITE the element is defined to repeat indefinitely (subject to the constraints of the parent time container).</li> - <li><void/> + <li>`VOID` no repeat count is defined for this element.</li> </ul> @@ -137,7 +137,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild to repeat the simple duration in seconds.</li> <li>Timing::INDEFINITE the element is defined to repeat indefinitely (subject to the constraints of the parent time container).</li> - <li><void/> + <li>`VOID` No repeat duration is defined for this element. </li> </ul> @@ -226,8 +226,8 @@ interface XAnimationNode : ::com::sun::star::container::XChild #AutoRevers is <ul> - <li><false/> if the animation is played normal.</li> - <li><true/> if the animation is played forwards and then backwards. This doubles the duration</li> + <li>`FALSE` if the animation is played normal.</li> + <li>`TRUE` if the animation is played forwards and then backwards. This doubles the duration</li> </ul> @see http://www.w3.org/TR/smil20/smil-timemanip.html#adef-autoReverse diff --git a/offapi/com/sun/star/animations/XTransitionFilter.idl b/offapi/com/sun/star/animations/XTransitionFilter.idl index 8cc010997c6b..2f0921f149c1 100644 --- a/offapi/com/sun/star/animations/XTransitionFilter.idl +++ b/offapi/com/sun/star/animations/XTransitionFilter.idl @@ -51,22 +51,22 @@ interface XTransitionFilter : XAnimate [attribute] short Subtype; /** Indicates whether the transitionFilter's parent element will transition in or out. - Legal values are <true/> indicating that the parent media will become more visible as - the transition progress increases and <false/> indicating that the parent media will + Legal values are `TRUE` indicating that the parent media will become more visible as + the transition progress increases and `FALSE` indicating that the parent media will become less visible as the transition progress increases. - The default value is <true/>. + The default value is `TRUE`. */ [attribute] boolean Mode; /** This specifies the direction the transition will run. <br> - The legal values are <true/> for forward and <false/> for reverse. - The default value is <true/>. + The legal values are `TRUE` for forward and `FALSE` for reverse. + The default value is `TRUE`. Note that this does not impact the media being transitioned to, but only affects the geometry of the transition. Transitions which do not have a reverse interpretation should ignore the - direction attribute and assume the default value of <true/>. + direction attribute and assume the default value of `TRUE`. */ [attribute] boolean Direction; diff --git a/offapi/com/sun/star/awt/XControl.idl b/offapi/com/sun/star/awt/XControl.idl index b83c130f32dd..cc00f48e996a 100644 --- a/offapi/com/sun/star/awt/XControl.idl +++ b/offapi/com/sun/star/awt/XControl.idl @@ -96,12 +96,12 @@ published interface XControl: com::sun::star::lang::XComponent void setDesignMode( [in] boolean bOn ); - /** returns <true/> if the control is in design mode, <false/> otherwise. + /** returns `TRUE` if the control is in design mode, `FALSE` otherwise. */ boolean isDesignMode(); - /** returns <true/> if the control is transparent, <false/> otherwise. + /** returns `TRUE` if the control is transparent, `FALSE` otherwise. */ boolean isTransparent(); diff --git a/offapi/com/sun/star/awt/XListBox.idl b/offapi/com/sun/star/awt/XListBox.idl index a7441cbc8afd..e4582086d142 100644 --- a/offapi/com/sun/star/awt/XListBox.idl +++ b/offapi/com/sun/star/awt/XListBox.idl @@ -127,8 +127,8 @@ published interface XListBox: com::sun::star::uno::XInterface [in] boolean bSelect ); - /** returns <true/> if multiple items can be selected, - <false/> if only one item can be selected. + /** returns `TRUE` if multiple items can be selected, + `FALSE` if only one item can be selected. */ boolean isMutipleMode(); diff --git a/offapi/com/sun/star/awt/XRadioButton.idl b/offapi/com/sun/star/awt/XRadioButton.idl index 519a91968c1a..de3e33efae7c 100644 --- a/offapi/com/sun/star/awt/XRadioButton.idl +++ b/offapi/com/sun/star/awt/XRadioButton.idl @@ -44,7 +44,7 @@ published interface XRadioButton: com::sun::star::uno::XInterface void removeItemListener( [in] com::sun::star::awt::XItemListener l ); - /** returns <true/> if the button is checked, <false/> otherwise. + /** returns `TRUE` if the button is checked, `FALSE` otherwise. */ boolean getState(); diff --git a/offapi/com/sun/star/awt/XVclWindowPeer.idl b/offapi/com/sun/star/awt/XVclWindowPeer.idl index 08169561a164..8023c112ac2e 100644 --- a/offapi/com/sun/star/awt/XVclWindowPeer.idl +++ b/offapi/com/sun/star/awt/XVclWindowPeer.idl @@ -36,7 +36,7 @@ published interface XVclWindowPeer: com::sun::star::awt::XWindowPeer { - /** returns <true/> if the window peer is a child, <false/> otherwise. + /** returns `TRUE` if the window peer is a child, `FALSE` otherwise. */ boolean isChild( [in] com::sun::star::awt::XWindowPeer Peer ); @@ -46,8 +46,8 @@ published interface XVclWindowPeer: com::sun::star::awt::XWindowPeer void setDesignMode( [in] boolean bOn ); - /** returns <true/> if the window peer is in design mode, - <false/> otherwise. + /** returns `TRUE` if the window peer is in design mode, + `FALSE` otherwise. */ boolean isDesignMode(); diff --git a/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl b/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl index 0aba0fa43c4c..ef2fed2637ff 100644 --- a/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl +++ b/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl @@ -66,7 +66,7 @@ published service UnoControlGridModel <p>The value given here is ignored if #ShowColumnHeader is <FALSE/>.</p> - <p>If the property is <void/>, the grid control shall automatically determine a height which conveniently allows, + <p>If the property is `VOID`, the grid control shall automatically determine a height which conveniently allows, according to the used font, to display one line of text.</p> */ [property, maybevoid] long ColumnHeaderHeight; diff --git a/offapi/com/sun/star/awt/grid/XGridColumn.idl b/offapi/com/sun/star/awt/grid/XGridColumn.idl index 5858548e7456..a8d05201c2e2 100644 --- a/offapi/com/sun/star/awt/grid/XGridColumn.idl +++ b/offapi/com/sun/star/awt/grid/XGridColumn.idl @@ -90,7 +90,7 @@ published interface XGridColumn */ [attribute] ::com::sun::star::style::HorizontalAlignment HorizontalAlign; - /** A title is displayed in the column header row if <method>UnoControlGridModel::ShowRowHeader</method> is set to <true/>**/ + /** A title is displayed in the column header row if <method>UnoControlGridModel::ShowRowHeader</method> is set to `TRUE`**/ [attribute] string Title; /** is the help text associated with the column. diff --git a/offapi/com/sun/star/awt/grid/XGridRowSelection.idl b/offapi/com/sun/star/awt/grid/XGridRowSelection.idl index 78e3a98ccbcc..54e188ebde05 100644 --- a/offapi/com/sun/star/awt/grid/XGridRowSelection.idl +++ b/offapi/com/sun/star/awt/grid/XGridRowSelection.idl @@ -67,7 +67,7 @@ published interface XGridRowSelection /** Returns whether rows are selected. @returns - <true/> if and only if at least one row is selected. + `TRUE` if and only if at least one row is selected. */ boolean hasSelectedRows(); @@ -75,10 +75,10 @@ published interface XGridRowSelection @param RowIndex the index of a row. If the value does not denote a valid row index, i.e. is smaller than <code>0</code> - or greater than the number of rows, this is silently ignored, and <false/> is returned. + or greater than the number of rows, this is silently ignored, and `FALSE` is returned. @returns - <true/> if and only if there is a row with the given index, and it is selected currently. + `TRUE` if and only if there is a row with the given index, and it is selected currently. */ boolean isRowSelected( [in] long RowIndex ); diff --git a/offapi/com/sun/star/chart2/Legend.idl b/offapi/com/sun/star/chart2/Legend.idl index 1969ec68824e..2f85e5e4599d 100644 --- a/offapi/com/sun/star/chart2/Legend.idl +++ b/offapi/com/sun/star/chart2/Legend.idl @@ -79,7 +79,7 @@ service Legend <p>If a relative position is given the legend is not automatically placed, but instead is placed relative on the page.</p> - <p>If <void/>, the legend position is solely determined by the + <p>If `VOID`, the legend position is solely determined by the #AnchorPosition.</p> */ [property, maybevoid] ::com::sun::star::chart2::RelativePosition RelativePosition; diff --git a/offapi/com/sun/star/configuration/backend/BackendSetupException.idl b/offapi/com/sun/star/configuration/backend/BackendSetupException.idl index 0253ef5c389d..50ff7470620b 100644 --- a/offapi/com/sun/star/configuration/backend/BackendSetupException.idl +++ b/offapi/com/sun/star/configuration/backend/BackendSetupException.idl @@ -35,7 +35,7 @@ module backend { published exception BackendSetupException : ::com::sun::star::configuration::CannotLoadConfigurationException { /** The exception that is raised by the underlying backend implementation. - <p>May be a numeric error code, a message `string` or <void/>, + <p>May be a numeric error code, a message `string` or `VOID`, if the original exception is not represented as a com::sun::star::uno::Exception. </p> diff --git a/offapi/com/sun/star/configuration/backend/DataImporter.idl b/offapi/com/sun/star/configuration/backend/DataImporter.idl index 42c61e98f9f5..0250a49e3ecd 100644 --- a/offapi/com/sun/star/configuration/backend/DataImporter.idl +++ b/offapi/com/sun/star/configuration/backend/DataImporter.idl @@ -47,7 +47,7 @@ published service DataImporter that indicates the status of job execution. The type and meaning of such status indicators depend on the implementation. </p> - <p>If <void/> or <TRUE/> is returned, this indicates successful + <p>If `VOID` or <TRUE/> is returned, this indicates successful execution. If an com::sun::star::uno::Exception is returned, it represents an error condition encountered during execution. diff --git a/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl b/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl index 8d9bf296193b..be3af71ea7fb 100644 --- a/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl +++ b/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl @@ -48,14 +48,14 @@ published service LocalDataImporter /** provides for running an import job - <p> The implementation returns <void/> from + <p> The implementation returns `VOID` from com::sun::star::task::XJob::execute() to indicates successful execution. If import is not executed, because <code>OverwriteExisting = </code><TRUE/> was specified, a com::sun::star::lang::IllegalAccessException is returned. </p> - <p>If <void/> or <TRUE/> is returned, this indicates successful + <p>If `VOID` or <TRUE/> is returned, this indicates successful execution. If an com::sun::star::uno::Exception is returned, it represents an error condition encountered during execution. diff --git a/offapi/com/sun/star/configuration/backend/MalformedDataException.idl b/offapi/com/sun/star/configuration/backend/MalformedDataException.idl index 2bf895353e82..b4174d3c31b7 100644 --- a/offapi/com/sun/star/configuration/backend/MalformedDataException.idl +++ b/offapi/com/sun/star/configuration/backend/MalformedDataException.idl @@ -66,7 +66,7 @@ published exception MalformedDataException: ::com::sun::star::uno::Exception <dd>for features that are not supported by the current implementation.</dd> </dl> </p> - <p> If no more detail information is available, this may be left <void/>. + <p> If no more detail information is available, this may be left `VOID`. </p> */ any ErrorDetails; diff --git a/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl b/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl index 4f253995e9d0..fad277e77fb1 100644 --- a/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl +++ b/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl @@ -48,7 +48,7 @@ exception MergeRecoveryRequest: ::com::sun::star::uno::Exception <dd>for layers that can't be accessed.</dd> </dl> </p> - <p> If no more detail information is available, this may be left <void/>. + <p> If no more detail information is available, this may be left `VOID`. </p> */ any ErrorDetails; diff --git a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl index 8212f2e7132d..50d02ed27184 100644 --- a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl @@ -296,7 +296,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface (as indicated by com::sun::star::uno::TypeClass::ANY.) </p> - <p> A <void/> type indicates that the type is unspecified + <p> A `VOID` type indicates that the type is unspecified in this layer. In this case any subsequent value may be of a generic type (e.g. `string` or - for list values - @@ -345,7 +345,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface <p> The value must match the type of the current property. If the property does not have the SchemaAttribute::REQUIRED flag set, - the value can be <void/>. + the value can be `VOID`. </p> <p> If the current property is localized, this value applies to the default locale. @@ -379,7 +379,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface <p> The value must match the type of the current property. If the property does not have the SchemaAttribute::REQUIRED flag set, - the value can be <void/>. + the value can be `VOID`. </p> @param aLocale @@ -427,7 +427,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface raises( MalformedDataException, com::sun::star::lang::WrappedTargetException ); - /** receives notification that a property having a <void/> value is added + /** receives notification that a property having a `VOID` value is added to the current node. <p> The current node must be extensible. @@ -473,7 +473,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface com::sun::star::lang::WrappedTargetException ); - /** receives notification that a property having a non-<void/> value + /** receives notification that a property having a non-`VOID` value is added to the current node. <p> The current node must be extensible. @@ -499,7 +499,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface specifies the value of the new property. <p> The value also determines the type. - Therefore the value must not be <void/>. + Therefore the value must not be `VOID`. </p> @throws com::sun::star::configuration::backend::MalformedDataException @@ -507,7 +507,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface <li>if there isn't an extensible node in progress currently</li> <li>if a property with that name already exists</li> <li>if the type of the value is not an allowed type - or if the value is <void/></li> + or if the value is `VOID`</li> <li>if the name is not a valid property name</li> <li>if the value is not valid for the property</li> <li>if the attributes are not valid for the property</li> diff --git a/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl b/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl index 024bf70d4d52..531079c4b690 100644 --- a/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl @@ -415,7 +415,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface specifies the value of the new property. <p> The value also determines the type. - Therefore the value must not be <void/>. + Therefore the value must not be `VOID`. </p> @throws com::sun::star::configuration::backend::MalformedDataException @@ -423,7 +423,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface <li>if there isn't a group or extensible node in progress currently</li> <li>if a property with the same name already exists</li> <li>if the type of the default value is not an allowed type, - or if the default value is <void/></li> + or if the default value is `VOID`</li> <li>if the name is not a valid property name</li> <li>if the attributes are not valid for a property</li> </ul> diff --git a/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl b/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl index 1e96fc338a31..0c75533de71e 100644 --- a/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl @@ -315,7 +315,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface @param aType specifies the type of the property. - <p> A <void/> type can be used to signify that + <p> A `VOID` type can be used to signify that the type is unknown and should not be recorded. </p> @@ -351,7 +351,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface <p> The value must match the type of the existing property. If the property does not have the SchemaAttribute::REQUIRED flag set, - the value can be <void/>. + the value can be `VOID`. </p> @throws com::sun::star::configuration::backend::MalformedDataException @@ -381,7 +381,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface <p> The value must match the type of the existing property. If the property does not have the SchemaAttribute::REQUIRED flag set, - the value can be <void/>. + the value can be `VOID`. </p> @param aLocale @@ -495,7 +495,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface raises( MalformedDataException, com::sun::star::lang::WrappedTargetException ); - /** receives notification that a property having a value of <void/> + /** receives notification that a property having a value of `VOID` is added to the current node. <p> The current node must be extensible and @@ -572,7 +572,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface specifies the value of the new property. <p> The value also determines the type. - Therefore the value must not be <void/>. + Therefore the value must not be `VOID`. </p> @throws com::sun::star::configuration::backend::MalformedDataException @@ -581,7 +581,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface <li>if there already was a change to a property of that name</li> <li>if a property of that name exists and is not removable</li> <li>if the type of the value is not an allowed type, - or if the value is <void/></li> + or if the value is `VOID`</li> <li>if the name is not a valid property name</li> <li>if the attributes are not valid for the property</li> </ul> diff --git a/offapi/com/sun/star/deployment/XPackageTypeInfo.idl b/offapi/com/sun/star/deployment/XPackageTypeInfo.idl index 2e347545b856..426b0aa6e529 100644 --- a/offapi/com/sun/star/deployment/XPackageTypeInfo.idl +++ b/offapi/com/sun/star/deployment/XPackageTypeInfo.idl @@ -76,7 +76,7 @@ interface XPackageTypeInfo @return currently an unsigned short (resource id for deploymentgui resource file), - <void/> any if none is available + `VOID` any if none is available */ any getIcon( [in] boolean highContrast, [in] boolean smallIcon ); }; diff --git a/offapi/com/sun/star/drawing/CaptionShape.idl b/offapi/com/sun/star/drawing/CaptionShape.idl index 1b0998d0e92a..548a85b34f56 100644 --- a/offapi/com/sun/star/drawing/CaptionShape.idl +++ b/offapi/com/sun/star/drawing/CaptionShape.idl @@ -73,7 +73,7 @@ published service CaptionShape /** This property specifies if the escape angle of the line of a caption is fixed or free. If this - is set to <false/>, the application can choose + is set to `FALSE`, the application can choose the best possible angle. If not, the value in <code>CaptionAngle</code> is used. */ @@ -82,7 +82,7 @@ published service CaptionShape /** This property specifies the escape angle of the line of a caption. It is only used if <code>CaptionIsFixedAngle</code> - is set to <true/> + is set to `TRUE` */ [property] long CaptionAngle; @@ -98,7 +98,7 @@ published service CaptionShape */ [property] long CaptionEscapeDirection; - /** If this property is <true/>, the property <code>CaptionEscapeRelative</code> + /** If this property is `TRUE`, the property <code>CaptionEscapeRelative</code> is used, else the property <code>CaptionEscapeAbsolute</code> is used. */ [property] boolean CaptionIsEscapeRelative; @@ -117,7 +117,7 @@ published service CaptionShape */ [property] long CaptionLineLength; - /** If this property is <true/>, the application determines + /** If this property is `TRUE`, the application determines the best possible length for the caption line. */ [property] boolean CaptionIsFitLineLength; diff --git a/offapi/com/sun/star/inspection/XPropertyControl.idl b/offapi/com/sun/star/inspection/XPropertyControl.idl index eab2ce6069e3..232517f1d971 100644 --- a/offapi/com/sun/star/inspection/XPropertyControl.idl +++ b/offapi/com/sun/star/inspection/XPropertyControl.idl @@ -40,11 +40,11 @@ interface XPropertyControl /** denotes the current content of the control. - <p>At every point in time, this value is either <void/>, or of the type + <p>At every point in time, this value is either `VOID`, or of the type described by #ValueType.</p> @throws com::sun::star::beans::IllegalTypeException - if an attempt is made to set a value which is not <void/> and whose + if an attempt is made to set a value which is not `VOID` and whose type does not equal #ValueType. */ [attribute] any Value diff --git a/offapi/com/sun/star/presentation/DrawPage.idl b/offapi/com/sun/star/presentation/DrawPage.idl index 4a6eb35a7d96..18e499e81420 100644 --- a/offapi/com/sun/star/presentation/DrawPage.idl +++ b/offapi/com/sun/star/presentation/DrawPage.idl @@ -132,13 +132,13 @@ published service DrawPage /** defines the text that is displayed in a date and time textfield rendered on this - page. This value is only used if <code>IsDateTimeFixed</code> is <true/>. + page. This value is only used if <code>IsDateTimeFixed</code> is `TRUE`. */ [optional, property] string DateTimeText; /** defines the format that is used to format a date and time text field on - this page. This is only used if <code>IsDateTimeFixed</code> is <false/>. + this page. This is only used if <code>IsDateTimeFixed</code> is `FALSE`. */ [optional, property] long DateTimeFormat; diff --git a/offapi/com/sun/star/sdb/ColumnSettings.idl b/offapi/com/sun/star/sdb/ColumnSettings.idl index 3c0a45a760f2..72334d212e1e 100644 --- a/offapi/com/sun/star/sdb/ColumnSettings.idl +++ b/offapi/com/sun/star/sdb/ColumnSettings.idl @@ -40,7 +40,7 @@ published service ColumnSettings </p> <p> If the value is - <void/> + `VOID` , a default number format should be used according to the datatype of the column. </p> @@ -57,7 +57,7 @@ published service ColumnSettings </pre> <p> If the value is - <void/> + `VOID` , a default alignment should be used according to the datatype of the column. </p> @@ -69,7 +69,7 @@ published service ColumnSettings <p> If the value is - <void/> + `VOID` , a default width should be used according to the label of the column. </p> */ @@ -80,7 +80,7 @@ published service ColumnSettings <p> If the value is - <void/> + `VOID` , the default position should be taken according. </p> */ diff --git a/offapi/com/sun/star/sdbc/XSQLInput.idl b/offapi/com/sun/star/sdbc/XSQLInput.idl index 5ed9a72e0a08..bc504e8142d0 100644 --- a/offapi/com/sun/star/sdbc/XSQLInput.idl +++ b/offapi/com/sun/star/sdbc/XSQLInput.idl @@ -198,7 +198,7 @@ published interface XSQLInput: com::sun::star::uno::XInterface <br/> When the datum at the head of the stream is a SQL NULL, - the method returns <void/>. If the datum is a SQL structured or distinct + the method returns `VOID`. If the datum is a SQL structured or distinct type, it determines the SQL type of the datum at the head of the stream, constructs an object of the appropriate service, and calls the method com::sun::star::sdbc::XSQLData::readSQL() diff --git a/offapi/com/sun/star/sdbc/XWarningsSupplier.idl b/offapi/com/sun/star/sdbc/XWarningsSupplier.idl index a6a439f0561a..92d85a698b82 100644 --- a/offapi/com/sun/star/sdbc/XWarningsSupplier.idl +++ b/offapi/com/sun/star/sdbc/XWarningsSupplier.idl @@ -53,7 +53,7 @@ published interface XWarningsSupplier: com::sun::star::uno::XInterface After a call to this method, the method com::sun::star::sdbc::XWarningsSupplier::getWarnings() returns - <void/> + `VOID` until a new warning is reported for the object. @throws SQLException if a database access error occurs. diff --git a/offapi/com/sun/star/sheet/AddIn.idl b/offapi/com/sun/star/sheet/AddIn.idl index 9bbe7213200b..873f33050215 100644 --- a/offapi/com/sun/star/sheet/AddIn.idl +++ b/offapi/com/sun/star/sheet/AddIn.idl @@ -68,7 +68,7 @@ module com { module sun { module star { module sheet { <dt>`any`</dt> <dd>Depending on the data, a `double`, a `string`, or an `any[][]` will be passed. If no argument is specified in - the function call, <void/> will be passed. This allows for optional + the function call, `VOID` will be passed. This allows for optional parameters.</dd> <dt>com::sun::star::table::XCellRange</dt> diff --git a/offapi/com/sun/star/sheet/XDataPilotTable2.idl b/offapi/com/sun/star/sheet/XDataPilotTable2.idl index 9b5a8648852a..4c1ef21618b8 100644 --- a/offapi/com/sun/star/sheet/XDataPilotTable2.idl +++ b/offapi/com/sun/star/sheet/XDataPilotTable2.idl @@ -82,7 +82,7 @@ interface XDataPilotTable2: com::sun::star::sheet::XDataPilotTable @param aAddr address of a result cell - @returns <void/> + @returns `VOID` */ void insertDrillDownSheet( [in] com::sun::star::table::CellAddress aAddr ); diff --git a/offapi/com/sun/star/sheet/XExternalDocLink.idl b/offapi/com/sun/star/sheet/XExternalDocLink.idl index 023db9238152..a19b50088038 100644 --- a/offapi/com/sun/star/sheet/XExternalDocLink.idl +++ b/offapi/com/sun/star/sheet/XExternalDocLink.idl @@ -51,9 +51,9 @@ interface XExternalDocLink @param aSheetName sheet name @param DynamicCache specify whether or not the cache can grow when - non-cached regions are queried. If <true/>, querying a non-cached + non-cached regions are queried. If `TRUE`, querying a non-cached cell in this sheet cache will allow Calc to try to access the source - document to fetch the value in first access. If <false/>, the source + document to fetch the value in first access. If `FALSE`, the source document will not be accessed, and the non-cached regions are treated as empty cells. diff --git a/offapi/com/sun/star/sheet/XFunctionAccess.idl b/offapi/com/sun/star/sheet/XFunctionAccess.idl index 5fc4f10de034..bf7abce711ea 100644 --- a/offapi/com/sun/star/sheet/XFunctionAccess.idl +++ b/offapi/com/sun/star/sheet/XFunctionAccess.idl @@ -58,7 +58,7 @@ published interface XFunctionAccess: com::sun::star::uno::XInterface <dd>for an array of textual values.</dd> <dt>`any[][]`</dt> - <dd>for a mixed array, where each element must be of <void/>, + <dd>for a mixed array, where each element must be of `VOID`, `long`, `double` or `string` type.</dd> @@ -73,7 +73,7 @@ published interface XFunctionAccess: com::sun::star::uno::XInterface <p>Possible types for the result are:</p> <dl> - <dt><void/></dt> + <dt>`VOID`</dt> <dd>if no result is available.</dd> <dt>`double`</dt> diff --git a/offapi/com/sun/star/text/MailMerge.idl b/offapi/com/sun/star/text/MailMerge.idl index c2b3cb3a4cd4..15ab38b1cdd1 100644 --- a/offapi/com/sun/star/text/MailMerge.idl +++ b/offapi/com/sun/star/text/MailMerge.idl @@ -257,7 +257,7 @@ published service MailMerge /** determines that the created mail merge document is sent as body in HTML format. - This property is only valid if the property "SendAsAttachment" is set to <false/>. + This property is only valid if the property "SendAsAttachment" is set to `FALSE`. <p>This property is only evaluated for e-Mail output.</p> @@ -277,7 +277,7 @@ published service MailMerge /** contains the text of the mail body. - This property is only valid if the property "SendAsAttachment" is set to <true/> + This property is only valid if the property "SendAsAttachment" is set to `TRUE` <p>This property is only evaluated for e-Mail output.</p> @since OOo 2.0 @@ -286,7 +286,7 @@ published service MailMerge /** contains the name of the attachment. - This property is only valid if "SendAsAttachment" is set to <true/>. + This property is only valid if "SendAsAttachment" is set to `TRUE`. <p>This property is only evaluated for e-Mail output.</p> @@ -296,7 +296,7 @@ published service MailMerge /** contains the name of the document filter to save the attached mail merge document. - This property is only valid if "SendAsAttachment" is set to <true/>. + This property is only valid if "SendAsAttachment" is set to `TRUE`. <p>This property is only evaluated for e-Mail output.</p> diff --git a/offapi/com/sun/star/text/TextSection.idl b/offapi/com/sun/star/text/TextSection.idl index 51ea83e94bd5..18967c9facf3 100644 --- a/offapi/com/sun/star/text/TextSection.idl +++ b/offapi/com/sun/star/text/TextSection.idl @@ -56,8 +56,8 @@ published service TextSection /** This property contains a conditional expression. - <p>If the result of the conditional expression is <true/> and the property - TextSection::IsVisible is <false/>, then the section is hidden.</p> + <p>If the result of the conditional expression is `TRUE` and the property + TextSection::IsVisible is `FALSE`, then the section is hidden.</p> */ [property] string Condition; diff --git a/offapi/com/sun/star/text/XParagraphCursor.idl b/offapi/com/sun/star/text/XParagraphCursor.idl index 08b5bac0d273..d7986130bdd8 100644 --- a/offapi/com/sun/star/text/XParagraphCursor.idl +++ b/offapi/com/sun/star/text/XParagraphCursor.idl @@ -44,8 +44,8 @@ published interface XParagraphCursor: com::sun::star::text::XTextCursor /** moves the cursor to the start of the current paragraph. @returns - <true/> if the cursor is now at the start of a paragraph, - <false/> otherwise. If <false/> was returned the cursor + `TRUE` if the cursor is now at the start of a paragraph, + `FALSE` otherwise. If `FALSE` was returned the cursor will remain at its original position. */ boolean gotoStartOfParagraph( [in] boolean bExpand ); @@ -54,8 +54,8 @@ published interface XParagraphCursor: com::sun::star::text::XTextCursor /** moves the cursor to the end of the current paragraph. @returns - <true/> if the cursor is now at the end of a paragraph, - <false/> otherwise. If <false/> was returned the cursor + `TRUE` if the cursor is now at the end of a paragraph, + `FALSE` otherwise. If `FALSE` was returned the cursor will remain at its original position. */ boolean gotoEndOfParagraph( [in] boolean bExpand ); @@ -64,7 +64,7 @@ published interface XParagraphCursor: com::sun::star::text::XTextCursor /** moves the cursor to the next paragraph. @returns - <true/> if the cursor was moved. It returns <false/> it the + `TRUE` if the cursor was moved. It returns `FALSE` it the cursor can not advance further. */ boolean gotoNextParagraph( [in] boolean bExpand ); @@ -73,7 +73,7 @@ published interface XParagraphCursor: com::sun::star::text::XTextCursor /** moves the cursor to the previous paragraph. @returns - <true/> if the cursor was moved. It returns <false/> it the + `TRUE` if the cursor was moved. It returns `FALSE` it the cursor can not advance further. */ boolean gotoPreviousParagraph( [in] boolean bExpand ); diff --git a/offapi/com/sun/star/text/XSentenceCursor.idl b/offapi/com/sun/star/text/XSentenceCursor.idl index e6cb0919ab8c..d8a0da6f058c 100644 --- a/offapi/com/sun/star/text/XSentenceCursor.idl +++ b/offapi/com/sun/star/text/XSentenceCursor.idl @@ -44,7 +44,7 @@ published interface XSentenceCursor: com::sun::star::text::XTextCursor /** moves the cursor to the start of the next sentence. @returns - <true/> if the cursor was moved. It returns <false/> it the + `TRUE` if the cursor was moved. It returns `FALSE` it the cursor can not advance further. */ boolean gotoNextSentence( [in] boolean Expand ); @@ -53,7 +53,7 @@ published interface XSentenceCursor: com::sun::star::text::XTextCursor /** moves the cursor to the start of the previous sentence. @returns - <true/> if the cursor was moved. It returns <false/> it the + `TRUE` if the cursor was moved. It returns `FALSE` it the cursor can not advance further. */ boolean gotoPreviousSentence( [in] boolean Expand ); @@ -62,8 +62,8 @@ published interface XSentenceCursor: com::sun::star::text::XTextCursor /** moves the cursor to the start of the current sentence. @returns - <true/> if the cursor is now at the start of a sentence, - <false/> otherwise. If <false/> was returned the cursor + `TRUE` if the cursor is now at the start of a sentence, + `FALSE` otherwise. If `FALSE` was returned the cursor will remain at its original position. */ boolean gotoStartOfSentence( [in] boolean Expand ); @@ -72,8 +72,8 @@ published interface XSentenceCursor: com::sun::star::text::XTextCursor /** moves the cursor to the end of the current sentence. @returns - <true/> if the cursor is now at the end of a sentence, - <false/> otherwise. If <false/> was returned the cursor + `TRUE` if the cursor is now at the end of a sentence, + `FALSE` otherwise. If `FALSE` was returned the cursor will remain at its original position. */ boolean gotoEndOfSentence( [in] boolean Expand ); diff --git a/offapi/com/sun/star/text/XTextTableCursor.idl b/offapi/com/sun/star/text/XTextTableCursor.idl index 5521763f2f75..575ea19a7739 100644 --- a/offapi/com/sun/star/text/XTextTableCursor.idl +++ b/offapi/com/sun/star/text/XTextTableCursor.idl @@ -139,7 +139,7 @@ published interface XTextTableCursor: com::sun::star::uno::XInterface for each cell contained in the range. @param bHorizontal - <true/> if the range should be split vertically. + `TRUE` if the range should be split vertically. Otherwise it will be split horizontally. @see com:sun::star::Cell diff --git a/offapi/com/sun/star/text/XWordCursor.idl b/offapi/com/sun/star/text/XWordCursor.idl index a8621a8c061a..52c877def965 100644 --- a/offapi/com/sun/star/text/XWordCursor.idl +++ b/offapi/com/sun/star/text/XWordCursor.idl @@ -43,12 +43,12 @@ published interface XWordCursor: com::sun::star::text::XTextCursor /** moves the cursor to the next word. - <p>Note: the function returning <true/> does not necessarily mean + <p>Note: the function returning `TRUE` does not necessarily mean that the cursor is located at the next word, or any word at all! This may happen for example if it travels over empty paragraphs.</p> @returns - <true/> if the cursor was moved. It returns <false/> it the + `TRUE` if the cursor was moved. It returns `FALSE` it the cursor can not advance further. */ boolean gotoNextWord( [in] boolean bExpand ); @@ -56,12 +56,12 @@ published interface XWordCursor: com::sun::star::text::XTextCursor /** moves the cursor to the previous word. - <p>Note: the function returning <true/> does not necessarily mean + <p>Note: the function returning `TRUE` does not necessarily mean that the cursor is located at the previous word, or any word at all! This may happen for example if it travels over empty paragraphs.</p> @returns - <true/> if the cursor was moved. It returns <false/> it the + `TRUE` if the cursor was moved. It returns `FALSE` it the cursor can not advance further. */ boolean gotoPreviousWord( [in] boolean bExpand ); @@ -70,8 +70,8 @@ published interface XWordCursor: com::sun::star::text::XTextCursor /** moves the cursor to the end of the current word. @returns - <true/> if the cursor is now at the end of a word, - <false/> otherwise. If <false/> was returned the cursor + `TRUE` if the cursor is now at the end of a word, + `FALSE` otherwise. If `FALSE` was returned the cursor will remain at its original position. */ boolean gotoEndOfWord( [in] boolean bExpand ); @@ -80,8 +80,8 @@ published interface XWordCursor: com::sun::star::text::XTextCursor /** moves the cursor to the start of the current word. @returns - <true/> if the cursor is now at the start of a word, - <false/> otherwise. If <false/> was returned the cursor + `TRUE` if the cursor is now at the start of a word, + `FALSE` otherwise. If `FALSE` was returned the cursor will remain at its original position. */ boolean gotoStartOfWord( [in] boolean bExpand ); diff --git a/offapi/com/sun/star/ucb/FTPContent.idl b/offapi/com/sun/star/ucb/FTPContent.idl index 166a1d1a6b25..87f38b609993 100644 --- a/offapi/com/sun/star/ucb/FTPContent.idl +++ b/offapi/com/sun/star/ucb/FTPContent.idl @@ -128,12 +128,12 @@ published service FTPContent "application/vnd.sun.staroffice.ftp-file" ) </li> <li> - boolean IsDocument ( read-only, always <true/> for files, always - <false/> for directories ) + boolean IsDocument ( read-only, always `TRUE` for files, always + `FALSE` for directories ) </li> <li> - boolean IsFolder ( read-only ), always <false/> for files, always - <true/> for directories ) + boolean IsFolder ( read-only ), always `FALSE` for files, always + `TRUE` for directories ) </li> <li> boolean IsReadOnly ( read-only attribute ) diff --git a/offapi/com/sun/star/ucb/FileContent.idl b/offapi/com/sun/star/ucb/FileContent.idl index 2e9809bdbe93..191b7dff332e 100644 --- a/offapi/com/sun/star/ucb/FileContent.idl +++ b/offapi/com/sun/star/ucb/FileContent.idl @@ -132,12 +132,12 @@ published service FileContent "application/vnd.sun.staroffice.fsys-file" ) </li> <li> - boolean IsDocument ( read-only, always <true/> for files, always - <false/> for directories ) + boolean IsDocument ( read-only, always `TRUE` for files, always + `FALSE` for directories ) </li> <li> - boolean IsFolder ( read-only ), always <false/> for files, always - <true/> for directories ) + boolean IsFolder ( read-only ), always `FALSE` for files, always + `TRUE` for directories ) </li> <li> com::sun::star::util::DateTime DateModified ( read-only ) diff --git a/offapi/com/sun/star/ucb/InteractiveLockingLockedException.idl b/offapi/com/sun/star/ucb/InteractiveLockingLockedException.idl index 268082f222f3..bde18ef43212 100644 --- a/offapi/com/sun/star/ucb/InteractiveLockingLockedException.idl +++ b/offapi/com/sun/star/ucb/InteractiveLockingLockedException.idl @@ -33,8 +33,8 @@ module com { module sun { module star { module ucb { { /** The owner of the lock. - <true/>, the lock has been obtained by this OOo session. - <false/> the lock has been obtained by another principal. + `TRUE`, the lock has been obtained by this OOo session. + `FALSE` the lock has been obtained by another principal. */ boolean SelfOwned; }; diff --git a/offapi/com/sun/star/ucb/UnsupportedNameClashException.idl b/offapi/com/sun/star/ucb/UnsupportedNameClashException.idl index e8154991dc39..9e2179a3cd7b 100644 --- a/offapi/com/sun/star/ucb/UnsupportedNameClashException.idl +++ b/offapi/com/sun/star/ucb/UnsupportedNameClashException.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module ucb { unable to create a valid new name after a suitable number of tries. <p>Command "insert": Used if the parameter ReplaceExisting of the - supplied InsertCommandArgument was set to <false/> and the + supplied InsertCommandArgument was set to `FALSE` and the implementation is unable to determine whether there are existing data. The member NameClash of the exception must be set to NameClash::ERROR diff --git a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl index 28f0ff3ee9b2..5e0427a9b82a 100644 --- a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl +++ b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl @@ -43,7 +43,7 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt com::sun::star::task::XInteractionContinuation::select(), and should only be called if XInteractionSupplyAuthentication::canSetRealm() returned - <true/>.</p> + `TRUE`.</p> */ void setRealm( [in] string Realm ); @@ -57,7 +57,7 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt com::sun::star::task::XInteractionContinuation::select(), and should only be called if XInteractionSupplyAuthentication::canSetUserName() - returned <true/>.</p> + returned `TRUE`.</p> */ void setUserName( [in] string UserName ); @@ -71,7 +71,7 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt com::sun::star::task::XInteractionContinuation::select(), and should only be called if XInteractionSupplyAuthentication::canSetPassword() - returned <true/>.</p> + returned `TRUE`.</p> */ void setPassword( [in] string Password ); @@ -111,7 +111,7 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt com::sun::star::task::XInteractionContinuation::select(), and should only be called if XInteractionSupplyAuthentication::canSetAccount() - returned <true/>.</p> + returned `TRUE`.</p> */ void setAccount( [in] string Account ); diff --git a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl index c775f37f065e..9b13d1fede4e 100644 --- a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl +++ b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl @@ -43,15 +43,15 @@ interface XInteractionSupplyAuthentication2 : XInteractionSupplyAuthentication initially displayed to the user). @returns - <true/> if the issuer is able to obtain and use system credentials. - <false/> otherwise. + `TRUE` if the issuer is able to obtain and use system credentials. + `FALSE` otherwise. */ boolean canUseSystemCredentials( [out] boolean Default ); /** Set a new "use system credentials" value to hand back. @param UseSystemCredentials - <true/> means the request issuer shall obtain and use system credentials. + `TRUE` means the request issuer shall obtain and use system credentials. */ void setUseSystemCredentials( [in] boolean UseSystemCredentials ); diff --git a/offapi/com/sun/star/xml/crypto/sax/XMissionTaker.idl b/offapi/com/sun/star/xml/crypto/sax/XMissionTaker.idl index 4aabc38f89a8..1eef8a679355 100644 --- a/offapi/com/sun/star/xml/crypto/sax/XMissionTaker.idl +++ b/offapi/com/sun/star/xml/crypto/sax/XMissionTaker.idl @@ -39,7 +39,7 @@ interface XMissionTaker : com::sun::star::uno::XInterface /** * Forces a mission to make an end. * - * @return <true/> if the mission is completed successfully, <false/> + * @return `TRUE` if the mission is completed successfully, `FALSE` * otherwise. */ boolean endMission(); diff --git a/offapi/com/sun/star/xml/dom/XNode.idl b/offapi/com/sun/star/xml/dom/XNode.idl index 388375f704d8..fd6aed9c9c8a 100644 --- a/offapi/com/sun/star/xml/dom/XNode.idl +++ b/offapi/com/sun/star/xml/dom/XNode.idl @@ -88,8 +88,8 @@ interface XNode : com::sun::star::uno::XInterface constructor for nodes. <p></p> @param deep - <true/>: clone node together with any children<br> - <false/>: clone without children + `TRUE`: clone node together with any children<br> + `FALSE`: clone without children @returns the cloned node */ |