diff options
| author | Michael Stahl <mstahl@redhat.com> | 2013-04-28 00:44:31 +0200 |
|---|---|---|
| committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:05 +0200 |
| commit | 928b8640c0d1a9c49249100efbdd70f8c1090b07 (patch) | |
| tree | d4f2388c89d137d62bced7b9e8339f964d3632ad /offapi | |
| parent | 6e1d239ae04bbb1b639ae8d04c59d3375f867712 (diff) | |
*api: convert <TRUE/> <FALSE/> <VOID/> <NULL/>
sed -i 's,<\(TRUE\|FALSE\|VOID\|NULL\)/>,`\1`,g'
Change-Id: Ia4df97ca809b00993530d67203bbe4ba7a072201
Diffstat (limited to 'offapi')
452 files changed, 1529 insertions, 1529 deletions
diff --git a/offapi/com/sun/star/accessibility/AccessibleEventId.idl b/offapi/com/sun/star/accessibility/AccessibleEventId.idl index 14b49a155510..4bf58b902d6b 100644 --- a/offapi/com/sun/star/accessibility/AccessibleEventId.idl +++ b/offapi/com/sun/star/accessibility/AccessibleEventId.idl @@ -172,7 +172,7 @@ constants AccessibleEventId <p>Not used: The AccessibleEventObject::OldValue and AccessibleEventObject::NewValue fields contain references to the old and new predecessor. Note that both references - my be <NULL/> to indicate that a flow to the sending object has not + my be `NULL` to indicate that a flow to the sending object has not existed or does not exist anymore.</p> */ const short CONTENT_FLOWS_FROM_RELATION_CHANGED = 12; @@ -183,7 +183,7 @@ constants AccessibleEventId <p>Not used: The AccessibleEventObject::OldValue and AccessibleEventObject::NewValue fields contain references to the old and new successor. Note that both references - my be <NULL/> to indicate that a flow from the sending object has not + my be `NULL` to indicate that a flow from the sending object has not existed or does not exist anymore.</p> */ const short CONTENT_FLOWS_TO_RELATION_CHANGED = 13; diff --git a/offapi/com/sun/star/accessibility/XAccessibleAction.idl b/offapi/com/sun/star/accessibility/XAccessibleAction.idl index fe328b95b885..509d8a294094 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleAction.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleAction.idl @@ -54,10 +54,10 @@ interface XAccessibleAction : ::com::sun::star::uno::XInterface @param nIndex This index specifies the action to perform. If it lies outside - the valid range <FALSE/> is returned and no action is performed. + the valid range `FALSE` is returned and no action is performed. @return - Returns <TRUE/> if the action was successfully performed. If - the action could not be performed successfully <FALSE/> is + Returns `TRUE` if the action was successfully performed. If + the action could not be performed successfully `FALSE` is returned. @throws IndexOutOfBoundsException diff --git a/offapi/com/sun/star/accessibility/XAccessibleComponent.idl b/offapi/com/sun/star/accessibility/XAccessibleComponent.idl index 3baf175759b1..1c41c0952e09 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleComponent.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleComponent.idl @@ -83,7 +83,7 @@ interface XAccessibleComponent : ::com::sun::star::uno::XInterface <p>The test point's coordinates are defined relative to the coordinate system of the object. That means that when the object is an opaque rectangle then both the points (0,0) and (with-1,height-1) - would yield a <TRUE/> value.</p> + would yield a `TRUE` value.</p> @param point Coordinates of the point to test. The origin of the coordinate @@ -93,8 +93,8 @@ interface XAccessibleComponent : ::com::sun::star::uno::XInterface system. @return - Returns <TRUE/> if the point lies within or on the object's bounding - box and <FALSE/> otherwise. + Returns `TRUE` if the point lies within or on the object's bounding + box and `FALSE` otherwise. */ boolean containsPoint ([in] ::com::sun::star::awt::Point aPoint); @@ -103,7 +103,7 @@ interface XAccessibleComponent : ::com::sun::star::uno::XInterface <p>The test point's coordinates are defined relative to the coordinate system of the object. That means that when the object is an opaque rectangle then both the points (0,0) and (with-1,height-1) - would yield a <TRUE/> value.</p> + would yield a `TRUE` value.</p> @param aPoint Coordinates of the test point for which to find the Accessible @@ -181,7 +181,7 @@ interface XAccessibleComponent : ::com::sun::star::uno::XInterface /** Grabs the focus to this object. <p>If this object can not accept the focus, - i.e. isFocusTraversable() returns <FALSE/> for this + i.e. isFocusTraversable() returns `FALSE` for this object then nothing happens. Otherwise the object will attempt to take the focus. Nothing happens if that fails, otherwise the object has the focus. This method is called <code>requestFocus</code> in diff --git a/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl b/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl index c4eff29044c8..5a6a2cac3064 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl @@ -119,8 +119,8 @@ interface XAccessibleHyperlink : like e.g. sending an appropriate event.</p> @return - Returns <TRUE/> if the referenced document is still valid and - <FALSE/> otherwise. + Returns `TRUE` if the referenced document is still valid and + `FALSE` otherwise. */ boolean isValid (); }; diff --git a/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl b/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl index bf31da06c7d1..95db6b1e5b41 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl @@ -74,8 +74,8 @@ interface XAccessibleRelationSet : ::com::sun::star::uno::XInterface AccessibleRelationType. @return - Returns <TRUE/> if there is a (at least one) relation of the - given type and <FALSE/> if there is no such relation in the set. + Returns `TRUE` if there is a (at least one) relation of the + given type and `FALSE` if there is no such relation in the set. */ boolean containsRelation ([in] short aRelationType); diff --git a/offapi/com/sun/star/accessibility/XAccessibleSelection.idl b/offapi/com/sun/star/accessibility/XAccessibleSelection.idl index 05c31704f33f..cc10cca44177 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleSelection.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleSelection.idl @@ -69,7 +69,7 @@ interface XAccessibleSelection : ::com::sun::star::uno::XInterface This index refers to all the children of this object. @return - Returns <TRUE/> if the specified child is selected and <FALSE/> + Returns `TRUE` if the specified child is selected and `FALSE` if it is not selected. @throws ::com::sun::star::lang::IndexOutOfBoundsException if the given index does not lie in the valid range of 0 up to diff --git a/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl b/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl index af64d2ea4e20..910caf843a30 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl @@ -41,8 +41,8 @@ interface XAccessibleStateSet : ::com::sun::star::uno::XInterface /** Checks whether the current state set is empty. @return - Returns <TRUE/> if there is no state in this state set and - <FALSE/> if there is at least one set state in it. + Returns `TRUE` if there is no state in this state set and + `FALSE` if there is at least one set state in it. */ boolean isEmpty (); @@ -54,8 +54,8 @@ interface XAccessibleStateSet : ::com::sun::star::uno::XInterface the constants of AccessibleStateType. @return - Returns <TRUE/> if the given state is a member of this object's - state set and <FALSE/> otherwise. + Returns `TRUE` if the given state is a member of this object's + state set and `FALSE` otherwise. */ boolean contains ([in] short aState); @@ -69,8 +69,8 @@ interface XAccessibleStateSet : ::com::sun::star::uno::XInterface constants of AccessibleStateType. @return - Returns <TRUE/> if all states of the given state set are members - of this object's state set. <FALSE/> is returned if at least + Returns `TRUE` if all states of the given state set are members + of this object's state set. `FALSE` is returned if at least one of the states in the given state is not a member of this object's state set. */ diff --git a/offapi/com/sun/star/accessibility/XAccessibleTable.idl b/offapi/com/sun/star/accessibility/XAccessibleTable.idl index 8082f5dbdd52..0b365ccd3e93 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleTable.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleTable.idl @@ -216,8 +216,8 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface Index of the row for which to determine whether it is selected. @return - Returns <TRUE/> if the specified row is selected completely and - <FALSE/> otherwise. + Returns `TRUE` if the specified row is selected completely and + `FALSE` otherwise. @throws ::com::sun::star::lang::IndexOutOfBoundsException if the specified row index is not valid, i.e. lies not inside @@ -235,8 +235,8 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface selected. @return - Returns <TRUE/> if the specified column is selected completely - and <FALSE/> otherwise. + Returns `TRUE` if the specified column is selected completely + and `FALSE` otherwise. @throws ::com::sun::star::lang::IndexOutOfBoundsException if the specified column index is not valid, i.e. lies not inside @@ -305,9 +305,9 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface accessible object that spans that cell is selected. @return - Returns <TRUE/> if the given row and column indices are valid + Returns `TRUE` if the given row and column indices are valid and the specified accessible object is selected. Otherwise - <FALSE/> is returned. + `FALSE` is returned. */ boolean isAccessibleSelected ([in] long nRow, [in] long nColumn) raises (::com::sun::star::lang::IndexOutOfBoundsException); diff --git a/offapi/com/sun/star/accessibility/XAccessibleText.idl b/offapi/com/sun/star/accessibility/XAccessibleText.idl index d43255f4f3f3..9b5297571e08 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleText.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleText.idl @@ -94,8 +94,8 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface leads to insertion after the last character. @return - Returns <TRUE/> if the caret has been moved and <FALSE/> - otherwise. A <TRUE/> value does not necessarily mean that the + Returns `TRUE` if the caret has been moved and `FALSE` + otherwise. A `TRUE` value does not necessarily mean that the caret has been positioned exactly at the required position. If that position lies inside a read-only area the caret is positioned before or behind it. Listen to the caret event to @@ -296,8 +296,8 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface The valid range is 0..length. @return - Returns <TRUE/> if the selection has been set successfully and - <FALSE/> otherwise or when selection is not supported. + Returns `TRUE` if the selection has been set successfully and + `FALSE` otherwise or when selection is not supported. @throws ::com::sun::star::lang::IndexOutOfBoundsException if the indices are invalid diff --git a/offapi/com/sun/star/accessibility/XAccessibleValue.idl b/offapi/com/sun/star/accessibility/XAccessibleValue.idl index ffe62951f48a..d25c814354f0 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleValue.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleValue.idl @@ -59,8 +59,8 @@ interface XAccessibleValue : ::com::sun::star::uno::XInterface types for this argument is implementation dependent. @return - Returns <TRUE/> if the new value could successfully be set and - <FALSE/> otherwise. + Returns `TRUE` if the new value could successfully be set and + `FALSE` otherwise. */ boolean setCurrentValue ([in] any aNumber); diff --git a/offapi/com/sun/star/auth/XSSOContext.idl b/offapi/com/sun/star/auth/XSSOContext.idl index 017654b5ad7d..9aa21a364824 100644 --- a/offapi/com/sun/star/auth/XSSOContext.idl +++ b/offapi/com/sun/star/auth/XSSOContext.idl @@ -57,7 +57,7 @@ published interface XSSOContext : ::com::sun::star::uno::XInterface /** retrieves whether or not the context supports mutual authentication @returns - <TRUE/> if mutual authentication is supported, <FALSE/> otherwise. + `TRUE` if mutual authentication is supported, `FALSE` otherwise. */ boolean getMutual(); }; diff --git a/offapi/com/sun/star/awt/DockingEvent.idl b/offapi/com/sun/star/awt/DockingEvent.idl index bf9528d89de8..f4bc7f222a1e 100644 --- a/offapi/com/sun/star/awt/DockingEvent.idl +++ b/offapi/com/sun/star/awt/DockingEvent.idl @@ -50,7 +50,7 @@ struct DockingEvent: com::sun::star::lang::EventObject /** specifies if the docking procedure is interactive which means that the user is currently dragging the window to a new position - if this member is <FALSE/> the window will be docked or undocked immediately + if this member is `FALSE` the window will be docked or undocked immediately using the returned tracking rectangle */ boolean bInteractive; diff --git a/offapi/com/sun/star/awt/EndDockingEvent.idl b/offapi/com/sun/star/awt/EndDockingEvent.idl index ef9ee2120157..6dc1ef6f7c59 100644 --- a/offapi/com/sun/star/awt/EndDockingEvent.idl +++ b/offapi/com/sun/star/awt/EndDockingEvent.idl @@ -36,7 +36,7 @@ struct EndDockingEvent: com::sun::star::lang::EventObject com::sun::star::awt::Rectangle WindowRectangle; - /** specifies if the window is now floating <TRUE/> or docked <FALSE/> + /** specifies if the window is now floating `TRUE` or docked `FALSE` */ boolean bFloating; diff --git a/offapi/com/sun/star/awt/EndPopupModeEvent.idl b/offapi/com/sun/star/awt/EndPopupModeEvent.idl index 6876b9e951b8..e0de19ace734 100644 --- a/offapi/com/sun/star/awt/EndPopupModeEvent.idl +++ b/offapi/com/sun/star/awt/EndPopupModeEvent.idl @@ -32,14 +32,14 @@ struct EndPopupModeEvent: com::sun::star::lang::EventObject { /** specifies how the pop-up mode was ended - <TRUE/> means the window should be teared-off and positioned at FloatingPosition - <FALSE/> means the window was closed + `TRUE` means the window should be teared-off and positioned at FloatingPosition + `FALSE` means the window was closed */ boolean bTearoff; /** specifies the new position of the floating window in frame coordinates - if bTearoff is <TRUE/> + if bTearoff is `TRUE` */ com::sun::star::awt::Point FloatingPosition; }; diff --git a/offapi/com/sun/star/awt/FontDescriptor.idl b/offapi/com/sun/star/awt/FontDescriptor.idl index 2ec789990289..3e83889e0346 100644 --- a/offapi/com/sun/star/awt/FontDescriptor.idl +++ b/offapi/com/sun/star/awt/FontDescriptor.idl @@ -135,8 +135,8 @@ published struct FontDescriptor /** specifies if only words get underlined. - <p><TRUE/> means that only non-space characters get underlined, - <FALSE/> means that the spacing also gets underlined.</p> + <p>`TRUE` means that only non-space characters get underlined, + `FALSE` means that the spacing also gets underlined.</p> <p>This property is only valid if the property com::sun::star::awt::FontDescriptor::Underline diff --git a/offapi/com/sun/star/awt/MouseEvent.idl b/offapi/com/sun/star/awt/MouseEvent.idl index 85aa57af0e4b..b16bc6e4cd4d 100644 --- a/offapi/com/sun/star/awt/MouseEvent.idl +++ b/offapi/com/sun/star/awt/MouseEvent.idl @@ -63,7 +63,7 @@ published struct MouseEvent: com::sun::star::awt::InputEvent /** specifies if this event is a pop-up menu trigger event. - <p>If this member is <TRUE/>, the event describes a request for a pop-up menu, + <p>If this member is `TRUE`, the event describes a request for a pop-up menu, also known as context menu, on an object.</p> <p>In this case, X and Y describe the position diff --git a/offapi/com/sun/star/awt/UnoControlButtonModel.idl b/offapi/com/sun/star/awt/UnoControlButtonModel.idl index 67739557778e..9c6f6f21a5c2 100644 --- a/offapi/com/sun/star/awt/UnoControlButtonModel.idl +++ b/offapi/com/sun/star/awt/UnoControlButtonModel.idl @@ -65,9 +65,9 @@ published service UnoControlButtonModel /** specifies whether the button control should grab the focus when clicked. - <p>If set to <TRUE/> (which is the default), the button control automatically grabs the + <p>If set to `TRUE` (which is the default), the button control automatically grabs the focus when the user clicks onto it with the mouse.<br/> - If set to <FALSE/>, the focus is preserved when the user operates the button control with + If set to `FALSE`, the focus is preserved when the user operates the button control with the mouse.</p> @since OOo 2.0 @@ -129,7 +129,7 @@ published service UnoControlButtonModel <p>If this property is present, it interacts with the #ImageURLin the following way: <ul><li>If #ImageURL is set, #Graphic will be reset - to an object as loaded from the given image URL, or <NULL/> if #ImageURL + to an object as loaded from the given image URL, or `NULL` if #ImageURL does not point to a valid image file.</li> <li>If #Graphic is set, #ImageURL will be reset to an empty string.</li> @@ -166,7 +166,7 @@ published service UnoControlButtonModel <p>Normally, when you click a button with the mouse, you need to release the mouse button, and press it again. With this property - set to <TRUE/>, the button is repeatedly pressed while you hold + set to `TRUE`, the button is repeatedly pressed while you hold down the mouse button.</p> @since OOo 2.0 @@ -209,11 +209,11 @@ published service UnoControlButtonModel /** specifies whether the button should toggle on a single operation. - <p>If this property is set to <TRUE/>, a single operation of the button control (pressing space + <p>If this property is set to `TRUE`, a single operation of the button control (pressing space while it is focused, or clicking onto it) toggles it between a <em>pressed</em> and a <em>not pressed</em> state.</p> - <p>The default for this property is <FALSE/>, which means the button behaves like a usual + <p>The default for this property is `FALSE`, which means the button behaves like a usual push button.</p> @since OOo 2.0 diff --git a/offapi/com/sun/star/awt/UnoControlCheckBoxModel.idl b/offapi/com/sun/star/awt/UnoControlCheckBoxModel.idl index 6fdee993e160..f80ec5b7b1d6 100644 --- a/offapi/com/sun/star/awt/UnoControlCheckBoxModel.idl +++ b/offapi/com/sun/star/awt/UnoControlCheckBoxModel.idl @@ -104,7 +104,7 @@ published service UnoControlCheckBoxModel <p>If this property is present, it interacts with the #ImageURLin the following way: <ul><li>If #ImageURL is set, #Graphic will be reset - to an object as loaded from the given image URL, or <NULL/> if #ImageURL + to an object as loaded from the given image URL, or `NULL` if #ImageURL does not point to a valid image file.</li> <li>If #Graphic is set, #ImageURL will be reset to an empty string.</li> diff --git a/offapi/com/sun/star/awt/UnoControlDialogModel.idl b/offapi/com/sun/star/awt/UnoControlDialogModel.idl index d11dab30fff4..0d4cefd46a74 100644 --- a/offapi/com/sun/star/awt/UnoControlDialogModel.idl +++ b/offapi/com/sun/star/awt/UnoControlDialogModel.idl @@ -135,7 +135,7 @@ published service UnoControlDialogModel <p>If this property is present, it interacts with the #ImageURLin the following way: <ul><li>If #ImageURL is set, #Graphic will be reset - to an object as loaded from the given image URL, or <NULL/> if #ImageURL + to an object as loaded from the given image URL, or `NULL` if #ImageURL does not point to a valid image file.</li> <li>If #Graphic is set, #ImageURL will be reset to an empty string.</li> diff --git a/offapi/com/sun/star/awt/UnoControlImageControlModel.idl b/offapi/com/sun/star/awt/UnoControlImageControlModel.idl index 58dbf8d0dd58..76f5e7dde80a 100644 --- a/offapi/com/sun/star/awt/UnoControlImageControlModel.idl +++ b/offapi/com/sun/star/awt/UnoControlImageControlModel.idl @@ -87,7 +87,7 @@ published service UnoControlImageControlModel <p>If this property is present, it interacts with the #ImageURLin the following way: <ul><li>If #ImageURL is set, #Graphic will be reset - to an object as loaded from the given image URL, or <NULL/> if #ImageURL + to an object as loaded from the given image URL, or `NULL` if #ImageURL does not point to a valid image file.</li> <li>If #Graphic is set, #ImageURL will be reset to an empty string.</li> diff --git a/offapi/com/sun/star/awt/UnoControlListBoxModel.idl b/offapi/com/sun/star/awt/UnoControlListBoxModel.idl index ffcf1befcb02..8e577f838407 100644 --- a/offapi/com/sun/star/awt/UnoControlListBoxModel.idl +++ b/offapi/com/sun/star/awt/UnoControlListBoxModel.idl @@ -180,7 +180,7 @@ published service UnoControlListBoxModel /** specifies where an item separator - a horizontal line - is drawn. - <p>If this is not <NULL/>, then a horizontal line will be drawn between the item at the given position, + <p>If this is not `NULL`, then a horizontal line will be drawn between the item at the given position, and the following item.</p> @since OOo 3.3 diff --git a/offapi/com/sun/star/awt/UnoControlRadioButtonModel.idl b/offapi/com/sun/star/awt/UnoControlRadioButtonModel.idl index b8b42865c70b..fa81bf4a11ed 100644 --- a/offapi/com/sun/star/awt/UnoControlRadioButtonModel.idl +++ b/offapi/com/sun/star/awt/UnoControlRadioButtonModel.idl @@ -105,7 +105,7 @@ published service UnoControlRadioButtonModel <p>If this property is present, it interacts with the #ImageURLin the following way: <ul><li>If #ImageURL is set, #Graphic will be reset - to an object as loaded from the given image URL, or <NULL/> if #ImageURL + to an object as loaded from the given image URL, or `NULL` if #ImageURL does not point to a valid image file.</li> <li>If #Graphic is set, #ImageURL will be reset to an empty string.</li> diff --git a/offapi/com/sun/star/awt/UnoControlRoadmap.idl b/offapi/com/sun/star/awt/UnoControlRoadmap.idl index 2cbc3ceae82a..26813bc1d7bc 100644 --- a/offapi/com/sun/star/awt/UnoControlRoadmap.idl +++ b/offapi/com/sun/star/awt/UnoControlRoadmap.idl @@ -37,7 +37,7 @@ <li>ImageURL: The image referenced by the URL is placed in the lower right corner of the control.</li> <li>Graphic: The graphic is placed in the lower right corner of the control.</li> - <li>Complete: When set to <FALSE/> a non interactive RoadmapItem is appended + <li>Complete: When set to `FALSE` a non interactive RoadmapItem is appended after the last roadmap item, labeled with three dots, indicating incompleteness.</li> <li>Interactive: When activating a RoadmapItem (see RoadmapItem) the information about which Item has been selected is passed over when an itemlistener diff --git a/offapi/com/sun/star/awt/UnoControlRoadmapModel.idl b/offapi/com/sun/star/awt/UnoControlRoadmapModel.idl index 2ad0ae9afc72..6d1a242aefe3 100644 --- a/offapi/com/sun/star/awt/UnoControlRoadmapModel.idl +++ b/offapi/com/sun/star/awt/UnoControlRoadmapModel.idl @@ -80,7 +80,7 @@ service UnoControlRoadmapModel <p>If this property is present, it interacts with the #ImageURLin the following way: <ul><li>If #ImageURL is set, #Graphic will be reset - to an object as loaded from the given image URL, or <NULL/> if #ImageURL + to an object as loaded from the given image URL, or `NULL` if #ImageURL does not point to a valid image file.</li> <li>If #Graphic is set, #ImageURL will be reset to an empty string.</li> diff --git a/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl b/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl index 807b9001ab44..f3b625dcd3e3 100644 --- a/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl +++ b/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl @@ -89,9 +89,9 @@ published service UnoControlScrollBarModel /** specifies the scrolling behavior of the control. - <p><TRUE/> means, that when the user moves the slider in the scroll bar, + <p>`TRUE` means, that when the user moves the slider in the scroll bar, the content of the window is updated immediately. - <FALSE/> means, that the window is only updated after the user has + `FALSE` means, that the window is only updated after the user has released the mouse button.</p> @since OOo 2.0 diff --git a/offapi/com/sun/star/awt/XAnimatedImages.idl b/offapi/com/sun/star/awt/XAnimatedImages.idl index deed8a442848..4f7aa5012671 100644 --- a/offapi/com/sun/star/awt/XAnimatedImages.idl +++ b/offapi/com/sun/star/awt/XAnimatedImages.idl @@ -49,7 +49,7 @@ interface XAnimatedImages /** specifies whether the animation should start over with the first image of the image series when the last image has been played. - <p>The default value for this attribute is <TRUE/>.</p> + <p>The default value for this attribute is `TRUE`.</p> */ [attribute] boolean AutoRepeat; diff --git a/offapi/com/sun/star/awt/XDevice.idl b/offapi/com/sun/star/awt/XDevice.idl index f4fa66ae2341..b9b43ae765c8 100644 --- a/offapi/com/sun/star/awt/XDevice.idl +++ b/offapi/com/sun/star/awt/XDevice.idl @@ -50,7 +50,7 @@ published interface XDevice: com::sun::star::uno::XInterface /** creates a new device which is compatible with this one. <p>If the device does not support the GETBITS device capability, - this method returns <NULL/>.</p> + this method returns `NULL`.</p> */ XDevice createDevice( [in] long nWidth, [in] long nHeight ); diff --git a/offapi/com/sun/star/awt/XDockableWindow.idl b/offapi/com/sun/star/awt/XDockableWindow.idl index ccd10864996d..400283827bae 100644 --- a/offapi/com/sun/star/awt/XDockableWindow.idl +++ b/offapi/com/sun/star/awt/XDockableWindow.idl @@ -51,8 +51,8 @@ interface XDockableWindow : com::sun::star::uno::XInterface /** enable or disable docking, docking is disabled by default @param bEnable - <TRUE/> specifies that docking is enabled - <FALSE/> specifies that docking is disabled and no + `TRUE` specifies that docking is enabled + `FALSE` specifies that docking is disabled and no com::sun::star::awt::XDockableWindowListener will be called */ void enableDocking( [in] boolean bEnable ); @@ -60,8 +60,8 @@ interface XDockableWindow : com::sun::star::uno::XInterface /** queries the current window state @returns - <TRUE/> if the window is floating - <FALSE/> if the window is docked + `TRUE` if the window is floating + `FALSE` if the window is docked */ boolean isFloating(); @@ -69,7 +69,7 @@ interface XDockableWindow : com::sun::star::uno::XInterface /** toggle between floating and docked state @param bFloating specifies the new floating mode: - <TRUE/> means floating, <FALSE/> means docked + `TRUE` means floating, `FALSE` means docked */ void setFloatingMode( [in] boolean bFloating ); @@ -88,8 +88,8 @@ interface XDockableWindow : com::sun::star::uno::XInterface /** queries the current locking state @returns - <TRUE/> if the window is locked - <FALSE/> if the window is not locked + `TRUE` if the window is locked + `FALSE` if the window is not locked */ boolean isLocked(); @@ -106,8 +106,8 @@ interface XDockableWindow : com::sun::star::uno::XInterface /** queries the current pop-up mode @returns - <TRUE/> if the window is in pop-up mode - <FALSE/> if the window is not in pop-up mode + `TRUE` if the window is in pop-up mode + `FALSE` if the window is not in pop-up mode */ boolean isInPopupMode(); }; diff --git a/offapi/com/sun/star/awt/XEventHandler.idl b/offapi/com/sun/star/awt/XEventHandler.idl index c8a2f3707b5e..6efacb4b4eab 100644 --- a/offapi/com/sun/star/awt/XEventHandler.idl +++ b/offapi/com/sun/star/awt/XEventHandler.idl @@ -36,8 +36,8 @@ published interface XEventHandler: com::sun::star::uno::XInterface /** requests the implementor of this interface to handle a platform dependent event. - @returns <TRUE/> if the event was handled properly and no further - handling should take place, <FALSE/> otherwise. + @returns `TRUE` if the event was handled properly and no further + handling should take place, `FALSE` otherwise. @param event the platform dependent event. diff --git a/offapi/com/sun/star/awt/XKeyHandler.idl b/offapi/com/sun/star/awt/XKeyHandler.idl index 2ef3a5e89ae6..2231e43a1455 100644 --- a/offapi/com/sun/star/awt/XKeyHandler.idl +++ b/offapi/com/sun/star/awt/XKeyHandler.idl @@ -54,9 +54,9 @@ published interface XKeyHandler : ::com::sun::star::lang::XEventListener @param aEvent The key event informs about the pressed key. @return - When <FALSE/> is returned the other handlers are called and a + When `FALSE` is returned the other handlers are called and a following handling of the event by the broadcaster takes place. - Otherwise, when <TRUE/> is returned, no other handler will be + Otherwise, when `TRUE` is returned, no other handler will be called and the broadcaster will take no further actions regarding the event. */ @@ -75,9 +75,9 @@ published interface XKeyHandler : ::com::sun::star::lang::XEventListener @param aEvent The key event informs about the pressed key. @return - When <FALSE/> is returned the other handlers are called and a + When `FALSE` is returned the other handlers are called and a following handling of the event by the broadcaster takes place. - Otherwise, when <TRUE/> is returned, no other handler will be + Otherwise, when `TRUE` is returned, no other handler will be called and the broadcaster will take no further actions regarding the event. */ diff --git a/offapi/com/sun/star/awt/XMenuExtended2.idl b/offapi/com/sun/star/awt/XMenuExtended2.idl index 976aa841b740..4a0cd6b4876e 100644 --- a/offapi/com/sun/star/awt/XMenuExtended2.idl +++ b/offapi/com/sun/star/awt/XMenuExtended2.idl @@ -46,7 +46,7 @@ interface XMenuExtended2 /** checks whether an XMenu is an XPopupMenu. @return - <TRUE/> if the menu is a PopupMenu, <FALSE/> if it is a MenuBar. + `TRUE` if the menu is a PopupMenu, `FALSE` if it is a MenuBar. */ boolean isPopupMenu(); @@ -76,7 +76,7 @@ interface XMenuExtended2 /** specifies whether disabled menu entries should be hidden, or not. @param bHide - if <TRUE/>, disabled menu entries are hidden. + if `TRUE`, disabled menu entries are hidden. @see com::sun::star::awt::XMenu::enableItem() diff --git a/offapi/com/sun/star/awt/XMouseClickHandler.idl b/offapi/com/sun/star/awt/XMouseClickHandler.idl index 5a2ab090b579..2db74a87610f 100644 --- a/offapi/com/sun/star/awt/XMouseClickHandler.idl +++ b/offapi/com/sun/star/awt/XMouseClickHandler.idl @@ -37,9 +37,9 @@ published interface XMouseClickHandler: ::com::sun::star::lang::XEventListener /** is invoked when a mouse button has been pressed on a window. @return - When <FALSE/> is returned the other handlers are called and a + When `FALSE` is returned the other handlers are called and a following handling of the event by the broadcaster takes place. - Otherwise, when <TRUE/> is returned, no other handler will be + Otherwise, when `TRUE` is returned, no other handler will be called and the broadcaster will take no further actions regarding the event. */ @@ -49,9 +49,9 @@ published interface XMouseClickHandler: ::com::sun::star::lang::XEventListener /** is invoked when a mouse button has been released on a window. @return - When <FALSE/> is returned the other handlers are called and a + When `FALSE` is returned the other handlers are called and a following handling of the event by the broadcaster takes place. - Otherwise, when <TRUE/> is returned, no other handler will be + Otherwise, when `TRUE` is returned, no other handler will be called and the broadcaster will take no further actions regarding the event. */ diff --git a/offapi/com/sun/star/awt/XMouseListener.idl b/offapi/com/sun/star/awt/XMouseListener.idl index 86479238e570..a85588d194c6 100644 --- a/offapi/com/sun/star/awt/XMouseListener.idl +++ b/offapi/com/sun/star/awt/XMouseListener.idl @@ -42,7 +42,7 @@ published interface XMouseListener: com::sun::star::lang::XEventListener then you will receive one call to mousePressed() indicating the mouse click, and another one indicating the context menu request. For the latter, the MouseEvent::PopupTrigger member of the - event will be set to <TRUE/>.</p> + event will be set to `TRUE`.</p> */ void mousePressed( [in] com::sun::star::awt::MouseEvent e ); diff --git a/offapi/com/sun/star/awt/XMouseMotionHandler.idl b/offapi/com/sun/star/awt/XMouseMotionHandler.idl index ae560e381102..cb68e8458818 100644 --- a/offapi/com/sun/star/awt/XMouseMotionHandler.idl +++ b/offapi/com/sun/star/awt/XMouseMotionHandler.idl @@ -42,9 +42,9 @@ published interface XMouseMotionHandler: com::sun::star::lang::XEventListener bounds of the window).</p> @return - When <FALSE/> is returned the other handlers are called and a + When `FALSE` is returned the other handlers are called and a following handling of the event by the broadcaster takes place. - Otherwise, when <TRUE/> is returned, no other handler will be + Otherwise, when `TRUE` is returned, no other handler will be called and the broadcaster will take no further actions regarding the event. @@ -56,9 +56,9 @@ published interface XMouseMotionHandler: com::sun::star::lang::XEventListener (with no buttons down). @return - When <FALSE/> is returned the other handlers are called and a + When `FALSE` is returned the other handlers are called and a following handling of the event by the broadcaster takes place. - Otherwise, when <TRUE/> is returned, no other handler will be + Otherwise, when `TRUE` is returned, no other handler will be called and the broadcaster will take no further actions regarding the event. diff --git a/offapi/com/sun/star/awt/XPopupMenuExtended.idl b/offapi/com/sun/star/awt/XPopupMenuExtended.idl index 7f07fee7d83e..4508b59543f9 100644 --- a/offapi/com/sun/star/awt/XPopupMenuExtended.idl +++ b/offapi/com/sun/star/awt/XPopupMenuExtended.idl @@ -51,11 +51,11 @@ interface XPopupMenuExtended is being executed as a result of invoking com::sun::star::awt::XPopupMenu::execute(); that is, for a PopupMenu activated by a MenuBar item, - this methods returns <FALSE/>. + this methods returns `FALSE`. @return - <TRUE/> if the com::sun::star::awt::PopupMenu - is being executed, <FALSE/> otherwise. + `TRUE` if the com::sun::star::awt::PopupMenu + is being executed, `FALSE` otherwise. @see com::sun::star::awt::XPopupMenu::execute() @@ -97,7 +97,7 @@ interface XPopupMenuExtended /** specifies whether mnemonics are automatically assigned to menu items, or not. @param bEnable - if <TRUE/>, mnemonics are automatically assigned to menu items. + if `TRUE`, mnemonics are automatically assigned to menu items. */ void enableAutoMnemonics( [in] boolean bEnable ); @@ -129,7 +129,7 @@ interface XPopupMenuExtended <p>The KeyEvent is <b>only</b> used as a container to transport the shortcut information, so that in this case - ::com::sun::star::lang::::EventObject::Source is <NULL/>.</p> + ::com::sun::star::lang::::EventObject::Source is `NULL`.</p> @param nItemId specifies the menu item identifier for which the KeyEvent should be retrieved. @@ -221,7 +221,7 @@ interface XPopupMenuExtended specifies the image for the menu item. @param bScale - if <TRUE/>, the image will be scaled to the standard size used internally by + if `TRUE`, the image will be scaled to the standard size used internally by the implementation. @throws com::sun::star::container::NoSuchElementException @@ -293,7 +293,7 @@ interface XPopupMenuExtended specifies the menu item identifier for which the mirror mode should be set. @param bMirror - if <TRUE/>, the item image is mirrored. + if `TRUE`, the item image is mirrored. @throws com::sun::star::container::NoSuchElementException if there is no menu item with the identifier specified in <var>nItemId</var>. @@ -308,7 +308,7 @@ interface XPopupMenuExtended @param nItemId specifies the menu item identifier for which the image mirror mode should be checked. - @return <TRUE/> if the item image is mirrored, <FALSE/> otherwise. + @return `TRUE` if the item image is mirrored, `FALSE` otherwise. @throws com::sun::star::container::NoSuchElementException if there is no menu item with the identifier specified in <var>nItemId</var>. diff --git a/offapi/com/sun/star/awt/XPrinter.idl b/offapi/com/sun/star/awt/XPrinter.idl index 12af1976c8d0..5ad5a0b2f00f 100644 --- a/offapi/com/sun/star/awt/XPrinter.idl +++ b/offapi/com/sun/star/awt/XPrinter.idl @@ -74,7 +74,7 @@ published interface XPrinter: com::sun::star::awt::XPrinterPropertySet in or before the call to com::sun::star::awt::XPrinter::start(), com::sun::star::awt::XPrinter::terminate() - returns <FALSE/>. This call must not block the thread.</p> + returns `FALSE`. This call must not block the thread.</p> @see end */ diff --git a/offapi/com/sun/star/awt/grid/SortableGridDataModel.idl b/offapi/com/sun/star/awt/grid/SortableGridDataModel.idl index 520c2842b749..d38487d8193e 100644 --- a/offapi/com/sun/star/awt/grid/SortableGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/SortableGridDataModel.idl @@ -38,8 +38,8 @@ interface XMutableGridDataModel; <p>The service implementation is able to compare the default scalar types, plus strings.</p> - <p>For determining the data type of a column which the data should be sorted by, the first non-<VOID/> data encountered - in this column is taken into account. Further read requests to this column will assume that all non-<VOID/> data is of + <p>For determining the data type of a column which the data should be sorted by, the first non-`VOID` data encountered + in this column is taken into account. Further read requests to this column will assume that all non-`VOID` data is of the same type.</p> <p>Consequently, you cannot use this service with data sets containing heterogenous data in a given column.</p> @@ -61,7 +61,7 @@ service SortableGridDataModel : XSortableMutableGridDataModel @param DelegatorModel the data model to which read requests are delegated. @throws ::com::sun::star::lang::IllegalArgumentException - if the given <code>DelegatorModel</code> is <NULL/> + if the given <code>DelegatorModel</code> is `NULL` */ create( [in] XMutableGridDataModel DelegatorModel @@ -75,7 +75,7 @@ service SortableGridDataModel : XSortableMutableGridDataModel @param Collator is the collator to be used for string comparison @throws ::com::sun::star::lang::IllegalArgumentException - if the given <code>DelegatorModel</code> is <NULL/> + if the given <code>DelegatorModel</code> is `NULL` */ createWithCollator( [in] XMutableGridDataModel DelegatorModel, diff --git a/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl b/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl index ef2fed2637ff..35f6b843dcc7 100644 --- a/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl +++ b/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl @@ -42,7 +42,7 @@ published service UnoControlGridModel /** Specifies whether the grid control should display a special header column. - <p>The default value is <FALSE/></p> + <p>The default value is `FALSE`</p> */ [property] boolean ShowRowHeader; @@ -50,13 +50,13 @@ published service UnoControlGridModel <p>The width is specified in application font units - see com::sun::star::util::MeasureUnit.</p> - <p>The value given here is ignored if #ShowRowHeader is <FALSE/>.</p> + <p>The value given here is ignored if #ShowRowHeader is `FALSE`.</p> */ [property] long RowHeaderWidth; /** Specifies whether the grid control should display a title row. - <p>The default value is <TRUE/></p> + <p>The default value is `TRUE`</p> */ [property] boolean ShowColumnHeader; @@ -64,7 +64,7 @@ published service UnoControlGridModel <p>The height is specified in application font units - see com::sun::star::util::MeasureUnit.</p> - <p>The value given here is ignored if #ShowColumnHeader is <FALSE/>.</p> + <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, according to the used font, to display one line of text.</p> @@ -102,12 +102,12 @@ published service UnoControlGridModel [property] XGridDataModel GridDataModel; /** Specifies the vertical scrollbar mode. - <p>The default value is <FALSE/></p> + <p>The default value is `FALSE`</p> */ [property] boolean HScroll; /** Specifies the horizontal scrollbar mode. - <p>The default value is <FALSE/></p> + <p>The default value is `FALSE`</p> */ [property] boolean VScroll; @@ -128,7 +128,7 @@ published service UnoControlGridModel /** specifies the color to be used when drawing lines between cells - <p>If this property has a value of <VOID/>, the grid control renderer will use some default color, + <p>If this property has a value of `VOID`, the grid control renderer will use some default color, depending on the control's style settings.</p> @see UseGridLines @@ -137,21 +137,21 @@ published service UnoControlGridModel /** specifies the color to be used when drawing the background of row or column headers - <p>If this property has a value of <VOID/>, the grid control renderer will use some default color, + <p>If this property has a value of `VOID`, the grid control renderer will use some default color, depending on the control's style settings.</p> */ [property, maybevoid] ::com::sun::star::util::Color HeaderBackgroundColor; /** specifies the color to be used when drawing the text within row or column headers - <p>If this property has a value of <VOID/>, the grid control renderer will use some default color, + <p>If this property has a value of `VOID`, the grid control renderer will use some default color, depending on the control's style settings.</p> */ [property, maybevoid] ::com::sun::star::util::Color HeaderTextColor; /** specifies the color to be used when drawing the background of selected cells, while the control has the focus. - <p>If this property has a value of <VOID/>, the grid control renderer will use some default color, + <p>If this property has a value of `VOID`, the grid control renderer will use some default color, depending on the control's style settings.</p> */ [property, maybevoid] ::com::sun::star::util::Color ActiveSelectionBackgroundColor; @@ -159,14 +159,14 @@ published service UnoControlGridModel /** specifies the color to be used when drawing the background of selected cells, while the control does not have the focus. - <p>If this property has a value of <VOID/>, the grid control renderer will use some default color, + <p>If this property has a value of `VOID`, the grid control renderer will use some default color, depending on the control's style settings.</p> */ [property, maybevoid] ::com::sun::star::util::Color InactiveSelectionBackgroundColor; /** specifies the color to be used when drawing the text of selected cells, while the control has the focus. - <p>If this property has a value of <VOID/>, the grid control renderer will use some default color, + <p>If this property has a value of `VOID`, the grid control renderer will use some default color, depending on the control's style settings.</p> */ [property, maybevoid] ::com::sun::star::util::Color ActiveSelectionTextColor; @@ -174,7 +174,7 @@ published service UnoControlGridModel /** specifies the color to be used when drawing the text of selected cells, while the control does not have the focus. - <p>If this property has a value of <VOID/>, the grid control renderer will use some default color, + <p>If this property has a value of `VOID`, the grid control renderer will use some default color, depending on the control's style settings.</p> */ [property, maybevoid] ::com::sun::star::util::Color InactiveSelectionTextColor; @@ -187,7 +187,7 @@ published service UnoControlGridModel <p>If this sequence is empty, all rows will use the same background color as the control as whole.</p> - <p>If this property has a value of <VOID/>, rows will be painted + <p>If this property has a value of `VOID`, rows will be painted in alternating background colors, every second row having a background color derived from the control's selection color.</p> */ @@ -203,14 +203,14 @@ published service UnoControlGridModel /** specifies the color to be used when drawing cell texts - <p>If this property has a value of <VOID/>, the grid control renderer will use some default color, + <p>If this property has a value of `VOID`, the grid control renderer will use some default color, depending on the control's style settings.</p> */ [property, maybevoid] ::com::sun::star::util::Color TextColor; /** specifies the color to be used when drawing text lines (underlining and strikethrough) - <p>If this property has a value of <VOID/>, the grid control renderer will use some default color, + <p>If this property has a value of `VOID`, the grid control renderer will use some default color, depending on the control's style settings.</p> */ [property, maybevoid] com::sun::star::util::Color TextLineColor; diff --git a/offapi/com/sun/star/awt/grid/XGridColumn.idl b/offapi/com/sun/star/awt/grid/XGridColumn.idl index a8d05201c2e2..edbb767042a0 100644 --- a/offapi/com/sun/star/awt/grid/XGridColumn.idl +++ b/offapi/com/sun/star/awt/grid/XGridColumn.idl @@ -63,7 +63,7 @@ published interface XGridColumn /** controls whether or not the column's width is fixed or not. - <p>If this is <TRUE/>, the user can interactively change the column's width. Also, the column is subject to + <p>If this is `TRUE`, the user can interactively change the column's width. Also, the column is subject to auto-resizing, if its #Flexibility attribute is greater <code>0</code>.</p> */ [attribute] boolean Resizeable; @@ -77,7 +77,7 @@ published interface XGridColumn other such columns, and the respective widths of the columns are changed in the same relationship.</p> <p>Note that a column's flexibility is ignored if its #Resizeable attribute is - <FALSE/>.</p> + `FALSE`.</p> <p>A column's flexibility cannot be negative, attempts to set a negative value will raise an exception.</p> */ diff --git a/offapi/com/sun/star/awt/grid/XGridColumnModel.idl b/offapi/com/sun/star/awt/grid/XGridColumnModel.idl index 35a24eb5d693..3e96e8451461 100644 --- a/offapi/com/sun/star/awt/grid/XGridColumnModel.idl +++ b/offapi/com/sun/star/awt/grid/XGridColumnModel.idl @@ -82,7 +82,7 @@ published interface XGridColumnModel the index of new created column. @throws ::com::sun::star::lang::IllegalArgumentException - if the given column is not a valid element for the column container, or if it is <NULL/>. + if the given column is not a valid element for the column container, or if it is `NULL`. */ long addColumn( [in] XGridColumn column ) raises ( ::com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/awt/grid/XGridDataModel.idl b/offapi/com/sun/star/awt/grid/XGridDataModel.idl index 3090db51838b..d17a2dc69b86 100644 --- a/offapi/com/sun/star/awt/grid/XGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/XGridDataModel.idl @@ -65,7 +65,7 @@ published interface XGridDataModel <p>At the moment, only string tool tips are supported.</p> - <p>If <VOID/> is returned here, the cell's content will be displayed as tip, but only if it does + <p>If `VOID` is returned here, the cell's content will be displayed as tip, but only if it does not fit into the cell.</p> @throws ::com::sun::star::lang::IndexOutOfBoundsException diff --git a/offapi/com/sun/star/awt/grid/XSortableGridData.idl b/offapi/com/sun/star/awt/grid/XSortableGridData.idl index 94aff6a74aef..aa0191e991ea 100644 --- a/offapi/com/sun/star/awt/grid/XSortableGridData.idl +++ b/offapi/com/sun/star/awt/grid/XSortableGridData.idl @@ -36,7 +36,7 @@ interface XSortableGridData @param ColumnIndex the index of the column whose data should be used as sort key @param SortAscending - is <TRUE/> if the data should be sorted ascending, <FALSE/> otherwise. + is `TRUE` if the data should be sorted ascending, `FALSE` otherwise. @throws ::com::sun::star::lang::IndexOutOfBoundsException if <code>ColumnIndex</code> does not denote a valid column. */ @@ -52,8 +52,8 @@ interface XSortableGridData @return a structure describing the current sort order. ::com::sun::star::beans::Pair::First denotes the column by which the data is sorted, or -1 if the data is currently unsorted. - ::com::sun::star::beans::Pair::Second is <TRUE/> if the data is sorted ascending, - <FALSE/> otherwise. + ::com::sun::star::beans::Pair::Second is `TRUE` if the data is sorted ascending, + `FALSE` otherwise. */ ::com::sun::star::beans::Pair< long, boolean > getCurrentSortOrder(); diff --git a/offapi/com/sun/star/awt/tab/XTabPageContainer.idl b/offapi/com/sun/star/awt/tab/XTabPageContainer.idl index 0b08118e1e57..4d2a345598c9 100644 --- a/offapi/com/sun/star/awt/tab/XTabPageContainer.idl +++ b/offapi/com/sun/star/awt/tab/XTabPageContainer.idl @@ -44,7 +44,7 @@ published interface XTabPageContainer @param the tab page to be checked. @returns - <TRUE/> if tab page is activated, else <FALSE/>. + `TRUE` if tab page is activated, else `FALSE`. */ boolean isTabPageActive([in] short tabPageIndex); diff --git a/offapi/com/sun/star/awt/tree/TreeControl.idl b/offapi/com/sun/star/awt/tree/TreeControl.idl index 1c4ac23c6d66..084474977716 100644 --- a/offapi/com/sun/star/awt/tree/TreeControl.idl +++ b/offapi/com/sun/star/awt/tree/TreeControl.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module awt { module tree { <p> <h4>The Data Model</h4> <p>A specific node in a tree is identified by a XTreeNode. - A leaf node is a node without any children and that returns <FALSE/> when calling XTreeNode::hasChildrenOnDemand(). + A leaf node is a node without any children and that returns `FALSE` when calling XTreeNode::hasChildrenOnDemand(). An expanded node is a non-leaf node that will displays its children when all its ancestors are expanded. A collapsed node is one which hides them. A node is visible when all parent nodes are expanded and the node itself is in the display area. @@ -61,7 +61,7 @@ module com { module sun { module star { module awt { module tree { <h4>Adding child nodes on demand</h4> <p>If you want to add child nodes to your tree on demand you can do the following. <ul> - <li>Make sure the parent node returns <TRUE/> for XTreeNode::hasChildrenOnDemand() either + <li>Make sure the parent node returns `TRUE` for XTreeNode::hasChildrenOnDemand() either by implementing XTreeNode yourself or if you use the MutableTreeDataModel, use XMutableTreeNode::setHasChildrenOnDemand().</li> <li>Implement a XTreeExpansionListener and add the instance with the method diff --git a/offapi/com/sun/star/awt/tree/TreeControlModel.idl b/offapi/com/sun/star/awt/tree/TreeControlModel.idl index 47918014332e..c8fad9d26264 100644 --- a/offapi/com/sun/star/awt/tree/TreeControlModel.idl +++ b/offapi/com/sun/star/awt/tree/TreeControlModel.idl @@ -47,21 +47,21 @@ service TreeControlModel [property] XTreeDataModel DataModel; /** Specifies if the root node of the tree is displayed. - <p>If <var>RootDisplayed</var> is set to <FALSE/>, the root node of a model is no longer + <p>If <var>RootDisplayed</var> is set to `FALSE`, the root node of a model is no longer a valid node for the XTreeControl and can't be used with any method of XTreeControl. - <p>The default value is <TRUE/></p> + <p>The default value is `TRUE`</p> */ [property] boolean RootDisplayed; /** Specifies whether the node handles should be displayed. <p>The handles are doted lines that visualize the tree like hierarchy<p> - <p>The default value is <TRUE/></p> + <p>The default value is `TRUE`</p> */ [property] boolean ShowsHandles; /** Specifies whether the node handles should also be displayed at root level. - <p>The default value is <TRUE/></p> + <p>The default value is `TRUE`</p> */ [property] boolean ShowsRootHandles; @@ -73,7 +73,7 @@ service TreeControlModel [property] long RowHeight; /** Specifies whether the nodes of the tree are editable. - <p>The default value is <FALSE/></p> + <p>The default value is `FALSE`</p> @see XTreeControl::startEditingAtNode() @see XTreeEditListener @@ -82,9 +82,9 @@ service TreeControlModel /** Specifies what happens when editing is interrupted by selecting another node in the tree, a change in the tree's data, or by some other means. - <p>Setting this property to <TRUE/> causes the changes to be automatically saved when editing - is interrupted. <FALSE/> means that editing is canceled and changes are lost - <p>The default value is <FALSE/></p> + <p>Setting this property to `TRUE` causes the changes to be automatically saved when editing + is interrupted. `FALSE` means that editing is canceled and changes are lost + <p>The default value is `FALSE`</p> */ [property] boolean InvokesStopNodeEditing; }; diff --git a/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl b/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl index dad23fd98983..1bdf94273c3d 100644 --- a/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl +++ b/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl @@ -40,7 +40,7 @@ interface XMutableTreeDataModel : XTreeDataModel as a textual representation of the created node. @param ChildrenOnDemand - if <TRUE/> is used as a parameter, the created node will be treated as a non-leaf + if `TRUE` is used as a parameter, the created node will be treated as a non-leaf node by the XTreeControl, even when it has no child nodes. @returns diff --git a/offapi/com/sun/star/awt/tree/XTreeControl.idl b/offapi/com/sun/star/awt/tree/XTreeControl.idl index 0e86cf36e38b..f8bc0e837097 100644 --- a/offapi/com/sun/star/awt/tree/XTreeControl.idl +++ b/offapi/com/sun/star/awt/tree/XTreeControl.idl @@ -47,14 +47,14 @@ interface XTreeControl // expanding/collapsing/visible - /** Returns <TRUE/> if <var>Node</var> is currently expanded. + /** Returns `TRUE` if <var>Node</var> is currently expanded. @param Node the XTreeNode specifying the node to check. @returns - <FALSE/> if <var>Node</var> or at least one of its parent nodes are collapsed, - <TRUE/> if <var>Node</var> and all of its parent nodes are expanded. + `FALSE` if <var>Node</var> or at least one of its parent nodes are collapsed, + `TRUE` if <var>Node</var> and all of its parent nodes are expanded. @throws ::com::sun::star::lang::IllegalArgumentException if <var>Node</var> is not a valid node of the corresponding XTreeDataModel. @@ -62,14 +62,14 @@ interface XTreeControl boolean isNodeExpanded( [in] XTreeNode Node ) raises( ::com::sun::star::lang::IllegalArgumentException ); - /** Returns <TRUE/> if <var>Node</var> is currently collapsed. + /** Returns `TRUE` if <var>Node</var> is currently collapsed. @param Node the XTreeNode specifying the node to check @returns - <TRUE/> if <var>Node</var> or at least one of its parent nodes are collapsed, - <FALSE/> if <var>Node</var> and all of its parent nodes are expanded + `TRUE` if <var>Node</var> or at least one of its parent nodes are collapsed, + `FALSE` if <var>Node</var> and all of its parent nodes are expanded @throws ::com::sun::star::lang::IllegalArgumentException if <var>Node</var> is not a valid node of the corresponding XTreeDataModel. @@ -95,11 +95,11 @@ interface XTreeControl void makeNodeVisible( [in] XTreeNode Node ) raises( com::sun::star::lang::IllegalArgumentException, ExpandVetoException ); - /** Returns <TRUE/> if <var>Node</var> is currently visible. + /** Returns `TRUE` if <var>Node</var> is currently visible. <p>Visible means it is either the root or all of its parents are expanded.</p> @returns - <TRUE/> if <var>Node</var> is visible, otherwise <FALSE/> + `TRUE` if <var>Node</var> is visible, otherwise `FALSE` @throws ::com::sun::star::lang::IllegalArgumentException if <var>Node</var> is not a valid node of the corresponding XTreeDataModel. @@ -199,7 +199,7 @@ interface XTreeControl @param Node the node whose geometry should be obtained @throws ::com::sun::star::lang::IllegalArgumentException - if the given node is <NULL/>, or does not belong to the tree's data model + if the given node is `NULL`, or does not belong to the tree's data model */ ::com::sun::star::awt::Rectangle getNodeRect( [in] XTreeNode Node ) @@ -207,11 +207,11 @@ interface XTreeControl // tree editing - /** Returns <TRUE/> if one of tree's nodes is being currently edited. + /** Returns `TRUE` if one of tree's nodes is being currently edited. <p>The node that is being edited can be obtained using com::sun::star::view::XSelectionSupplier::getSelection(). @returns - <TRUE/> if the user is currently editing a node + `TRUE` if the user is currently editing a node */ boolean isEditing(); @@ -220,7 +220,7 @@ interface XTreeControl <p>Has no effect if the tree isn't being edited.</p> @returns - <TRUE/> if editing was in progress and is now stopped, <FALSE/> if editing was not in progress + `TRUE` if editing was in progress and is now stopped, `FALSE` if editing was not in progress */ boolean stopEditing(); @@ -231,7 +231,7 @@ interface XTreeControl /** Selects <var>Node</var> and initiates editing. - <p>If TreeControlModel::Editable is <FALSE/> or if there are no + <p>If TreeControlModel::Editable is `FALSE` or if there are no registered XTreeEditListener, this call has no effect.</p> <p>Calling this method also ensures that <var>Node</var> will become visible.</p> diff --git a/offapi/com/sun/star/awt/tree/XTreeEditListener.idl b/offapi/com/sun/star/awt/tree/XTreeEditListener.idl index dde3dcc498d9..6fc0c4f6583a 100644 --- a/offapi/com/sun/star/awt/tree/XTreeEditListener.idl +++ b/offapi/com/sun/star/awt/tree/XTreeEditListener.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module awt { module tree { to get notifications when editing of a node starts and ends. <p>You have to set the TreeControlModel::Editable property to - <TRUE/> before a tree supports editing.</p> + `TRUE` before a tree supports editing.</p> */ interface XTreeEditListener : ::com::sun::star::lang::XEventListener { diff --git a/offapi/com/sun/star/awt/tree/XTreeNode.idl b/offapi/com/sun/star/awt/tree/XTreeNode.idl index 7c192c6418df..0ddfce321a2f 100644 --- a/offapi/com/sun/star/awt/tree/XTreeNode.idl +++ b/offapi/com/sun/star/awt/tree/XTreeNode.idl @@ -54,8 +54,8 @@ interface XTreeNode */ long getIndex( [in] XTreeNode Node); - /** Returns <TRUE/> if the children of this node are created on demand. - <p>A TreeControl will handle a node that returns <TRUE/> always + /** Returns `TRUE` if the children of this node are created on demand. + <p>A TreeControl will handle a node that returns `TRUE` always like a node that has child nodes, even if getChildCount() returns 0.</p> diff --git a/offapi/com/sun/star/chart/BarDiagram.idl b/offapi/com/sun/star/chart/BarDiagram.idl index c2f9c3ca2fbf..7b2b8899ddf6 100644 --- a/offapi/com/sun/star/chart/BarDiagram.idl +++ b/offapi/com/sun/star/chart/BarDiagram.idl @@ -48,15 +48,15 @@ published service BarDiagram /** Determines if the bars of a chart are drawn vertically or horizontally. Default is vertical. - <p>If Vertical is <FALSE/> you get a column chart rather than + <p>If Vertical is `FALSE` you get a column chart rather than a bar chart.</p> */ [property] boolean Vertical; - /** If <TRUE/>, determines that in a three-dimensional bar chart + /** If `TRUE`, determines that in a three-dimensional bar chart the bars of each series are arranged behind each other in the - z-direction. If <FALSE/> the arrangement of bars is like in + z-direction. If `FALSE` the arrangement of bars is like in two-dimensional bar charts. */ [optional, property] boolean Deep; @@ -71,10 +71,10 @@ published service BarDiagram /** If bars of a bar or column chart are attached to different axis, this property determines how to display those. If - <TRUE/>, the bars are grouped together in one block for each + `TRUE`, the bars are grouped together in one block for each axis, thus they are painted one group over the other. - <p>If <FALSE/>, the bars are displayed side-by-side, as if + <p>If `FALSE`, the bars are displayed side-by-side, as if they were all attached to the same axis.</p> <p>If all data series of a bar or column chart are attached to diff --git a/offapi/com/sun/star/chart/ChartAxis.idl b/offapi/com/sun/star/chart/ChartAxis.idl index 4f5d0110f064..14c885ff21e2 100644 --- a/offapi/com/sun/star/chart/ChartAxis.idl +++ b/offapi/com/sun/star/chart/ChartAxis.idl @@ -103,25 +103,25 @@ published service ChartAxis /** The maximum value of the axis scale is calculated by the chart if - this property is <TRUE/>. + this property is `TRUE`. */ [optional, property] boolean AutoMax; /** The minimum value of the axis scale is calculated by the chart if - this property is <TRUE/>. + this property is `TRUE`. */ [optional, property] boolean AutoMin; /** The distance between the main tick marks is calculated by the chart - if this property is <TRUE/>. + if this property is `TRUE`. */ [optional, property] boolean AutoStepMain; /** The number of help intervals within a main interval is calculated by the - chart if this property is <TRUE/>. + chart if this property is `TRUE`. */ [optional, property] boolean AutoStepHelp; @@ -167,7 +167,7 @@ published service ChartAxis [optional, property] double Origin; - /** The origin is calculated by the chart if this property is <TRUE/>. + /** The origin is calculated by the chart if this property is `TRUE`. */ [optional, property] boolean AutoOrigin; @@ -234,7 +234,7 @@ published service ChartAxis /** Determines if certain labels are hidden, if they would otherwise overlap. - In this case, the value of this property must be set to <FALSE/>. + In this case, the value of this property must be set to `FALSE`. */ [property] boolean TextCanOverlap; diff --git a/offapi/com/sun/star/chart/ChartDataPointProperties.idl b/offapi/com/sun/star/chart/ChartDataPointProperties.idl index e89004bd2119..61aeec40547f 100644 --- a/offapi/com/sun/star/chart/ChartDataPointProperties.idl +++ b/offapi/com/sun/star/chart/ChartDataPointProperties.idl @@ -70,7 +70,7 @@ published service ChartDataPointProperties /** is only available if the chart is of type BarDiagram and Dim3DDiagram and the property ChartDataPointProperties::Dim3D is - set to <TRUE/>. + set to `TRUE`. @see BarDiagram @see Dim3DDiagram@see BarDiagram diff --git a/offapi/com/sun/star/chart/ChartLegend.idl b/offapi/com/sun/star/chart/ChartLegend.idl index 7906341f4b62..b6da8e687e2d 100644 --- a/offapi/com/sun/star/chart/ChartLegend.idl +++ b/offapi/com/sun/star/chart/ChartLegend.idl @@ -44,7 +44,7 @@ published service ChartLegend service com::sun::star::drawing::Shape; - /** If this property is <TRUE/> the position is calculated by the application automatically. + /** If this property is `TRUE` the position is calculated by the application automatically. Setting this property to false will have no effect. Instead use the interface com::sun::star::drawing::XShape to set a concrete position. */ diff --git a/offapi/com/sun/star/chart/ChartLegendPosition.idl b/offapi/com/sun/star/chart/ChartLegendPosition.idl index 73818a731fcf..19f53a7803f4 100644 --- a/offapi/com/sun/star/chart/ChartLegendPosition.idl +++ b/offapi/com/sun/star/chart/ChartLegendPosition.idl @@ -33,7 +33,7 @@ published enum ChartLegendPosition /** no chart legend is displayed. <p>To disable the legend you should set the property - ChartDocument::HasLegend to <FALSE/> instead + ChartDocument::HasLegend to `FALSE` instead of setting this value.</p> */ NONE, diff --git a/offapi/com/sun/star/chart/ChartTitle.idl b/offapi/com/sun/star/chart/ChartTitle.idl index ebca9e9d62e9..b806b32c7e29 100644 --- a/offapi/com/sun/star/chart/ChartTitle.idl +++ b/offapi/com/sun/star/chart/ChartTitle.idl @@ -36,7 +36,7 @@ published service ChartTitle service com::sun::star::drawing::Shape; - /** If this property is <TRUE/> the position is calculated by the application automatically. + /** If this property is `TRUE` the position is calculated by the application automatically. Setting this property to false will have no effect. Instead use the interface com::sun::star::drawing::XShape to set a concrete position. */ diff --git a/offapi/com/sun/star/chart/Diagram.idl b/offapi/com/sun/star/chart/Diagram.idl index 0488d981a059..76f31b00c78f 100644 --- a/offapi/com/sun/star/chart/Diagram.idl +++ b/offapi/com/sun/star/chart/Diagram.idl @@ -65,14 +65,14 @@ published service Diagram [optional] interface com::sun::star::chart::XDiagramPositioning; - /** If this property is <TRUE/> the position is calculated by the application automatically. + /** If this property is `TRUE` the position is calculated by the application automatically. Setting this property to false will have no effect. Instead use the interface com::sun::star::drawing::XShape to set a concrete position (note com::sun::star::chart::XDiagram is derived from com::sun::star::drawing::XShape). */ [optional, property] boolean AutomaticPosition; - /** If this property is <TRUE/> the size is calculated by the application automatically. + /** If this property is `TRUE` the size is calculated by the application automatically. Setting this property to false will have no effect. Instead use the interface com::sun::star::drawing::XShape to set a concrete size (note com::sun::star::chart::XDiagram is derived from com::sun::star::drawing::XShape). */ diff --git a/offapi/com/sun/star/chart/Dim3DDiagram.idl b/offapi/com/sun/star/chart/Dim3DDiagram.idl index 80a462a714a2..a6ef1ae06c3e 100644 --- a/offapi/com/sun/star/chart/Dim3DDiagram.idl +++ b/offapi/com/sun/star/chart/Dim3DDiagram.idl @@ -44,7 +44,7 @@ published service Dim3DDiagram [optional] interface ::com::sun::star::chart::X3DDefaultSetter; - /** If set to <TRUE/>, the chart becomes a three-dimensional + /** If set to `TRUE`, the chart becomes a three-dimensional chart. Otherwise it is two-dimensional. */ [property] boolean Dim3D; diff --git a/offapi/com/sun/star/chart/StackableDiagram.idl b/offapi/com/sun/star/chart/StackableDiagram.idl index 8685734b7858..f940c1d8a38c 100644 --- a/offapi/com/sun/star/chart/StackableDiagram.idl +++ b/offapi/com/sun/star/chart/StackableDiagram.idl @@ -33,13 +33,13 @@ a helper service for stackable chart types (e.g., charts in published service StackableDiagram { - /** If <TRUE/>, the series of the diagram are stacked and each + /** If `TRUE`, the series of the diagram are stacked and each category sums up to 100%. */ [property] boolean Percent; - /** If <TRUE/>, the series of the diagram are stacked. + /** If `TRUE`, the series of the diagram are stacked. <p>If you have a stacked bar chart, you can easily determine the sum of data in each category, by taking the top of the diff --git a/offapi/com/sun/star/chart/StockDiagram.idl b/offapi/com/sun/star/chart/StockDiagram.idl index 96fbbbf2fa63..c58601c7aca0 100644 --- a/offapi/com/sun/star/chart/StockDiagram.idl +++ b/offapi/com/sun/star/chart/StockDiagram.idl @@ -43,8 +43,8 @@ the following structures for different types:</p> <p><strong> - StockDiagram::Volume is <FALSE/><br> - StockDiagram::UpDown is <FALSE/> + StockDiagram::Volume is `FALSE`<br> + StockDiagram::UpDown is `FALSE` </strong> <table border> <tr><td>Low</td><td>High</td><td>Close</td></tr> @@ -52,8 +52,8 @@ </table></p> <p><strong> - StockDiagram::Volume is <TRUE/><br> - StockDiagram::UpDown is <FALSE/> + StockDiagram::Volume is `TRUE`<br> + StockDiagram::UpDown is `FALSE` </strong> <table border> <tr><td><strong>Volume</strong></td><td>Low</td><td>High</td><td>Close</td></tr> @@ -61,8 +61,8 @@ </table></p> <p><strong> - StockDiagram::Volume is <FALSE/><br> - StockDiagram::UpDown is <TRUE/> + StockDiagram::Volume is `FALSE`<br> + StockDiagram::UpDown is `TRUE` </strong> <table border> <tr><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr> @@ -70,8 +70,8 @@ </table></p> <p><strong> - StockDiagram::Volume is <TRUE/><br> - StockDiagram::UpDown is <TRUE/> + StockDiagram::Volume is `TRUE`<br> + StockDiagram::UpDown is `TRUE` </strong> <table border> <tr><td><strong>Volume</strong></td><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr> @@ -93,7 +93,7 @@ published service StockDiagram <p>The values of the volume are represented as columns like those of a BarDiagram.</p> - <p>If this property is set to <TRUE/>, the values of the first + <p>If this property is set to `TRUE`, the values of the first series of the chart data are interpreted as volume.</p> */ [property] boolean Volume; @@ -106,14 +106,14 @@ published service StockDiagram of the bar will be significant for positive or negative differences between open and closed data.</p> - <p>If this property is <FALSE/>, the values of the first + <p>If this property is `FALSE`, the values of the first series (or second if StockDiagram::Volume is - <TRUE/>) of the chart data are interpreted as the day's lowest + `TRUE`) of the chart data are interpreted as the day's lowest value. The next series is interpreted as the day's highest value, and the last series is interpreted as the closing value.</p> - <p>If this property is set to <TRUE/>, one additional series + <p>If this property is set to `TRUE`, one additional series is needed with the opening value of the stocks. It is assumed as the series before the series with the day's lowest value.</p> diff --git a/offapi/com/sun/star/chart/XChartData.idl b/offapi/com/sun/star/chart/XChartData.idl index e6590a2cc8c4..0ce2e1002202 100644 --- a/offapi/com/sun/star/chart/XChartData.idl +++ b/offapi/com/sun/star/chart/XChartData.idl @@ -81,7 +81,7 @@ published interface XChartData: com::sun::star::uno::XInterface result!</p> @returns - <TRUE/> if the number given is interpreted by the chart as + `TRUE` if the number given is interpreted by the chart as a missing value. @param nNumber diff --git a/offapi/com/sun/star/chart/XStatisticDisplay.idl b/offapi/com/sun/star/chart/XStatisticDisplay.idl index ae489d4c05ec..63dfe054ba30 100644 --- a/offapi/com/sun/star/chart/XStatisticDisplay.idl +++ b/offapi/com/sun/star/chart/XStatisticDisplay.idl @@ -41,7 +41,7 @@ published interface XStatisticDisplay: com::sun::star::uno::XInterface /** @returns the properties of the up bars of a stock chart which has - StockDiagram::UpDown set to <TRUE/>. + StockDiagram::UpDown set to `TRUE`. <p>The <em>UpBar</em> is the box that is drawn between the open and close value of a stock, when the closing value is @@ -54,7 +54,7 @@ published interface XStatisticDisplay: com::sun::star::uno::XInterface /** @returns the properties of the down bars of a stock chart which has - StockDiagram::UpDown set to <TRUE/>. + StockDiagram::UpDown set to `TRUE`. <p>The <em>DownBar</em> is the box that is drawn between the open and close value of a stock, when the closing value is diff --git a/offapi/com/sun/star/chart2/CandleStickChartType.idl b/offapi/com/sun/star/chart2/CandleStickChartType.idl index 29787d02f6be..4399bc4403dc 100644 --- a/offapi/com/sun/star/chart2/CandleStickChartType.idl +++ b/offapi/com/sun/star/chart2/CandleStickChartType.idl @@ -39,16 +39,16 @@ service CandleStickChartType */ service ChartType; - /** If this property is <TRUE/>, the candlesticks are shown as + /** If this property is `TRUE`, the candlesticks are shown as Japanese candlesticks. This implies that the property - #ShowFirst is also <TRUE/>. + #ShowFirst is also `TRUE`. <p>Japanese candlesticks show the first and last value as boxes. A rising course (i.e. if the last value is greater than the first one) is shown by a white box. A falling course is shown by a black box.</p> - <p>Default is <FALSE/>.</p> + <p>Default is `FALSE`.</p> @see WhiteDay @see BlackDay @@ -56,7 +56,7 @@ service CandleStickChartType [maybedefault, property] boolean Japanese; /** If the candlestick chart shows Japanese candlesticks, that is - the property #Japanese is <TRUE/>, the + the property #Japanese is `TRUE`, the property set given here contains the formatting attributes of the white boxes, i.e. the boxes shown for rising values.</p> @@ -69,7 +69,7 @@ service CandleStickChartType [maybevoid, property] com::sun::star::beans::XPropertySet WhiteDay; /** If the candlestick chart shows Japanese candlesticks, that is - the property #Japanese is <TRUE/>, the + the property #Japanese is `TRUE`, the property set given here contains the formatting attributes of the black boxes, i.e. the boxes shown for falling values.</p> @@ -81,7 +81,7 @@ service CandleStickChartType */ [maybevoid, property] com::sun::star::beans::XPropertySet BlackDay; - /** If this property is <TRUE/>, the first value (which would be + /** If this property is `TRUE`, the first value (which would be the opening course in a stock chart) is shown in the chart. This also makes the role "values-first" mandatory. @@ -89,15 +89,15 @@ service CandleStickChartType candlestick charts, as Japanese candlesticks always require to show the first value.</p> - <p>Default is <FALSE/>.</p> + <p>Default is `FALSE`.</p> */ [maybedefault, property] boolean ShowFirst; - /** If this property is <TRUE/>, the low and high values are shown + /** If this property is `TRUE`, the low and high values are shown in the chart. This also makes the roles "values-min" and "values-max" mandatory. - <p>Default is <TRUE/>.</p> + <p>Default is `TRUE`.</p> */ [maybedefault, property] boolean ShowHighLow; }; diff --git a/offapi/com/sun/star/chart2/DataPointLabel.idl b/offapi/com/sun/star/chart2/DataPointLabel.idl index ac373a5d8267..5963e8dd93b2 100644 --- a/offapi/com/sun/star/chart2/DataPointLabel.idl +++ b/offapi/com/sun/star/chart2/DataPointLabel.idl @@ -31,7 +31,7 @@ module chart2 struct DataPointLabel { - /** if <TRUE/>, the value that is represented by a data point is + /** if `TRUE`, the value that is represented by a data point is displayed next to it. @see #ShowNumberInPercent @@ -39,7 +39,7 @@ struct DataPointLabel boolean ShowNumber; /** This is only effective, if #ShowNumber is - <TRUE/>. If this member is also <TRUE/>, the numbers are + `TRUE`. If this member is also `TRUE`, the numbers are displayed as percentages of a category. <p>That means, if a data point is the first one of a series, diff --git a/offapi/com/sun/star/chart2/DataPointProperties.idl b/offapi/com/sun/star/chart2/DataPointProperties.idl index 9c46bdf85aa2..da45deffec7f 100644 --- a/offapi/com/sun/star/chart2/DataPointProperties.idl +++ b/offapi/com/sun/star/chart2/DataPointProperties.idl @@ -98,7 +98,7 @@ service DataPointProperties [property] string HatchName; [property] string FillBitmapName; - /** If <TRUE/>, fills the background of a hatch with the color + /** If `TRUE`, fills the background of a hatch with the color given in the #Color property. */ [property] boolean FillBackground; @@ -200,10 +200,10 @@ service DataPointProperties /** specifies if the size is given in percentage or as an absolute value. - <p>If this is <TRUE/>, the properties FillBitmapSizeX + <p>If this is `TRUE`, the properties FillBitmapSizeX and FillBitmapSizeY contain the size of the tile in percent of the size of the original bitmap. If this - is <FALSE/>, the size of the tile is specified + is `FALSE`, the size of the tile is specified with 1/100th mm. */ [property] boolean FillBitmapLogicalSize; diff --git a/offapi/com/sun/star/chart2/DataSeries.idl b/offapi/com/sun/star/chart2/DataSeries.idl index b22287f39a79..922ba446b027 100644 --- a/offapi/com/sun/star/chart2/DataSeries.idl +++ b/offapi/com/sun/star/chart2/DataSeries.idl @@ -153,7 +153,7 @@ service DataSeries */ [property] StackingDirection StackingDirection; - /** If <TRUE/>, the data points of this series get different + /** If `TRUE`, the data points of this series get different colors by default, like in a pie chart. */ [optional, property] boolean VaryColorsByPoint; diff --git a/offapi/com/sun/star/chart2/Diagram.idl b/offapi/com/sun/star/chart2/Diagram.idl index e820364a3cf9..815c2df3ae8c 100644 --- a/offapi/com/sun/star/chart2/Diagram.idl +++ b/offapi/com/sun/star/chart2/Diagram.idl @@ -80,10 +80,10 @@ service Diagram /** If bars of a bar or column chart are attached to different axis, this property determines how to display those. If - <TRUE/>, the bars are grouped together in one block for each + `TRUE`, the bars are grouped together in one block for each axis, thus they are painted one group over the other. - <p>If <FALSE/>, the bars are displayed side-by-side, as if + <p>If `FALSE`, the bars are displayed side-by-side, as if they were all attached to the same axis.</p> <p>If all data series of a bar or column chart are attached to diff --git a/offapi/com/sun/star/chart2/FillBitmap.idl b/offapi/com/sun/star/chart2/FillBitmap.idl index e6c4191eddd9..29da2b57be53 100644 --- a/offapi/com/sun/star/chart2/FillBitmap.idl +++ b/offapi/com/sun/star/chart2/FillBitmap.idl @@ -67,9 +67,9 @@ struct FillBitmap /** specifies if the size is given in percentage or as an absolute value. - <p>If this is <TRUE/>, the properties SizeX and + <p>If this is `TRUE`, the properties SizeX and SizeY contain the size of the tile in percent of the - size of the original bitmap. If this is <FALSE/>, the size of + size of the original bitmap. If this is `FALSE`, the size of the tile is specified with 1/100th mm.</p> */ boolean bLogicalSize; diff --git a/offapi/com/sun/star/chart2/IncrementData.idl b/offapi/com/sun/star/chart2/IncrementData.idl index 3398edfe8ac0..289792e7dc9b 100644 --- a/offapi/com/sun/star/chart2/IncrementData.idl +++ b/offapi/com/sun/star/chart2/IncrementData.idl @@ -47,10 +47,10 @@ struct IncrementData #PostEquidistant rules whether the member #Distance describes a distance before or after the scaling is applied. - <p>If #PostEquidistant equals <TRUE/> #Distance + <p>If #PostEquidistant equals `TRUE` #Distance is given in values after XScaling is applied, thus resulting main tickmarks will always look equidistant on the screen. - If #PostEquidistant equals <FALSE/> #Distance + If #PostEquidistant equals `FALSE` #Distance is given in values before XScaling is applied.</p> */ any PostEquidistant; diff --git a/offapi/com/sun/star/chart2/LightSource.idl b/offapi/com/sun/star/chart2/LightSource.idl index 091298266b16..fcad638af1d6 100644 --- a/offapi/com/sun/star/chart2/LightSource.idl +++ b/offapi/com/sun/star/chart2/LightSource.idl @@ -46,7 +46,7 @@ struct LightSource */ boolean bIsEnabled; - /** When <TRUE/>, the specularity of material is taken into + /** When `TRUE`, the specularity of material is taken into account when lighting an object. */ boolean bSpecular; diff --git a/offapi/com/sun/star/chart2/Title.idl b/offapi/com/sun/star/chart2/Title.idl index 24bcfd5dce98..d1ac0c49be76 100644 --- a/offapi/com/sun/star/chart2/Title.idl +++ b/offapi/com/sun/star/chart2/Title.idl @@ -56,7 +56,7 @@ service Title [property] double TextRotation; /** writes the characters of the title on top of each other if set - to <TRUE/>. + to `TRUE`. */ [property] boolean StackCharacters; diff --git a/offapi/com/sun/star/chart2/XAxis.idl b/offapi/com/sun/star/chart2/XAxis.idl index bf338a12b7ac..70613b8c01cd 100644 --- a/offapi/com/sun/star/chart2/XAxis.idl +++ b/offapi/com/sun/star/chart2/XAxis.idl @@ -52,7 +52,7 @@ interface XAxis : ::com::sun::star::uno::XInterface <p>If you do not want to render certain a sub-grid, in the corresponding XPropertySet the property - GridProperties::Show must be <FALSE/>.</p> + GridProperties::Show must be `FALSE`.</p> */ sequence< com::sun::star::beans::XPropertySet > getSubGridProperties(); diff --git a/offapi/com/sun/star/chart2/XChartDocument.idl b/offapi/com/sun/star/chart2/XChartDocument.idl index e57ec010eb45..217d7fa38109 100644 --- a/offapi/com/sun/star/chart2/XChartDocument.idl +++ b/offapi/com/sun/star/chart2/XChartDocument.idl @@ -66,7 +66,7 @@ interface XChartDocument : ::com::sun::star::frame::XModel stored in a sub-storage.</p> @param bCloneExistingData - if <TRUE/> and a data provider was previously attached, + if `TRUE` and a data provider was previously attached, its referred data will be copied to the new internal data provider. Note, that the range representation set before will usually change after cloning.</p> @@ -78,7 +78,7 @@ interface XChartDocument : ::com::sun::star::frame::XModel void createInternalDataProvider( [in] boolean bCloneExistingData ) raises( com::sun::star::util::CloseVetoException ); - /** @return <TRUE/> if the data provider set at the chart document + /** @return `TRUE` if the data provider set at the chart document is an internal one. <p>This is the case directly after diff --git a/offapi/com/sun/star/chart2/XChartTypeTemplate.idl b/offapi/com/sun/star/chart2/XChartTypeTemplate.idl index 9d0e36416466..52401abab621 100644 --- a/offapi/com/sun/star/chart2/XChartTypeTemplate.idl +++ b/offapi/com/sun/star/chart2/XChartTypeTemplate.idl @@ -63,7 +63,7 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface [in] sequence< com::sun::star::beans::PropertyValue > aArguments ); /** @return - <TRUE/> if the template does support categories + `TRUE` if the template does support categories */ boolean supportsCategories(); @@ -72,7 +72,7 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface creates a new diagram based on these series. <p>Note, that if matchesTemplate() returns - <TRUE/> for the given XDiagram, the latter should + `TRUE` for the given XDiagram, the latter should not be changed.</p> @param xDiagram @@ -91,7 +91,7 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface template.</p> <p>Ideally a matchesTemplate() call for the - given diagram should return <TRUE/> before this method is + given diagram should return `TRUE` before this method is called.</p> @param xDataSource @@ -130,19 +130,19 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface The diagram to be analyzed. @param bAdaptProperties - If <TRUE/> the properties of the template are set, such + If `TRUE` the properties of the template are set, such that the template matches more accurately. E.g. for a line-chart with symbols the property "Symbol" would be set - to <TRUE/>. If this parameter is <FALSE/> the template + to `TRUE`. If this parameter is `FALSE` the template itself stays unmodified. @return - <TRUE/> if the diagram given is structurally identical to + `TRUE` if the diagram given is structurally identical to a diagram that was created using createDiagramByDataSource() or - changeDiagram(). If <FALSE/> is returned + changeDiagram(). If `FALSE` is returned the template stays unmodified even if - <code>bAdaptProperties</code> is <TRUE/>. + <code>bAdaptProperties</code> is `TRUE`. */ boolean matchesTemplate( [in] XDiagram xDiagram, [in] boolean bAdaptProperties ); diff --git a/offapi/com/sun/star/chart2/XDataInterpreter.idl b/offapi/com/sun/star/chart2/XDataInterpreter.idl index 280b2696a020..21b75c82966e 100644 --- a/offapi/com/sun/star/chart2/XDataInterpreter.idl +++ b/offapi/com/sun/star/chart2/XDataInterpreter.idl @@ -69,7 +69,7 @@ interface XDataInterpreter : ::com::sun::star::uno::XInterface without data loss. @return - <TRUE/>, if the data given in + `TRUE`, if the data given in <code>aInterpretedData</code> has a similar structure than the one required is used as output of the data interpreter. */ diff --git a/offapi/com/sun/star/chart2/XRegressionCurveCalculator.idl b/offapi/com/sun/star/chart2/XRegressionCurveCalculator.idl index 21f6573528ea..112df63e4494 100644 --- a/offapi/com/sun/star/chart2/XRegressionCurveCalculator.idl +++ b/offapi/com/sun/star/chart2/XRegressionCurveCalculator.idl @@ -75,7 +75,7 @@ interface XRegressionCurveCalculator : com::sun::star::uno::XInterface instead of nPointCount() points. This is only allowed if the parameter bMaySkipPointsInCalculation() is set to - <TRUE/>. + `TRUE`. <p>It is important that a renderer takes the scalings into account. When one of these parameters is unknown, no @@ -83,7 +83,7 @@ interface XRegressionCurveCalculator : com::sun::star::uno::XInterface @param bMaySkipPointsInCalculation determines whether it is allowed to skip points in the calculation. When this - parameter is <TRUE/> it is assumed that the underlying + parameter is `TRUE` it is assumed that the underlying coordinate system is Cartesian. @param xScalingX a scaling that is used for the values in diff --git a/offapi/com/sun/star/chart2/data/DataProvider.idl b/offapi/com/sun/star/chart2/data/DataProvider.idl index 34ba0becd9aa..c85d464589bf 100644 --- a/offapi/com/sun/star/chart2/data/DataProvider.idl +++ b/offapi/com/sun/star/chart2/data/DataProvider.idl @@ -47,7 +47,7 @@ service DataProvider */ [optional] interface ::com::sun::star::chart2::data::XRangeXMLConversion; - /** If set to false <FALSE/>, values from hidden cells are not returned. + /** If set to false `FALSE`, values from hidden cells are not returned. */ [optional, property] boolean IncludeHiddenCells; }; diff --git a/offapi/com/sun/star/chart2/data/DataSequence.idl b/offapi/com/sun/star/chart2/data/DataSequence.idl index 182b59c9d106..34d655800900 100644 --- a/offapi/com/sun/star/chart2/data/DataSequence.idl +++ b/offapi/com/sun/star/chart2/data/DataSequence.idl @@ -126,7 +126,7 @@ service DataSequence */ [property] DataSequenceRole Role; - /** If set to false <FALSE/>, values from hidden cells are not returned. + /** If set to false `FALSE`, values from hidden cells are not returned. */ [optional, property] boolean IncludeHiddenCells; diff --git a/offapi/com/sun/star/chart2/data/HighlightedRange.idl b/offapi/com/sun/star/chart2/data/HighlightedRange.idl index 716773cbbbfe..4ad181885ba9 100644 --- a/offapi/com/sun/star/chart2/data/HighlightedRange.idl +++ b/offapi/com/sun/star/chart2/data/HighlightedRange.idl @@ -50,7 +50,7 @@ struct HighlightedRange long PreferredColor; /** If the highlighted range is visually highlighted and this - member is <TRUE/>, the range given in + member is `TRUE`, the range given in #RangeRepresentation may be included in a merged range rectangle spanning a bigger range. */ diff --git a/offapi/com/sun/star/chart2/data/TabularDataProviderArguments.idl b/offapi/com/sun/star/chart2/data/TabularDataProviderArguments.idl index cae414cbc9cb..a447f3145a93 100644 --- a/offapi/com/sun/star/chart2/data/TabularDataProviderArguments.idl +++ b/offapi/com/sun/star/chart2/data/TabularDataProviderArguments.idl @@ -82,7 +82,7 @@ service TabularDataProviderArguments generic string like "Column C".</p> <p>If this property is not given as argument it is assumed to - be <FALSE/>, i.e., the default is "no labels".</p> + be `FALSE`, i.e., the default is "no labels".</p> */ [property] boolean FirstCellAsLabel; @@ -107,7 +107,7 @@ service TabularDataProviderArguments */ [property] sequence< long > SequenceMapping; - /** If <FALSE/> the data provider may create a data sequence + /** If `FALSE` the data provider may create a data sequence containing generated categories that fit the rest of the data, like e.g. "Row 12", "Row 13", etc. diff --git a/offapi/com/sun/star/chart2/data/XDataProvider.idl b/offapi/com/sun/star/chart2/data/XDataProvider.idl index e82f5fbd08f3..3ed73e2c4062 100644 --- a/offapi/com/sun/star/chart2/data/XDataProvider.idl +++ b/offapi/com/sun/star/chart2/data/XDataProvider.idl @@ -41,9 +41,9 @@ module data */ interface XDataProvider : ::com::sun::star::uno::XInterface { - /** If <TRUE/> is returned, a call to createDataSource with the + /** If `TRUE` is returned, a call to createDataSource with the same arguments must return a valid XDataSequence object. If - <FALSE/> is returned, createDataSource throws an exception. + `FALSE` is returned, createDataSource throws an exception. */ boolean createDataSourcePossible( [in] sequence< com::sun::star::beans::PropertyValue > aArguments ); @@ -102,9 +102,9 @@ interface XDataProvider : ::com::sun::star::uno::XInterface sequence< com::sun::star::beans::PropertyValue > detectArguments( [in] XDataSource xDataSource ); - /** If <TRUE/> is returned, a call to + /** If `TRUE` is returned, a call to createDataSequenceByRangeRepresentation with the same argument must - return a valid XDataSequence object. If <FALSE/> is returned, + return a valid XDataSequence object. If `FALSE` is returned, createDataSequenceByRangeRepresentation throws an exception. */ boolean createDataSequenceByRangeRepresentationPossible( [in] string aRangeRepresentation ); diff --git a/offapi/com/sun/star/chart2/data/XDatabaseDataProvider.idl b/offapi/com/sun/star/chart2/data/XDatabaseDataProvider.idl index aee06f522396..7a1be1cb26d5 100644 --- a/offapi/com/sun/star/chart2/data/XDatabaseDataProvider.idl +++ b/offapi/com/sun/star/chart2/data/XDatabaseDataProvider.idl @@ -111,7 +111,7 @@ interface XDatabaseDataProvider It then can be to used to specify whether the SQL statement should be analyzed on the client side before sending it to the database server.<br/> The default value for com::sun::star::sdbc::RowSet::EscapeProcessing - is <TRUE/>. By switching it to <FALSE/>, you can pass backend-specific SQL statements, + is `TRUE`. By switching it to `FALSE`, you can pass backend-specific SQL statements, which are not standard SQL, to your database.</p> @@ -147,7 +147,7 @@ interface XDatabaseDataProvider [attribute,bound] string Filter; /** indicates whether the filter should be applied or not, - default is <FALSE/>. + default is `FALSE`. */ [attribute,bound] boolean ApplyFilter; @@ -172,7 +172,7 @@ interface XDatabaseDataProvider /** specifies if the #Command should be analyzed on the client side before sending it to the database server. - <p>The default value of this property is <TRUE/>. By switching it to <FALSE/>, you can pass + <p>The default value of this property is `TRUE`. By switching it to `FALSE`, you can pass backend-specific SQL statements, which are not standard SQL, to your database.</p> <p>This property is usually present together with the #Command and diff --git a/offapi/com/sun/star/configuration/ConfigurationAccess.idl b/offapi/com/sun/star/configuration/ConfigurationAccess.idl index e566b3b54348..9ad0f34ca537 100644 --- a/offapi/com/sun/star/configuration/ConfigurationAccess.idl +++ b/offapi/com/sun/star/configuration/ConfigurationAccess.idl @@ -96,7 +96,7 @@ module com { module sun { module star { module configuration { except for CR, LF and TAB [Unicode code points 9,10,13]. For binary data, use type <strong>binary</strong> instead.</p> </li> - <li><strong>boolean</strong> can hold the values <TRUE/> or <FALSE/>. + <li><strong>boolean</strong> can hold the values `TRUE` or `FALSE`. <p>Values are represented as `boolean`. <p>Sequences are represented as <atom dim="[]">boolean</atom>.</p> </li> @@ -130,7 +130,7 @@ module com { module sun { module star { module configuration { <p>If the schema marks a value as <em>nullable</em> (which is indicated by attribute com::sun::star::beans::PropertyAttribute::MAYBEVOID ), - its contents may be <NULL/>. + its contents may be `NULL`. </p> <p>The configuration should support explicit access to default values diff --git a/offapi/com/sun/star/configuration/ConfigurationProvider.idl b/offapi/com/sun/star/configuration/ConfigurationProvider.idl index fcb3b2bd84f5..a51e936a0996 100644 --- a/offapi/com/sun/star/configuration/ConfigurationProvider.idl +++ b/offapi/com/sun/star/configuration/ConfigurationProvider.idl @@ -170,10 +170,10 @@ published service ConfigurationProvider cache configuration data) <dl> <dt><code>"enableasync"</code> : `boolean`</dt> - <dd>controls how updates are handled in the cache. If <TRUE/>, the + <dd>controls how updates are handled in the cache. If `TRUE`, the cache may operate in <em>write-back</em> mode, where updates at first only affect the cache and are written to persistent storage - at some later time. If <FALSE/>, the cache must operate in + at some later time. If `FALSE`, the cache must operate in <em>write-through</em> mode, where updates are written to persistent storage at once - that is before com::sun::star::util::XChangesBatch::commitChanges() diff --git a/offapi/com/sun/star/configuration/SetElement.idl b/offapi/com/sun/star/configuration/SetElement.idl index 21370fed5770..009ae436cc40 100644 --- a/offapi/com/sun/star/configuration/SetElement.idl +++ b/offapi/com/sun/star/configuration/SetElement.idl @@ -103,14 +103,14 @@ published service SetElement <p>In this service, this interface is mandatory</p> <p>com::sun::star::container::XChild::getParent() - returns <NULL/>, if the object is currently not contained in a container. + returns `NULL`, if the object is currently not contained in a container. </p> <p>An implementation may also support com::sun::star::container::XChild::setParent(). If it does, changing the parent has the effect of first removing the object from its old parent (if any) and then inserting it into the new parent - (unless that is <NULL/>) under the same name. The new parent must be part of + (unless that is `NULL`) under the same name. The new parent must be part of the same hierarchy as the old one. The name of the object must have been set before. </p> @@ -123,7 +123,7 @@ published service SetElement com::sun::star::lang::XComponent::dispose(), only if the object is currently not contained in a container ( com::sun::star::container::XChild::getParent() - returns <NULL/>). + returns `NULL`). </p> <p>Clients may register an com::sun::star::lang::XEventListener diff --git a/offapi/com/sun/star/configuration/SimpleSetUpdate.idl b/offapi/com/sun/star/configuration/SimpleSetUpdate.idl index 666f232e20ae..73531678322e 100644 --- a/offapi/com/sun/star/configuration/SimpleSetUpdate.idl +++ b/offapi/com/sun/star/configuration/SimpleSetUpdate.idl @@ -73,7 +73,7 @@ published service SimpleSetUpdate <p>Objects to be inserted must not be contained in any set at the time of insertion. com::sun::star::container::XChild::getParent() - must return <NULL/>. If a name had been assigned to the object prior to insertion + must return `NULL`. If a name had been assigned to the object prior to insertion (using com::sun::star::container::XNamed::setName() or by other means), this name is ignored and will be lost. After insertion the name of the object is the name that was used as argument diff --git a/offapi/com/sun/star/configuration/backend/CopyImporter.idl b/offapi/com/sun/star/configuration/backend/CopyImporter.idl index 42ff761905eb..68bfae8e7ddb 100644 --- a/offapi/com/sun/star/configuration/backend/CopyImporter.idl +++ b/offapi/com/sun/star/configuration/backend/CopyImporter.idl @@ -54,7 +54,7 @@ published service CopyImporter com::sun::star::beans::NamedValue: <dl> <dt><code>Overwrite</code> : `boolean`</dt> - <dd>If <FALSE/>, specifies that the data should be applied + <dd>If `FALSE`, specifies that the data should be applied only if the existing layer is empty. </dd> </dl> diff --git a/offapi/com/sun/star/configuration/backend/DataImporter.idl b/offapi/com/sun/star/configuration/backend/DataImporter.idl index 0250a49e3ecd..8f3bba9cd47c 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. @@ -65,14 +65,14 @@ published service DataImporter By default, a MergeImporter should be used. </dd> <dt><code>OverwriteExisting</code> : <atom >boolean</atom></dt> - <dd>If <TRUE/>, specifies that no existing data should be + <dd>If `TRUE`, specifies that no existing data should be overwritten by the import. If the Importer used does not support such protection, an error may be raised. If some data is not imported, because there is existing data, this is indicated by returning an appropriate exception. </dd> <dt><code>TruncateExisting</code> : <atom >boolean</atom></dt> - <dd>If <TRUE/>, specifies that existing data should be + <dd>If `TRUE`, specifies that existing data should be discarded and replaced by the imported data. If the Importer used does not support this operation, an error may be raised. diff --git a/offapi/com/sun/star/configuration/backend/Importer.idl b/offapi/com/sun/star/configuration/backend/Importer.idl index 58b61aa7b5e4..8ea23576bc66 100644 --- a/offapi/com/sun/star/configuration/backend/Importer.idl +++ b/offapi/com/sun/star/configuration/backend/Importer.idl @@ -52,7 +52,7 @@ published service Importer <dl> <dt><code>Notify</code> : `boolean`</dt> - <dd>If <TRUE/>, specifies that the backend should trigger + <dd>If `TRUE`, specifies that the backend should trigger notification to its listeners. </dd> </dl> diff --git a/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl b/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl index 325aad786685..8926d2142d08 100644 --- a/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl +++ b/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl @@ -61,11 +61,11 @@ published service LayerUpdateMerger Implementations should support the following named arguments: <dl> <dt><code>Overwrite</code> : `boolean`</dt> - <dd>If <FALSE/>, specifies that changes should be applied + <dd>If `FALSE`, specifies that changes should be applied only if the existing layer is empty. </dd> <dt><code>Truncate</code> : `boolean`</dt> - <dd>If <TRUE/> requests that changes should not be merged onto + <dd>If `TRUE` requests that changes should not be merged onto existing data, but that the changes should be applied to a layer that is completely empty. </dd> diff --git a/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl b/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl index be3af71ea7fb..6df0c05d50e3 100644 --- a/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl +++ b/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl @@ -51,11 +51,11 @@ published service LocalDataImporter <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, + 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/LocalHierarchyBrowser.idl b/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl index d8f26b9db6e2..e097f21df7e3 100644 --- a/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl +++ b/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl @@ -58,8 +58,8 @@ published service LocalHierarchyBrowser so argument <code>SchemaDataUrl</code> should not be specified. </dd> <dt><code>FetchComponentNames</code> : `boolean`</dt> - <dd><ul><li>if <TRUE/> components will be returned as component names,</li> - <li>if <FALSE/> components will be returned as fileURLs,</li> + <dd><ul><li>if `TRUE` components will be returned as component names,</li> + <li>if `FALSE` components will be returned as fileURLs,</li> <li>if this argument is not provided, the default is to retrieve names when browsing schemas and URLs when browsing layers.</li> diff --git a/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl b/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl index fad277e77fb1..709f52c3ceb4 100644 --- a/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl +++ b/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl @@ -61,9 +61,9 @@ exception MergeRecoveryRequest: ::com::sun::star::uno::Exception /** specifies whether the requester wants to remove or skip the invalid layer. - <p> If <TRUE/> the requester wants to remove the underlying data of + <p> If `TRUE` the requester wants to remove the underlying data of the layer.<BR/> - If <FALSE/> the request is to skip the underlying data this time, + If `FALSE` the request is to skip the underlying data this time, but without removing it. </p> */ diff --git a/offapi/com/sun/star/configuration/backend/OfflineBackend.idl b/offapi/com/sun/star/configuration/backend/OfflineBackend.idl index f9e6aa0eb0c6..4d7a5181d1c9 100644 --- a/offapi/com/sun/star/configuration/backend/OfflineBackend.idl +++ b/offapi/com/sun/star/configuration/backend/OfflineBackend.idl @@ -40,7 +40,7 @@ published service OfflineBackend /** provides access to configuration data from a SingleBackend. <p>If no backend is provided during initialization or if the context - contains an <code>Offline</code> flag that is <TRUE/>, then off-line mode + contains an <code>Offline</code> flag that is `TRUE`, then off-line mode is activated. This may fail, if the off-line cache has not been filled during a previous execution. </p> diff --git a/offapi/com/sun/star/configuration/backend/XBackendEntities.idl b/offapi/com/sun/star/configuration/backend/XBackendEntities.idl index 6d0409f286b8..7f1bf481c9f2 100644 --- a/offapi/com/sun/star/configuration/backend/XBackendEntities.idl +++ b/offapi/com/sun/star/configuration/backend/XBackendEntities.idl @@ -82,8 +82,8 @@ published interface XBackendEntities : ::com::sun::star::uno::XInterface if an error occurs while accessing the backend. @returns - <TRUE/>, if aEntity is a valid, existing entity for this backend, - <FALSE/> otherwise. + `TRUE`, if aEntity is a valid, existing entity for this backend, + `FALSE` otherwise. */ boolean supportsEntity([in] string aEntity) raises( BackendAccessException ); @@ -99,8 +99,8 @@ published interface XBackendEntities : ::com::sun::star::uno::XInterface The name of another entity. @returns - <TRUE/>, if aEntity and aOtherEntity denote the same entity - within this backend, <FALSE/> otherwise. + `TRUE`, if aEntity and aOtherEntity denote the same entity + within this backend, `FALSE` otherwise. @throws com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the backend. diff --git a/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl b/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl index 8966258bb513..a918488f24ce 100644 --- a/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl +++ b/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl @@ -68,7 +68,7 @@ published interface XCompositeLayer : XLayer </p> @throws com::sun::star::lang::NullPointerException - if a <NULL/> handler is passed. + if a `NULL` handler is passed. @throws com::sun::star::lang::IllegalArgumentException if the identifier is invalid. @throws com::sun::star::lang::WrappedTargetException diff --git a/offapi/com/sun/star/configuration/backend/XLayer.idl b/offapi/com/sun/star/configuration/backend/XLayer.idl index 4d85f5f6402c..e2948554f429 100644 --- a/offapi/com/sun/star/configuration/backend/XLayer.idl +++ b/offapi/com/sun/star/configuration/backend/XLayer.idl @@ -45,7 +45,7 @@ published interface XLayer : ::com::sun::star::uno::XInterface describing the contents of the layer @throws com::sun::star::lang::NullPointerException - if a <NULL/> handler is passed. + if a `NULL` handler is passed. @throws com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data. @throws com::sun::star::configuration::backend::MalformedDataException diff --git a/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl b/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl index 0439a023ad6c..355ab485f854 100644 --- a/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl +++ b/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl @@ -50,7 +50,7 @@ interface XLayerContentDescriber : ::com::sun::star::uno::XInterface all required property information @throws com::sun::star::lang::NullPointerException - if a <NULL/> handler is passed. + if a `NULL` handler is passed. @throws com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the XLayerHandler. diff --git a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl index 50d02ed27184..e9e4e95f58fb 100644 --- a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl @@ -97,7 +97,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface </p> @param bClear - if <TRUE/>, specifies that the node should be cleared to an empty + if `TRUE`, specifies that the node should be cleared to an empty state by removing all non-mandatory children from lower layers prior to applying the overrides. @@ -306,7 +306,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface </p> @param bClear - if <TRUE/>, specifies that the property should be cleared to an empty + if `TRUE`, specifies that the property should be cleared to an empty state by discarding all values from lower layers prior to applying the overrides. diff --git a/offapi/com/sun/star/configuration/backend/XLayerImporter.idl b/offapi/com/sun/star/configuration/backend/XLayerImporter.idl index 96c34e5bfd37..77002a6d869b 100644 --- a/offapi/com/sun/star/configuration/backend/XLayerImporter.idl +++ b/offapi/com/sun/star/configuration/backend/XLayerImporter.idl @@ -55,7 +55,7 @@ published interface XLayerImporter : ::com::sun::star::uno::XInterface imported by <method>XLayerImporter::importLayer()<method/>. @throws com::sun::star::lang::NullPointerException - if the backend passed is <NULL/>. + if the backend passed is `NULL`. */ void setTargetBackend([in] XBackend aBackend) raises (com::sun::star::lang::NullPointerException) ; @@ -69,7 +69,7 @@ published interface XLayerImporter : ::com::sun::star::uno::XInterface a layer whose data will be imported into the backend @throws com::sun::star::lang::NullPointerException - if the layer passed is <NULL/> or no backend is available. + if the layer passed is `NULL` or no backend is available. @throws com::sun::star::configuration::backend::MalformedDataException if the layer passed is invalid @@ -101,7 +101,7 @@ published interface XLayerImporter : ::com::sun::star::uno::XInterface a entity into whose data the layer will be imported @throws com::sun::star::lang::NullPointerException - if the layer passed is <NULL/> or no backend is available. + if the layer passed is `NULL` or no backend is available. @throws com::sun::star::configuration::backend::MalformedDataException if the layer passed is invalid diff --git a/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl b/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl index de938d510b74..5c20f01bb3ba 100644 --- a/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl +++ b/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl @@ -154,7 +154,7 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface @returns a Layer object providing access to the layer data, - <NULL/> if the layer is newer than indicated by the timestamp. + `NULL` if the layer is newer than indicated by the timestamp. @throws com::sun::star::lang::IllegalArgumentException if the layer id is invalid or @@ -203,7 +203,7 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface position. </p> <p> For layers that are newer than indicated by the - timestamp, the list contains a <NULL/> element. + timestamp, the list contains a `NULL` element. </p> @throws com::sun::star::lang::IllegalArgumentException @@ -257,7 +257,7 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface position. </p> <p> For layers that are newer than indicated by the corresponding - timestamp, the list contains a <NULL/> element. + timestamp, the list contains a `NULL` element. </p> @throws com::sun::star::lang::IllegalArgumentException diff --git a/offapi/com/sun/star/configuration/backend/XSchema.idl b/offapi/com/sun/star/configuration/backend/XSchema.idl index d061a8cf3a81..606cadcbf3cf 100644 --- a/offapi/com/sun/star/configuration/backend/XSchema.idl +++ b/offapi/com/sun/star/configuration/backend/XSchema.idl @@ -48,7 +48,7 @@ published interface XSchema : ::com::sun::star::uno::XInterface and the component definition @throws com::sun::star::lang::NullPointerException - if a <NULL/> handler is passed. + if a `NULL` handler is passed. @throws com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or if a subsequent call to any of the XSchemamethods is made. @@ -73,7 +73,7 @@ published interface XSchema : ::com::sun::star::uno::XInterface definition @throws com::sun::star::lang::NullPointerException - if a <NULL/> handler is passed. + if a `NULL` handler is passed. @throws com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or if a subsequent call to any of the XSchemamethods is made. @@ -97,7 +97,7 @@ published interface XSchema : ::com::sun::star::uno::XInterface describing the contents of the templates @throws com::sun::star::lang::NullPointerException - if a <NULL/> handler is passed. + if a `NULL` handler is passed. @throws com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or if a subsequent call to any of the XSchemamethods is made. diff --git a/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl b/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl index 531079c4b690..f210a87a930b 100644 --- a/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl @@ -359,7 +359,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface /** receives notification that a property is added to the current node. - <p> The property will have a default value of <NULL/> + <p> The property will have a default value of `NULL` (unless it is SchemaAttribute::REQUIRED). </p> diff --git a/offapi/com/sun/star/configuration/backend/XSchemaSupplier.idl b/offapi/com/sun/star/configuration/backend/XSchemaSupplier.idl index 1952a4a03bf9..6c7319006722 100644 --- a/offapi/com/sun/star/configuration/backend/XSchemaSupplier.idl +++ b/offapi/com/sun/star/configuration/backend/XSchemaSupplier.idl @@ -45,7 +45,7 @@ published interface XSchemaSupplier : ::com::sun::star::uno::XInterface @returns an object allowing access to the various parts of the schema, - <NULL/> if the component doesn't exist. + `NULL` if the component doesn't exist. @throws com::sun::star::lang::IllegalArgumentException if the component identifier is invalid. diff --git a/offapi/com/sun/star/configuration/backend/XSingleLayerStratum.idl b/offapi/com/sun/star/configuration/backend/XSingleLayerStratum.idl index dca7b2f4d1c6..6faa25a3062e 100644 --- a/offapi/com/sun/star/configuration/backend/XSingleLayerStratum.idl +++ b/offapi/com/sun/star/configuration/backend/XSingleLayerStratum.idl @@ -71,7 +71,7 @@ published interface XSingleLayerStratum : ::com::sun::star::uno::XInterface @returns a Layer object providing access to the layer data, - <NULL/> if the layer is newer than indicated by the timestamp. + `NULL` if the layer is newer than indicated by the timestamp. @throws com::sun::star::lang::IllegalArgumentException if the component identifier is invalid or diff --git a/offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl b/offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl index a56482f3efa2..dcc9e35eca38 100644 --- a/offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl +++ b/offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl @@ -52,7 +52,7 @@ published interface XUpdatableLayer : XLayer replacement layer @throws com::sun::star::lang::NullPointerException - if a <NULL/> handler is passed. + if a `NULL` handler is passed. @throws com::sun::star::lang::WrappedTargetException if an error occurs during the replacement. @throws com::sun::star::configuration::backend::MalformedDataException diff --git a/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl b/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl index 0c75533de71e..3b6651535e04 100644 --- a/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl @@ -111,7 +111,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface </p> @param bReset - if <TRUE/>, specifies that the node should be reset to its default + if `TRUE`, specifies that the node should be reset to its default state as given by lower layers and the schema or template prior to applying the changes. @@ -544,7 +544,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface raises( MalformedDataException, com::sun::star::lang::WrappedTargetException ); - /** receives notification that a property having a non-<NULL/> value + /** receives notification that a property having a non-`NULL` value is added to the current node. <p> The current node must be extensible and diff --git a/offapi/com/sun/star/datatransfer/XMimeContentType.idl b/offapi/com/sun/star/datatransfer/XMimeContentType.idl index 4c3fc9f43486..f7123876dc63 100644 --- a/offapi/com/sun/star/datatransfer/XMimeContentType.idl +++ b/offapi/com/sun/star/datatransfer/XMimeContentType.idl @@ -69,8 +69,8 @@ published interface XMimeContentType : com::sun::star::uno::XInterface The name of the parameter to query for. @returns - A value of <TRUE/> if the MIME content-type has the specified parameter. - <p>A value of <FALSE/> if the MIME content-type has not the specified parameter.</p> + A value of `TRUE` if the MIME content-type has the specified parameter. + <p>A value of `FALSE` if the MIME content-type has not the specified parameter.</p> */ boolean hasParameter( [in] string aName ); diff --git a/offapi/com/sun/star/datatransfer/XTransferable.idl b/offapi/com/sun/star/datatransfer/XTransferable.idl index 08e2d6610c6c..c59a3752afb6 100644 --- a/offapi/com/sun/star/datatransfer/XTransferable.idl +++ b/offapi/com/sun/star/datatransfer/XTransferable.idl @@ -69,8 +69,8 @@ published interface XTransferable: com::sun::star::uno::XInterface Describes the format that should be checked @returns - A value of <TRUE/> if the DataFlavor is supported by the transfer source. - <p>A value of <FALSE/> if the DataFlavor is unsupported by the transfer source.</p> + A value of `TRUE` if the DataFlavor is supported by the transfer source. + <p>A value of `FALSE` if the DataFlavor is unsupported by the transfer source.</p> <br/><br/><p><strong>Note: </strong>This method is only for analogy with the JAVA Clipboard interface. To avoid many calls, the caller should instead use diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl index b0c2ca11e21e..2f27b90e1425 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl @@ -70,8 +70,8 @@ published interface XDropTarget: com::sun::star::uno::XInterface /** Sets the drop target object active or inactive. @param active - A value of <TRUE/> sets the drop target object active. - <p>A value of <FALSE/> sets the drop target object inactive. + A value of `TRUE` sets the drop target object active. + <p>A value of `FALSE` sets the drop target object inactive. */ void setActive( [in] boolean active ); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl index 9b5a0ad7920e..1f1f2dcdc9fd 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl @@ -64,8 +64,8 @@ published interface XDropTargetDropContext : com::sun::star::uno::XInterface /** Signals that the drop is completed and if it was successful or not. @param success - A value of <TRUE/> means the drop completed successfully - <p>A value of <FALSE/> means the drop completed unsuccessfully.</p> + A value of `TRUE` means the drop completed successfully + <p>A value of `FALSE` means the drop completed unsuccessfully.</p> */ void dropComplete( [in] boolean success ); diff --git a/offapi/com/sun/star/deployment/DependencyException.idl b/offapi/com/sun/star/deployment/DependencyException.idl index a74c1802e7f0..1a95466b7f24 100644 --- a/offapi/com/sun/star/deployment/DependencyException.idl +++ b/offapi/com/sun/star/deployment/DependencyException.idl @@ -53,7 +53,7 @@ exception DependencyException: com::sun::star::uno::Exception { value of that attribute to the user.</p> <p>The sequence must not be empty, and none of the elements may be - <NULL/>.</p> + `NULL`.</p> */ sequence< com::sun::star::xml::dom::XElement > UnsatisfiedDependencies; }; diff --git a/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl b/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl index e7b8a6c3d4a8..ee43fdf66e2d 100644 --- a/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl +++ b/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl @@ -44,7 +44,7 @@ exception InvalidRemovedParameterException: com::sun::star::uno::Exception { <code>url</code> parameter during XPackageRegistry::bindPackage(). - <p>Must not be <NULL/>.</p> + <p>Must not be `NULL`.</p> */ XPackage Extension; }; diff --git a/offapi/com/sun/star/deployment/VersionException.idl b/offapi/com/sun/star/deployment/VersionException.idl index 169ac35f5cc3..d9e74e67b0ed 100644 --- a/offapi/com/sun/star/deployment/VersionException.idl +++ b/offapi/com/sun/star/deployment/VersionException.idl @@ -47,7 +47,7 @@ exception VersionException: com::sun::star::uno::Exception { /** represents the already installed version of the deployment unit. - <p>Must not be <NULL/>.</p> + <p>Must not be `NULL`.</p> */ XPackage Deployed; }; diff --git a/offapi/com/sun/star/deployment/XPackage.idl b/offapi/com/sun/star/deployment/XPackage.idl index 4c4c471cbced..2c9286605ceb 100644 --- a/offapi/com/sun/star/deployment/XPackage.idl +++ b/offapi/com/sun/star/deployment/XPackage.idl @@ -63,8 +63,8 @@ interface XPackage /** checks if the package can be installed. - Only if the return value is <TRUE/> the package is allowed to be installed. - In case of <FALSE/> or in case of an exception, the package must be removed + Only if the return value is `TRUE` the package is allowed to be installed. + In case of `FALSE` or in case of an exception, the package must be removed completely. After return of this function no code from the extension may be used anymore, so that the extension can be safely removed from the hard disk. @@ -75,7 +75,7 @@ interface XPackage indicates that an extension with the same identifier is already installed. @return - <NULL/> - all prerequisites are met. Otherwise, a value from + `NULL` - all prerequisites are met. Otherwise, a value from #Prerequisites indicating what prerequisites are missing. */ long checkPrerequisites( @@ -98,8 +98,8 @@ interface XPackage command environment for error handling and other interaction. @return - <TRUE/> - all dependencies are satisfied - <FALSE/> - at least one dependency failed. + `TRUE` - all dependencies are satisfied + `FALSE` - at least one dependency failed. */ boolean checkDependencies( [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv ) @@ -113,11 +113,11 @@ interface XPackage @param xAbortChannel abort channel to asynchronously abort the registration process, - or <NULL/> + or `NULL` @param xCmdEnv command environment for error and progress handling @return - status whether the package is registered (<TRUE/>, <FALSE/>) or + status whether the package is registered (`TRUE`, `FALSE`) or the status is ambiguous. Additionally, a registration status may not apply, e.g. in case of an empty package bundle. */ @@ -135,11 +135,11 @@ interface XPackage @param startup indicates that registration is adapted to the particular - startup scenario. That is, it is set to <TRUE/>, when called + startup scenario. That is, it is set to `TRUE`, when called from XExtensionManager::synchronize() @param xAbortChannel abort channel to asynchronously abort the registration process, - or <NULL/> + or `NULL` @param xCmdEnv command environment for error and progress handling */ @@ -159,11 +159,11 @@ interface XPackage @param startup indicates that registration is adapted to the particular - startup scenario. That is, it is set to <TRUE/>, when called + startup scenario. That is, it is set to `TRUE`, when called from XExtensionManager::synchronize() @param xAbortChannel abort channel to asynchronously abort the registration process, - or <NULL/> + or `NULL` @param xCmdEnv command environment for error and progress handling */ @@ -180,18 +180,18 @@ interface XPackage e.g. a zip (legacy) package file or a document hosting script packages. @return - <TRUE/> if this package is a package bundle, <FALSE/> otherwise + `TRUE` if this package is a package bundle, `FALSE` otherwise */ boolean isBundle(); /** Gets packages of the bundle. - If isRemoved() returns <TRUE/> then getBundle may return an + If isRemoved() returns `TRUE` then getBundle may return an empty sequence in case the object is not registered. @param xAbortChannel abort channel to asynchronously abort the registration process, - or <NULL/> + or `NULL` @param xCmdEnv command environment for error and progress handling @return @@ -322,7 +322,7 @@ interface XPackage return high contrast icon @return the icon which should be used to represent the table in the - database application window, or <NULL/> if the default icon + database application window, or `NULL` if the default icon should be used. */ com::sun::star::graphic::XGraphic getIcon( [in] boolean highContrast ) @@ -342,7 +342,7 @@ interface XPackage If registration data are created during registration, but the package is currently not registered, for example after calling XPackage::revokePackage(), then <member - scope="com::sun::star::beans">Optional::IsPresent</member> is <TRUE/> and + scope="com::sun::star::beans">Optional::IsPresent</member> is `TRUE` and the com::sun::star::beans::Optional::Value may be an empty string. */ @@ -351,7 +351,7 @@ interface XPackage /** indicates if this object represents a removed extension or extension item. This is the case when it was created by providing - <TRUE/> for the <code>removed</code> parameter in the function + `TRUE` for the <code>removed</code> parameter in the function XPackageRegistry::bindPackage(). */ boolean isRemoved(); diff --git a/offapi/com/sun/star/document/DocumentEvent.idl b/offapi/com/sun/star/document/DocumentEvent.idl index 6a5e72bbdd1d..0b54ad20dca8 100644 --- a/offapi/com/sun/star/document/DocumentEvent.idl +++ b/offapi/com/sun/star/document/DocumentEvent.idl @@ -49,7 +49,7 @@ struct DocumentEvent : ::com::sun::star::lang::EventObject /** denotes the view respectively controller which the event applies to. - <p>Might be <NULL/> if the event is not related to a concrete view of + <p>Might be `NULL` if the event is not related to a concrete view of the document.</p> */ ::com::sun::star::frame::XController2 diff --git a/offapi/com/sun/star/document/ExtendedTypeDetection.idl b/offapi/com/sun/star/document/ExtendedTypeDetection.idl index 324c6d20e18f..02e2652a5c9e 100644 --- a/offapi/com/sun/star/document/ExtendedTypeDetection.idl +++ b/offapi/com/sun/star/document/ExtendedTypeDetection.idl @@ -73,7 +73,7 @@ published service ExtendedTypeDetection which contains information about the document which should be detected and must return <ul> <li>an internal type name for detected format</li> - <li>or <NULL/> if format is unknown nor supported.</li> + <li>or `NULL` if format is unknown nor supported.</li> </ul> May be that given descriptor already includes the opened document stream as parameter MediaDescriptor::InputStream. Then this one should be used every time. diff --git a/offapi/com/sun/star/document/MediaDescriptor.idl b/offapi/com/sun/star/document/MediaDescriptor.idl index fceaede3d0ec..3ba1a444caaa 100644 --- a/offapi/com/sun/star/document/MediaDescriptor.idl +++ b/offapi/com/sun/star/document/MediaDescriptor.idl @@ -64,8 +64,8 @@ service MediaDescriptor <p> Loading a component of type "template" creates a new untitled document - by default, but setting the "AsTemplate" property to <FALSE/> loads the - template document for editing. Setting "AsTemplate" to <TRUE/> creates a + by default, but setting the "AsTemplate" property to `FALSE` loads the + template document for editing. Setting "AsTemplate" to `TRUE` creates a new untitled document out of the loaded document, even if it has not a "template" type. </p> @@ -307,7 +307,7 @@ service MediaDescriptor /** opens a new view for an already loaded document <p> - Setting this to <TRUE/> forces the component to create a new window on loading + Setting this to `TRUE` forces the component to create a new window on loading in any case. If the component supports multiple views, a second view is opened, if not, the component is loaded one more time. Otherwise the behavior depends on the default window handling of the com::sun::star::frame::Desktop environment. @@ -319,7 +319,7 @@ service MediaDescriptor /** overwrite any existing file <p> - For storing only: overwrite any existing file, default is <FALSE/>, + For storing only: overwrite any existing file, default is `FALSE`, so an error occurs if the target file already exists. </p> */ @@ -361,9 +361,9 @@ service MediaDescriptor /** show preview <p> - Setting this to <TRUE/> tells the a loaded component that it is loaded as + Setting this to `TRUE` tells the a loaded component that it is loaded as a preview, so it can optimize loading and viewing for this special purpose. - Default is <FALSE/>. + Default is `FALSE`. </p> */ [optional,property] boolean Preview; @@ -409,7 +409,7 @@ service MediaDescriptor /** let the document be opened in repair mode <p> - For loading of corrupted zip packages: Setting this to <TRUE/> let the document + For loading of corrupted zip packages: Setting this to `TRUE` let the document be opened in repair mode, so as much as possible information will be retrieved. </p> @@ -471,9 +471,9 @@ service MediaDescriptor /** regulate using of compressing <p> - For storing: Setting this to <TRUE/> means, don't use a zip file to save + For storing: Setting this to `TRUE` means, don't use a zip file to save the document, use a folder instead (only usable for UCB contents, that - support folders). Default is <FALSE/>. + support folders). Default is `FALSE`. </p> */ [optional,property] boolean Unpacked; diff --git a/offapi/com/sun/star/document/OfficeDocument.idl b/offapi/com/sun/star/document/OfficeDocument.idl index acb0ff1fb378..5303ae7cafa8 100644 --- a/offapi/com/sun/star/document/OfficeDocument.idl +++ b/offapi/com/sun/star/document/OfficeDocument.idl @@ -132,7 +132,7 @@ published service OfficeDocument /** controls the focus behavior of the form controls in the document <p> - If this flag is set to <TRUE/>, any view belonging to the document + If this flag is set to `TRUE`, any view belonging to the document should focus the first control in the document. With this, you may control if your document works primarily as a form document. </p> @@ -141,8 +141,8 @@ published service OfficeDocument /** controls the initial (on-load) behavior of the form controls in the document - <p>If set to <TRUE/>, upon loading the document, the form controls will be in design mode.<br/> - If set to <FALSE/>, they will be alive, i.e. operational.<br/> + <p>If set to `TRUE`, upon loading the document, the form controls will be in design mode.<br/> + If set to `FALSE`, they will be alive, i.e. operational.<br/> With this, you may control if your document works primarily as a form document. </p> */ diff --git a/offapi/com/sun/star/document/Settings.idl b/offapi/com/sun/star/document/Settings.idl index 9a94f005cf48..b0c6f3189926 100644 --- a/offapi/com/sun/star/document/Settings.idl +++ b/offapi/com/sun/star/document/Settings.idl @@ -159,13 +159,13 @@ published service Settings <p>Note, that you have to print in duplex mode, if both, #IsPrintBookletFront and - #IsPrintBookletBack are set to <TRUE/>.</p> + #IsPrintBookletBack are set to `TRUE`.</p> */ [optional, property] boolean IsPrintBooklet; // Draw and Impress /** is only effective, if #IsPrintBooklet is - <TRUE/>. If this property is also <TRUE/>, only the fronts of + `TRUE`. If this property is also `TRUE`, only the fronts of the pages of your booklet are printed. <p>This is especially useful, if your printer does not supply @@ -175,7 +175,7 @@ published service Settings // Draw and Impress /** is only effective, if #IsPrintBooklet is - <TRUE/>. If this property is also <TRUE/>, only the backs of + `TRUE`. If this property is also `TRUE`, only the backs of the pages of your booklet are printed. <p>This is especially useful, if your printer does not supply diff --git a/offapi/com/sun/star/document/XActionLockable.idl b/offapi/com/sun/star/document/XActionLockable.idl index a2e1bb9450a8..f1bbb386ca76 100644 --- a/offapi/com/sun/star/document/XActionLockable.idl +++ b/offapi/com/sun/star/document/XActionLockable.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module document { published interface XActionLockable: com::sun::star::uno::XInterface { /** @returns - <TRUE/> if at least one lock exists. + `TRUE` if at least one lock exists. */ boolean isActionLocked(); diff --git a/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl b/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl index e22552c503f4..793690ec4c8b 100644 --- a/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl +++ b/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl @@ -46,7 +46,7 @@ interface XDocumentEventBroadcaster @param _Listener the listener to register. The behavior of the method is undefined this listener - is <NULL/>. + is `NULL`. */ void addDocumentEventListener( [in] XDocumentEventListener _Listener ); @@ -54,7 +54,7 @@ interface XDocumentEventBroadcaster @param _Listener the listener to revoke. The behavior of the method is undefined this listener - is <NULL/>. + is `NULL`. */ void removeDocumentEventListener( [in] XDocumentEventListener _Listener ); @@ -74,7 +74,7 @@ interface XDocumentEventBroadcaster @param _EventName the name of the event to be notified. @param _ViewController - the view/controller which the event applies to. May be <NULL/> + the view/controller which the event applies to. May be `NULL` @param _Supplement supplemental information related to the event. diff --git a/offapi/com/sun/star/document/XDocumentProperties.idl b/offapi/com/sun/star/document/XDocumentProperties.idl index c6a53a4f6a70..5a4b1f5c221c 100644 --- a/offapi/com/sun/star/document/XDocumentProperties.idl +++ b/offapi/com/sun/star/document/XDocumentProperties.idl @@ -285,7 +285,7 @@ published interface XDocumentProperties </p> @throws com::sun::star::lang::IllegalArgumentException - if argument is <NULL/> + if argument is `NULL` @throws com::sun::star::io::WrongFormatException if parsing the XML document fails @throws com::sun::star::lang::WrappedTargetException @@ -351,7 +351,7 @@ published interface XDocumentProperties </p> @throws com::sun::star::lang::IllegalArgumentException - if argument is <NULL/> + if argument is `NULL` @throws com::sun::star::lang::WrappedTargetException if thrown when trying to open a stream in the given storage @throws com::sun::star::io::IOException diff --git a/offapi/com/sun/star/document/XDocumentRecovery.idl b/offapi/com/sun/star/document/XDocumentRecovery.idl index 3507a43b804d..96c6968f3a26 100644 --- a/offapi/com/sun/star/document/XDocumentRecovery.idl +++ b/offapi/com/sun/star/document/XDocumentRecovery.idl @@ -40,12 +40,12 @@ interface XDocumentRecovery <p>When saving a session, either in case of a emergency (when OpenOffice.org crashed), or during a periodic session save as configured by the user, storeToRecoveryFile() is called for every - document where <code>wasModifiedSinceLastSave</code> returns <TRUE/>.</p> + document where <code>wasModifiedSinceLastSave</code> returns `TRUE`.</p> - <p>It's allowed to implement this method sloppy, by returning <TRUE/> in cases where it is not sure whether + <p>It's allowed to implement this method sloppy, by returning `TRUE` in cases where it is not sure whether the document actually has been modified. So, the most simple implementation could simply delegate this call to com::sun::star::util::XModifiable::isModified(). (Well, actually that's the - second simple implementation, the <em>most</em> simple one would, still legitimately, always return <TRUE/>.)</p> + second simple implementation, the <em>most</em> simple one would, still legitimately, always return `TRUE`.)</p> <p>However, in such a case, the document might be saved more often than needed. In particular during the periodic session save, this might become a problem when saving is expensive, for a single document diff --git a/offapi/com/sun/star/document/XTypeDetection.idl b/offapi/com/sun/star/document/XTypeDetection.idl index 158fe88a580a..5617fac0e558 100644 --- a/offapi/com/sun/star/document/XTypeDetection.idl +++ b/offapi/com/sun/star/document/XTypeDetection.idl @@ -86,9 +86,9 @@ published interface XTypeDetection: com::sun::star::uno::XInterface means the MediaDescriptor which specify the resource for detection @param AllowDeep - if it is set to <TRUE/> a "deep" detection will be follow a "flat" detection + if it is set to `TRUE` a "deep" detection will be follow a "flat" detection <br> - if it is set to <FALSE/> a "flat" detection will be made only + if it is set to `FALSE` a "flat" detection will be made only @returns an internal type name which represent the detected format diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index cc55e2d3b8c2..bd748f5f6dee 100644 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -164,7 +164,7 @@ interface XUndoManager will immediately be disposed, if applicable.</p> @throws ::com::sun::star::lang::IllegalArgumentException - if the given undo action is <NULL/>. + if the given undo action is `NULL`. */ void addUndoAction( [in] XUndoAction i_action @@ -223,7 +223,7 @@ interface XUndoManager /** determines whether undo() can reasonably be expected to succeed. @return - <FALSE/> if and only if the undo stack is currently empty, or there is an open and not-yet-closed + `FALSE` if and only if the undo stack is currently empty, or there is an open and not-yet-closed undo context. */ boolean isUndoPossible(); @@ -231,7 +231,7 @@ interface XUndoManager /** determines whether redo() can reasonably be expected to succeed. @return - <FALSE/> if and only if the redo stack is currently empty, or there is an open and not-yet-closed + `FALSE` if and only if the redo stack is currently empty, or there is an open and not-yet-closed undo context. */ boolean isRedoPossible(); diff --git a/offapi/com/sun/star/document/XViewDataSupplier.idl b/offapi/com/sun/star/document/XViewDataSupplier.idl index c02bc152be8a..29f92883d535 100644 --- a/offapi/com/sun/star/document/XViewDataSupplier.idl +++ b/offapi/com/sun/star/document/XViewDataSupplier.idl @@ -41,7 +41,7 @@ published interface XViewDataSupplier: com::sun::star::uno::XInterface @returns a com::sun::star::container::XIndexAccess, that gives access to a list of com::sun::star::beans::PropertyValue - for every open view. May <NULL/> if no view is currently available. + for every open view. May `NULL` if no view is currently available. */ ::com::sun::star::container::XIndexAccess getViewData(); @@ -50,7 +50,7 @@ published interface XViewDataSupplier: com::sun::star::uno::XInterface @param Data a list of com::sun::star::beans::PropertyValues with information about last opened views to restore it - <NULL/> isn't allowed here. + `NULL` isn't allowed here. */ void setViewData( [in] com::sun::star::container::XIndexAccess Data ); }; diff --git a/offapi/com/sun/star/drawing/FillProperties.idl b/offapi/com/sun/star/drawing/FillProperties.idl index 55eb98d4230d..97aee03aca1d 100644 --- a/offapi/com/sun/star/drawing/FillProperties.idl +++ b/offapi/com/sun/star/drawing/FillProperties.idl @@ -86,7 +86,7 @@ published service FillProperties */ [optional, property] Hatch FillHatch; - /** if this is <TRUE/>, the transparent background of a + /** if this is `TRUE`, the transparent background of a hatch filled area is drawn in the current background color. */ [property] boolean FillBackground; @@ -136,9 +136,9 @@ published service FillProperties /** specifies if the size is given in percentage or as an absolute value. - <p>If this is <TRUE/>, the properties #FillBitmapSizeX + <p>If this is `TRUE`, the properties #FillBitmapSizeX and #FillBitmapSizeY contain the size of the tile in - percent of the size of the original bitmap. If this is <FALSE/>, the + percent of the size of the original bitmap. If this is `FALSE`, the size of the tile is specified with 1/100th mm. */ [property] boolean FillBitmapLogicalSize; @@ -163,15 +163,15 @@ published service FillProperties FillBitmapStretch</member> and #FillBitmapTile.</p> <p>If set to BitmapMode::REPEAT, the property - FillBitmapStretch is set to <FALSE/>, and the property FillBitmapTile - is set to <TRUE/>.</p> + FillBitmapStretch is set to `FALSE`, and the property FillBitmapTile + is set to `TRUE`.</p> <p>If set to BitmapMode::STRETCH, the property - FillBitmapStretch is set to <TRUE/>, and the property FillBitmapTile - is set to <FALSE/>.</p> + FillBitmapStretch is set to `TRUE`, and the property FillBitmapTile + is set to `FALSE`.</p> <p>If set to BitmapMode::NO_REPEAT, both properties - FillBitmapStretch and FillBitmapTile are set to <FALSE/>.</p> + FillBitmapStretch and FillBitmapTile are set to `FALSE`.</p> */ [property] BitmapMode FillBitmapMode; @@ -181,11 +181,11 @@ published service FillProperties completeness. The #FillBitmapMode property can be used instead to set all supported bitmap modes.</p> - <p>If set to <TRUE/>, the value of the FillBitmapMode property changes + <p>If set to `TRUE`, the value of the FillBitmapMode property changes to BitmapMode::STRETCH. BUT: behavior is undefined, if - the property #FillBitmapTile is <TRUE/> too.</p> + the property #FillBitmapTile is `TRUE` too.</p> - <p>If set to <FALSE/>, the value of the FillBitmapMode property + <p>If set to `FALSE`, the value of the FillBitmapMode property changes to BitmapMode::REPEAT or <const> BitmapMode::NO_REPEAT</const>, depending on the current value of the #FillBitmapTile property.</p> @@ -198,11 +198,11 @@ published service FillProperties completeness. The #FillBitmapMode property can be used instead to set all supported bitmap modes.</p> - <p>If set to <TRUE/>, the value of the FillBitmapMode property changes + <p>If set to `TRUE`, the value of the FillBitmapMode property changes to BitmapMode::REPEAT. BUT: behavior is undefined, if - the property #FillBitmapStretch is <TRUE/> too.</p> + the property #FillBitmapStretch is `TRUE` too.</p> - <p>If set to <FALSE/>, the value of the FillBitmapMode property + <p>If set to `FALSE`, the value of the FillBitmapMode property changes to BitmapMode::STRETCH or <const> BitmapMode::NO_REPEAT</const>, depending on the current value of the #FillBitmapStretch property.</p> diff --git a/offapi/com/sun/star/drawing/GluePoint.idl b/offapi/com/sun/star/drawing/GluePoint.idl index d5931f68ede1..c4d7aa0e6c74 100644 --- a/offapi/com/sun/star/drawing/GluePoint.idl +++ b/offapi/com/sun/star/drawing/GluePoint.idl @@ -47,7 +47,7 @@ published struct GluePoint */ short EscapeDirection; - /** If this is <TRUE/>, then the position of this GluePoint is + /** If this is `TRUE`, then the position of this GluePoint is absolute on a page and is not relative to a shape. */ boolean PositionAbsolute; diff --git a/offapi/com/sun/star/drawing/LineProperties.idl b/offapi/com/sun/star/drawing/LineProperties.idl index 52d13fc18ca5..1697e3abaa48 100644 --- a/offapi/com/sun/star/drawing/LineProperties.idl +++ b/offapi/com/sun/star/drawing/LineProperties.idl @@ -98,7 +98,7 @@ published service LineProperties [optional, property] com::sun::star::drawing::PolyPolygonBezierCoords LineEnd; - /** If this property is <TRUE/>, the line will + /** If this property is `TRUE`, the line will start from the center of the polygon. */ [optional, property] boolean LineStartCenter; @@ -109,7 +109,7 @@ published service LineProperties [optional, property] long LineStartWidth; - /** If this property is <TRUE/>, the line will end + /** If this property is `TRUE`, the line will end in the center of the polygon. */ [optional, property] boolean LineEndCenter; diff --git a/offapi/com/sun/star/drawing/MeasureProperties.idl b/offapi/com/sun/star/drawing/MeasureProperties.idl index 0e9b87f6e4be..13f5a032e237 100644 --- a/offapi/com/sun/star/drawing/MeasureProperties.idl +++ b/offapi/com/sun/star/drawing/MeasureProperties.idl @@ -34,7 +34,7 @@ */ published service MeasureProperties { - /** If this property is <TRUE/>, the measure is drawn below the + /** If this property is `TRUE`, the measure is drawn below the reference edge instead of above it. */ [property] boolean MeasureBelowReferenceEdge; @@ -68,11 +68,11 @@ published service MeasureProperties */ [property] long MeasureOverhang; - /** If this is <TRUE/>, the unit of measure is shown in the measure text. + /** If this is `TRUE`, the unit of measure is shown in the measure text. */ [property] boolean MeasureShowUnit; - /** If this is <TRUE/>, the angle of the measure is set automatically. + /** If this is `TRUE`, the angle of the measure is set automatically. */ [property] boolean MeasureTextAutoAngle; @@ -92,15 +92,15 @@ published service MeasureProperties */ [property] com::sun::star::drawing::MeasureTextVertPos MeasureTextVerticalPosition; - /** If this value is <TRUE/>, the measure has a fixed angle. + /** If this value is `TRUE`, the measure has a fixed angle. */ [property] boolean MeasureTextIsFixedAngle; - /** If this value is <TRUE/>, the text is rotated 90 degrees. + /** If this value is `TRUE`, the text is rotated 90 degrees. */ [property] boolean MeasureTextRotate90; - /** If this value is <TRUE/>, the text is printed upside down. + /** If this value is `TRUE`, the text is printed upside down. */ [property] boolean MeasureTextUpsideDown; diff --git a/offapi/com/sun/star/drawing/OLE2Shape.idl b/offapi/com/sun/star/drawing/OLE2Shape.idl index 96238c6cb0c8..3d3aeee08a89 100644 --- a/offapi/com/sun/star/drawing/OLE2Shape.idl +++ b/offapi/com/sun/star/drawing/OLE2Shape.idl @@ -53,7 +53,7 @@ published service OLE2Shape [readonly, property] com::sun::star::frame::XModel Model; - /** This property returns <TRUE/> for all OLE2 that are internal + /** This property returns `TRUE` for all OLE2 that are internal Office components. */ [readonly, property] boolean IsInternal; diff --git a/offapi/com/sun/star/drawing/ShadowProperties.idl b/offapi/com/sun/star/drawing/ShadowProperties.idl index f0d783966730..e97b484f2f9e 100644 --- a/offapi/com/sun/star/drawing/ShadowProperties.idl +++ b/offapi/com/sun/star/drawing/ShadowProperties.idl @@ -33,7 +33,7 @@ published service ShadowProperties /** enables/disables the shadow of a Shape. <p>The other shadow properties are only applied if this is - set to <TRUE/>.</p> + set to `TRUE`.</p> */ [property] boolean Shadow; diff --git a/offapi/com/sun/star/drawing/Shape.idl b/offapi/com/sun/star/drawing/Shape.idl index 4d45ed58a255..bc1ac37e77c5 100644 --- a/offapi/com/sun/star/drawing/Shape.idl +++ b/offapi/com/sun/star/drawing/Shape.idl @@ -92,20 +92,20 @@ published service Shape [optional, property] string LayerName; - /** If this is <FALSE/>, the Shape is not visible + /** If this is `FALSE`, the Shape is not visible on screen outputs. Please note that the Shape may still be visible when printed, see #Printable. */ [optional, property] boolean Visible; - /** If this is <FALSE/>, the Shape is not visible + /** If this is `FALSE`, the Shape is not visible on printer outputs. */ [optional, property] boolean Printable; - /** With this set to <TRUE/>, this Shape + /** With this set to `TRUE`, this Shape cannot be moved interactively in the user interface. */ [optional, property] boolean MoveProtect; @@ -116,7 +116,7 @@ published service Shape [optional, property] string Name; - /** With this set to <TRUE/>, this Shape may not be + /** With this set to `TRUE`, this Shape may not be sized interactively in the user interface. */ [optional, property] boolean SizeProtect; diff --git a/offapi/com/sun/star/drawing/TextProperties.idl b/offapi/com/sun/star/drawing/TextProperties.idl index b5e1cb31987d..bd0ff90819ed 100644 --- a/offapi/com/sun/star/drawing/TextProperties.idl +++ b/offapi/com/sun/star/drawing/TextProperties.idl @@ -86,7 +86,7 @@ published service TextProperties */ [optional] service com::sun::star::style::ParagraphPropertiesComplex; - /** If this is <TRUE/>, numbering is ON for the text of + /** If this is `TRUE`, numbering is ON for the text of this Shape. */ [optional, property] boolean IsNumbering; @@ -101,26 +101,26 @@ published service TextProperties [optional, property] com::sun::star::container::XIndexReplace NumberingRules; - /** If this value is <TRUE/>, the height of the Shape is + /** If this value is `TRUE`, the height of the Shape is automatically expanded/shrunk when text is added to or removed from the Shape. */ [property] boolean TextAutoGrowHeight; - /** If this value is <TRUE/>, the width of the Shape is + /** If this value is `TRUE`, the width of the Shape is automatically expanded/shrunk when text is added to or removed from the Shape. */ [property] boolean TextAutoGrowWidth; - /** If this value is <TRUE/>, the left edge of every line of text is + /** If this value is `TRUE`, the left edge of every line of text is aligned with the left edge of this Shape. */ [property] boolean TextContourFrame; - /** With this set to <TRUE/>, the text inside of the Shape + /** With this set to `TRUE`, the text inside of the Shape is stretched to fit into the Shape. */ [property] com::sun::star::drawing::TextFitToSizeType TextFitToSize; @@ -142,7 +142,7 @@ published service TextProperties to the left edge of the text. <p>This is only useful if Text::TextHorizontalAdjust is BLOCK or STRETCH or if - Text::TextFitSize is <TRUE/>.</p> + Text::TextFitSize is `TRUE`.</p> */ [property] long TextLeftDistance; @@ -152,7 +152,7 @@ published service TextProperties <p>This is only useful if Text::TextHorizontalAdjust is BLOCK or STRETCH - or if Text::TextFitSize is <TRUE/>.</p> + or if Text::TextFitSize is `TRUE`.</p> */ [property] long TextRightDistance; @@ -162,7 +162,7 @@ published service TextProperties <p>This is only useful if Text::TextVerticalAdjust is BLOCK or if Text::TextFitSize is - <TRUE/>.</p> + `TRUE`.</p> */ [property] long TextUpperDistance; @@ -174,7 +174,7 @@ published service TextProperties <p>This is only useful if Text::TextVerticalAdjust is BLOCK or if Text::TextFitSize is - <TRUE/>.</p> + `TRUE`.</p> */ [property] long TextLowerDistance; @@ -234,13 +234,13 @@ published service TextProperties [property] com::sun::star::drawing::TextAnimationKind TextAnimationKind; - /** If this value is <TRUE/>, the text is visible at the start of the + /** If this value is `TRUE`, the text is visible at the start of the animation. */ [property] boolean TextAnimationStartInside; - /** If this value is <TRUE/>, the text is visible at the end of the + /** If this value is `TRUE`, the text is visible at the end of the animation. */ [property] boolean TextAnimationStopInside; diff --git a/offapi/com/sun/star/drawing/XPresenterHelper.idl b/offapi/com/sun/star/drawing/XPresenterHelper.idl index 12f1bc25457b..eca5f12b170d 100644 --- a/offapi/com/sun/star/drawing/XPresenterHelper.idl +++ b/offapi/com/sun/star/drawing/XPresenterHelper.idl @@ -42,18 +42,18 @@ interface XPresenterHelper @param xParentWindow The parent window of the new window. @param bCreateSystemChildWindow - When <TRUE/> then the new window will be a system window that, + When `TRUE` then the new window will be a system window that, in the context of the presenter screen, can not be painted over by other windows that lie behind it. @param bInitiallyVisible - When <TRUE/> the new window will be visible from the start, + When `TRUE` the new window will be visible from the start, i.e. a window listener will not receive a windowShown signal. @param bEnableChildTransparentMode - When <TRUE/> the parent window is painted behind its child + When `TRUE` the parent window is painted behind its child windows. This is one half of allowing child windows to be transparent. @param bEnableParentClip - When <TRUE/> then the parent window is not clipped where its + When `TRUE` then the parent window is not clipped where its child windows are painted. This is the other half of allowing child windows to be transparent. */ @@ -68,17 +68,17 @@ interface XPresenterHelper wrapper around the given shared canvas. The wrapper only modifies the origin in all output and clipping methods. @param xUpdateCanvas - This canvas is used to call updateScreen() on. May be <NULL/> + This canvas is used to call updateScreen() on. May be `NULL` @param xUpdateWindow The window that belongs to the update canvas. May also be - <NULL/> (is expected to b <NULL/> whenever xUpdateCanvas is.) + `NULL` (is expected to b `NULL` whenever xUpdateCanvas is.) @param xSharedCanvas The canvas that is shared by the wrapper. @param xSharedWindow The window of the shared canvas. This is used to determine the proper offset. @param xWindow - The canvas is created for this window. Must not be <NULL/> + The canvas is created for this window. Must not be `NULL` */ ::com::sun::star::rendering::XCanvas createSharedCanvas ( [in] ::com::sun::star::rendering::XSpriteCanvas xUpdateCanvas, @@ -89,7 +89,7 @@ interface XPresenterHelper /** Create a new canvas for the given window. @param xWindow - The canvas is created for this window. Must not be <NULL/> + The canvas is created for this window. Must not be `NULL` @param nRequestedCanvasFeatureList List of requested features that the new canvas should (has to) provide. Use only values from the CanvasFeature diff --git a/offapi/com/sun/star/drawing/XSlideSorterBase.idl b/offapi/com/sun/star/drawing/XSlideSorterBase.idl index 08efe55f1047..a67d31012442 100644 --- a/offapi/com/sun/star/drawing/XSlideSorterBase.idl +++ b/offapi/com/sun/star/drawing/XSlideSorterBase.idl @@ -53,44 +53,44 @@ interface XSlideSorterBase */ [attribute] ::com::sun::star::container::XIndexAccess DocumentSlides; - /** Set this flag to <TRUE/> in order to have the current slide + /** Set this flag to `TRUE` in order to have the current slide highlighted. - <p>The default value is <FALSE/>.</p> + <p>The default value is `FALSE`.</p> */ [attribute] boolean IsHighlightCurrentSlide; - /** Set this flag to <TRUE/> in order to visualize the selection of + /** Set this flag to `TRUE` in order to visualize the selection of slides (typically a bold frame around the selected slides). - <p>The default value is <TRUE/>.</p> + <p>The default value is `TRUE`.</p> */ [attribute] boolean IsShowSelection; - /** Set this flag to <TRUE/> to visualize to where the focus is by + /** Set this flag to `TRUE` to visualize to where the focus is by showing a dotted rectangle around the focused slide. - <p>The default value is <TRUE/>.</p> + <p>The default value is `TRUE`.</p> */ [attribute] boolean IsShowFocus; - /** When this flag has the value <TRUE/> then every time the current + /** When this flag has the value `TRUE` then every time the current slide is changed the visual area is shifted so that the new current slide is display in the center of the slide sorter window. <p>It is not always possible to move the current slide into the exact center of the window, for example when slides are located near the start or end of a document.</p> - <p>The default value is <FALSE/>. + <p>The default value is `FALSE`. */ [attribute] boolean IsCenterSelection; /** This flag controls whether updates of previews are created during - full screen presentations (<FALSE/>) or not (<TRUE/>). The + full screen presentations (`FALSE`) or not (`TRUE`). The suspension of preview creations is an optimization for not slowing down a running presentation. - <p>The default value is <TRUE/>.</p> + <p>The default value is `TRUE`.</p> */ [attribute] boolean IsSuspendPreviewUpdatesDuringFullScreenPresentation; - /** The orientation of a slide sorter can be either vertical (<TRUE/>) - or horizontal (<FALSE/>). + /** The orientation of a slide sorter can be either vertical (`TRUE`) + or horizontal (`FALSE`). */ [attribute] boolean IsOrientationVertical; @@ -105,7 +105,7 @@ interface XSlideSorterBase /** This flag controls whether the model can be modified by using keyboard or mouse. - <p>The default value is <TRUE/>.</p> + <p>The default value is `TRUE`.</p> */ [attribute] boolean IsUIReadOnly; }; diff --git a/offapi/com/sun/star/drawing/framework/XConfiguration.idl b/offapi/com/sun/star/drawing/framework/XConfiguration.idl index b45c03449053..3217d59ecf03 100644 --- a/offapi/com/sun/star/drawing/framework/XConfiguration.idl +++ b/offapi/com/sun/star/drawing/framework/XConfiguration.idl @@ -82,11 +82,11 @@ interface XConfiguration active, i.e. has a visible representation in the GUI. @param xResourceId The id of a resource. May be empty (empty reference or empty - XResourceId object) in which case <FALSE/> is + XResourceId object) in which case `FALSE` is returned. @return - Returns <TRUE/> when the resource is part of the configuration - and <FALSE/> when it is not. + Returns `TRUE` when the resource is part of the configuration + and `FALSE` when it is not. */ boolean hasResource ([in] XResourceId xResourceId); diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl b/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl index 2ed471ab4f65..1c30602fe80f 100644 --- a/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl +++ b/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl @@ -38,8 +38,8 @@ interface XConfigurationControllerRequestQueue { /** Return whether there are pending requests for configuration changes. @return - Returns <TRUE/> when there is at least one request object in the - queue that has not yet been processed. It returns <FALSE/> when + Returns `TRUE` when there is at least one request object in the + queue that has not yet been processed. It returns `FALSE` when the queue is empty. */ boolean hasPendingRequests (); diff --git a/offapi/com/sun/star/drawing/framework/XRelocatableResource.idl b/offapi/com/sun/star/drawing/framework/XRelocatableResource.idl index e79ce40163b2..4d426fe11dc1 100644 --- a/offapi/com/sun/star/drawing/framework/XRelocatableResource.idl +++ b/offapi/com/sun/star/drawing/framework/XRelocatableResource.idl @@ -36,7 +36,7 @@ interface XRelocatableResource @param xNewAnchor The new anchor. @return - Returns <TRUE/> when the relocation was successful. + Returns `TRUE` when the relocation was successful. */ boolean relocateToAnchor ([in] XResource xNewAnchor); }; diff --git a/offapi/com/sun/star/drawing/framework/XResource.idl b/offapi/com/sun/star/drawing/framework/XResource.idl index 0620bc49c5f1..c2056e526baa 100644 --- a/offapi/com/sun/star/drawing/framework/XResource.idl +++ b/offapi/com/sun/star/drawing/framework/XResource.idl @@ -39,7 +39,7 @@ interface XResource /** Some resources must not be leafs, i.e. have to be anchor to at least one other resource. Most panes are examples for this. Views on the other hand are in most cases no anchors. So the typical pane will - return <TRUE/> and the typical view will return <FALSE/>. + return `TRUE` and the typical view will return `FALSE`. The return value is used to determine whether a resource has to be deactivated when it has no children, either because none is diff --git a/offapi/com/sun/star/drawing/framework/XResourceId.idl b/offapi/com/sun/star/drawing/framework/XResourceId.idl index 2655ab924255..3e0c3c8172ce 100644 --- a/offapi/com/sun/star/drawing/framework/XResourceId.idl +++ b/offapi/com/sun/star/drawing/framework/XResourceId.idl @@ -53,7 +53,7 @@ interface XResourceId com::sun::star::util::URL getFullResourceURL (); /** Return whether there is a non-empty anchor URL. When this method - returns <FALSE/> then getAnchorURLs() will return an empty list. + returns `FALSE` then getAnchorURLs() will return an empty list. */ boolean hasAnchor (); @@ -105,7 +105,7 @@ interface XResourceId The resource id of the anchor. @param eMode This mode specifies how the called resource has to be bound to - the given anchor in order to have this function return <TRUE/>. + the given anchor in order to have this function return `TRUE`. <p>If eMode is DIRECT then the anchor of the called resource id has to be identical to the given anchor. If eMode is INDIRECT then the given anchor has to be a part diff --git a/offapi/com/sun/star/drawing/framework/XTabBar.idl b/offapi/com/sun/star/drawing/framework/XTabBar.idl index e3b54bfbb302..97778edf2410 100644 --- a/offapi/com/sun/star/drawing/framework/XTabBar.idl +++ b/offapi/com/sun/star/drawing/framework/XTabBar.idl @@ -74,7 +74,7 @@ interface XTabBar @param aButton The tab bar button whose existence is tested. @return - Returns <TRUE/> when the button exists. + Returns `TRUE` when the button exists. */ boolean hasTabBarButton ([in] TabBarButton aButton); diff --git a/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl b/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl index ff046d1fa249..889477019ce3 100644 --- a/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl +++ b/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl @@ -66,7 +66,7 @@ published service EmbeddedObjectDescriptor <p>Upon activating the embedded object, it is normally loaded from a storage as denoted by the parameters to the XEmbedObjectCreator method calls.</p> - <p>You can pass a non-<NULL/> <code>RecoveryStorage</code> in the object descriptor if you wish to load the + <p>You can pass a non-`NULL` <code>RecoveryStorage</code> in the object descriptor if you wish to load the embedded object from an alternate storage.</p> <p>The object will still be based on the storage denoted in the <code>XEmbedObjectCreator</code> method diff --git a/offapi/com/sun/star/embed/Storage.idl b/offapi/com/sun/star/embed/Storage.idl index 45315b027dd7..16855afa4599 100644 --- a/offapi/com/sun/star/embed/Storage.idl +++ b/offapi/com/sun/star/embed/Storage.idl @@ -294,7 +294,7 @@ published service Storage /** allows to detect if the storage contains encrypted entries. <p> - In case it is set to <TRUE/> the storage itself and/or a tree of + In case it is set to `TRUE` the storage itself and/or a tree of substorages contain encrypted streams. Usually in case this property is supported the implementation supports XEncryptionProtectedSource interface. @@ -305,7 +305,7 @@ published service Storage /** allows to detect if the storage contains non-encrypted entries. <p> - In case it is set to <TRUE/> the storage itself and/or a tree of + In case it is set to `TRUE` the storage itself and/or a tree of substorages contains non-encrypted streams. Usually in case this property is supported the implementation supports XEncryptionProtectedSource interface. diff --git a/offapi/com/sun/star/embed/StorageStream.idl b/offapi/com/sun/star/embed/StorageStream.idl index 977a72c1f840..9a2e0147d903 100644 --- a/offapi/com/sun/star/embed/StorageStream.idl +++ b/offapi/com/sun/star/embed/StorageStream.idl @@ -142,15 +142,15 @@ published service StorageStream /** allows to detect if the stream is encrypted. <p> - The property value <TRUE/> means that the stream is currently encrypted. - <FALSE/> - the stream is not encrypted. + The property value `TRUE` means that the stream is currently encrypted. + `FALSE` - the stream is not encrypted. </p> <p> If somebody sets a password explicitly by using XEncryptionProtectedSource interface the value is - automatically set to <TRUE/>. If the interface is used to remove - the encryption - the value is automatically set to <FALSE/>. + automatically set to `TRUE`. If the interface is used to remove + the encryption - the value is automatically set to `FALSE`. </p> */ @@ -160,14 +160,14 @@ published service StorageStream common storage password holder is commited. <p> - The property value <TRUE/> means that the stream will become encrypted + The property value `TRUE` means that the stream will become encrypted after the closest storage in the parent hierarchy, that has common storage password, is commited. - <FALSE/> - the stream will not react to commit of such a storage. + `FALSE` - the stream will not react to commit of such a storage. </p> <p> - In case stream is not encrypted and the property is set to <TRUE/>, + In case stream is not encrypted and the property is set to `TRUE`, the stream will stay non-encrypted until the closest storage in the parent hierarchy, that has common storage password, is commited. On the commit the stream will be encrypted with the common storage @@ -179,12 +179,12 @@ published service StorageStream <p> If somebody sets a password explicitly by using XEncryptionProtectedSource interface the value is - automatically set to <FALSE/> and the stream becomes encrypted + automatically set to `FALSE` and the stream becomes encrypted with specified password immediately. </p> <p> - In case stream is encrypted one and the value is set to <TRUE/> + In case stream is encrypted one and the value is set to `TRUE` the stream becomes non-encrypted until the common storage password holder is commited. The data about previously set password ( if any ) will be removed and the stream can be accessed as non-encrypted stream. diff --git a/offapi/com/sun/star/embed/XActionsApproval.idl b/offapi/com/sun/star/embed/XActionsApproval.idl index 12f9fbdea791..8da5b738fa50 100644 --- a/offapi/com/sun/star/embed/XActionsApproval.idl +++ b/offapi/com/sun/star/embed/XActionsApproval.idl @@ -44,7 +44,7 @@ published interface XActionsApproval: com::sun::star::uno::XInterface InstanceLocker does. @return - returns <TRUE/> in case the specified action is approved. + returns `TRUE` in case the specified action is approved. */ boolean approveAction( [in] long nAction ); }; diff --git a/offapi/com/sun/star/embed/XCommonEmbedPersist.idl b/offapi/com/sun/star/embed/XCommonEmbedPersist.idl index 52c97aa95239..adeb17f5daea 100644 --- a/offapi/com/sun/star/embed/XCommonEmbedPersist.idl +++ b/offapi/com/sun/star/embed/XCommonEmbedPersist.idl @@ -53,8 +53,8 @@ published interface XCommonEmbedPersist: com::sun::star::uno::XInterface /** allows to detect if the data store is read-only. @returns - <TRUE/> if the data store is readonly or opened readonly - <FALSE/> otherwise + `TRUE` if the data store is readonly or opened readonly + `FALSE` otherwise @throws com::sun::star::embed::WrongStateException the object is in wrong state ( has no entry ) diff --git a/offapi/com/sun/star/embed/XEmbedPersist.idl b/offapi/com/sun/star/embed/XEmbedPersist.idl index 0aa8fe84fb76..2bd94dd3d5bc 100644 --- a/offapi/com/sun/star/embed/XEmbedPersist.idl +++ b/offapi/com/sun/star/embed/XEmbedPersist.idl @@ -196,8 +196,8 @@ published interface XEmbedPersist: XCommonEmbedPersist after "save as" operation. @param bUseNew - <TRUE/> the new storage should be used - <FALSE/> the old one + `TRUE` the new storage should be used + `FALSE` the old one @throws com::sun::star::embed::WrongStateException the object is in wrong state @@ -213,8 +213,8 @@ published interface XEmbedPersist: XCommonEmbedPersist /** allows to detect if the object has entry. @returns - <TRUE/> if the object has own entry set - <FALSE/> otherwise + `TRUE` if the object has own entry set + `FALSE` otherwise */ boolean hasEntry() raises( ::com::sun::star::embed::WrongStateException ); diff --git a/offapi/com/sun/star/embed/XInplaceClient.idl b/offapi/com/sun/star/embed/XInplaceClient.idl index 795ba4afcca5..c0f92682b423 100644 --- a/offapi/com/sun/star/embed/XInplaceClient.idl +++ b/offapi/com/sun/star/embed/XInplaceClient.idl @@ -40,8 +40,8 @@ interface XInplaceClient: com::sun::star::uno::XInterface /** checks if the container can activate the object inplace. @return - <TRUE/> the container can activate the object inplace. - <FALSE/> otherwise. + `TRUE` the container can activate the object inplace. + `FALSE` otherwise. */ boolean canInplaceActivate(); diff --git a/offapi/com/sun/star/embed/XInplaceObject.idl b/offapi/com/sun/star/embed/XInplaceObject.idl index b54419e52b17..187605685c17 100644 --- a/offapi/com/sun/star/embed/XInplaceObject.idl +++ b/offapi/com/sun/star/embed/XInplaceObject.idl @@ -73,8 +73,8 @@ published interface XInplaceObject: com::sun::star::uno::XInterface </p> @param bEnable - <TRUE/> to enable object modeless - <FALSE/> to disable it + `TRUE` to enable object modeless + `FALSE` to disable it @throws com::sun::star::embed::WrongStateException the object is in wrong state diff --git a/offapi/com/sun/star/embed/XLinkageSupport.idl b/offapi/com/sun/star/embed/XLinkageSupport.idl index b606a7e52e3b..bbeac72ea96b 100644 --- a/offapi/com/sun/star/embed/XLinkageSupport.idl +++ b/offapi/com/sun/star/embed/XLinkageSupport.idl @@ -92,8 +92,8 @@ published interface XLinkageSupport: XCommonEmbedPersist </p> @return - <TRUE/> - the object is a linked one. - <FALSE/> - otherwise + `TRUE` - the object is a linked one. + `FALSE` - otherwise @throws com::sun::star::embed::WrongStateException the object is in wrong state diff --git a/offapi/com/sun/star/embed/XStorage.idl b/offapi/com/sun/star/embed/XStorage.idl index aef09778e85c..22bf6a7a39b8 100644 --- a/offapi/com/sun/star/embed/XStorage.idl +++ b/offapi/com/sun/star/embed/XStorage.idl @@ -385,8 +385,8 @@ published interface XStorage the name of the element to check @returns - <TRUE/> in case the element is a stream - <FALSE/> - the element is a storage + `TRUE` in case the element is a stream + `FALSE` - the element is a storage @throws ::com::sun::star::container::NoSuchElementException there is no element with such name @@ -415,8 +415,8 @@ published interface XStorage the name of the element to check @returns - <TRUE/> in case the element is a storage - <FALSE/> - the element is a stream + `TRUE` in case the element is a storage + `FALSE` - the element is a stream @throws ::com::sun::star::container::NoSuchElementException there is no element with such name diff --git a/offapi/com/sun/star/form/DataAwareControlModel.idl b/offapi/com/sun/star/form/DataAwareControlModel.idl index d859ea84f12c..a268f572f590 100644 --- a/offapi/com/sun/star/form/DataAwareControlModel.idl +++ b/offapi/com/sun/star/form/DataAwareControlModel.idl @@ -107,9 +107,9 @@ published service DataAwareControlModel /** determines whether or not input into this field is required, when it is actually bound to a database field. - <p>If this property is set to <FALSE/>, then the form runtime will not check the control/model for - <NULL/> values before submitting data to the database. Usually, if a control model is bound to - a database field which cannot be <NULL/>, and the model itself does not have a value, then the database + <p>If this property is set to `FALSE`, then the form runtime will not check the control/model for + `NULL` values before submitting data to the database. Usually, if a control model is bound to + a database field which cannot be `NULL`, and the model itself does not have a value, then the database update is prevented, showing an error message to the user. To disable this behavior on a per-control basis, use the <code>InputRequired</code> property.</p> diff --git a/offapi/com/sun/star/form/XApproveActionListener.idl b/offapi/com/sun/star/form/XApproveActionListener.idl index 5578d5feba34..4814f58ddb04 100644 --- a/offapi/com/sun/star/form/XApproveActionListener.idl +++ b/offapi/com/sun/star/form/XApproveActionListener.idl @@ -46,7 +46,7 @@ published interface XApproveActionListener: com::sun::star::lang::XEventListener A descriptor specifying the source of the event. @returns - <TRUE/> when the action is permitted, otherwise <FALSE/>. + `TRUE` when the action is permitted, otherwise `FALSE`. */ boolean approveAction( [in] com::sun::star::lang::EventObject aEvent ); diff --git a/offapi/com/sun/star/form/XBoundComponent.idl b/offapi/com/sun/star/form/XBoundComponent.idl index c1bc3249af5d..9789ede3a934 100644 --- a/offapi/com/sun/star/form/XBoundComponent.idl +++ b/offapi/com/sun/star/form/XBoundComponent.idl @@ -46,7 +46,7 @@ published interface XBoundComponent: com::sun::star::form::XUpdateBroadcaster /** commits the content of the component into the data source it is bound to. @returns - <TRUE/> when the commitment was successful, otherwise <FALSE/>. + `TRUE` when the commitment was successful, otherwise `FALSE`. */ boolean commit(); diff --git a/offapi/com/sun/star/form/XBoundControl.idl b/offapi/com/sun/star/form/XBoundControl.idl index 001854073836..e92a82cb334a 100644 --- a/offapi/com/sun/star/form/XBoundControl.idl +++ b/offapi/com/sun/star/form/XBoundControl.idl @@ -35,7 +35,7 @@ published interface XBoundControl: com::sun::star::uno::XInterface /** determines whether the input is currently locked or not. @returns - <TRUE/> when it is currently locked, otherwise <FALSE/>. + `TRUE` when it is currently locked, otherwise `FALSE`. */ boolean getLock(); diff --git a/offapi/com/sun/star/form/XConfirmDeleteListener.idl b/offapi/com/sun/star/form/XConfirmDeleteListener.idl index f7e0ce2f632a..c5364bdffb89 100644 --- a/offapi/com/sun/star/form/XConfirmDeleteListener.idl +++ b/offapi/com/sun/star/form/XConfirmDeleteListener.idl @@ -41,7 +41,7 @@ published interface XConfirmDeleteListener: com::sun::star::lang::XEventListener A descriptor specifying the deletion request. @returns - <TRUE/> when the row can be deleted, otherwise <FALSE/>. + `TRUE` when the row can be deleted, otherwise `FALSE`. */ boolean confirmDelete( [in] com::sun::star::sdb::RowChangeEvent aEvent ); }; diff --git a/offapi/com/sun/star/form/XDatabaseParameterListener.idl b/offapi/com/sun/star/form/XDatabaseParameterListener.idl index fa484c530b99..c536f6d0e960 100644 --- a/offapi/com/sun/star/form/XDatabaseParameterListener.idl +++ b/offapi/com/sun/star/form/XDatabaseParameterListener.idl @@ -39,7 +39,7 @@ published interface XDatabaseParameterListener: com::sun::star::lang::XEventList the event describing the parameter value request. @returns - <TRUE/> when the execution of the parametrized statement should continue, <FALSE/> otherwise. + `TRUE` when the execution of the parametrized statement should continue, `FALSE` otherwise. @see com::sun::star::form::DatabaseParameterEvent */ diff --git a/offapi/com/sun/star/form/XFormsSupplier2.idl b/offapi/com/sun/star/form/XFormsSupplier2.idl index b3e5a072150b..8befb52a2333 100644 --- a/offapi/com/sun/star/form/XFormsSupplier2.idl +++ b/offapi/com/sun/star/form/XFormsSupplier2.idl @@ -34,7 +34,7 @@ interface XFormsSupplier2: XFormsSupplier <p>If you need read access to the forms collection, then you might check the existence of forms using hasForms(), and if it returns - <FALSE/>, you can do as if XFormsSupplier::getForms() would + `FALSE`, you can do as if XFormsSupplier::getForms() would have returned an empty container.</p> <p>Semantically, hasForms() is equivalent to calling diff --git a/offapi/com/sun/star/form/XGridFieldDataSupplier.idl b/offapi/com/sun/star/form/XGridFieldDataSupplier.idl index fa95fd11999e..7a26b1a1308f 100644 --- a/offapi/com/sun/star/form/XGridFieldDataSupplier.idl +++ b/offapi/com/sun/star/form/XGridFieldDataSupplier.idl @@ -51,8 +51,8 @@ published interface XGridFieldDataSupplier: com::sun::star::uno::XInterface To check if the type you need is supported by the columns, use this method.</p> @return - A sequence of boolean flags. Each flag corresponds to the respective column, and <TRUE/> indicates - that the column content can be retrieved in the requested format, <FALSE/> denies this. + A sequence of boolean flags. Each flag corresponds to the respective column, and `TRUE` indicates + that the column content can be retrieved in the requested format, `FALSE` denies this. @see XGridColumnFactory @see DataAwareControlModel @@ -62,7 +62,7 @@ published interface XGridFieldDataSupplier: com::sun::star::uno::XInterface /** retrieves the actual column data for the given row - <p>If a column does not support the requested type, <NULL/> is returned at the respective + <p>If a column does not support the requested type, `NULL` is returned at the respective position.</p> @see XGridFieldDataSupplier::queryFieldDataType diff --git a/offapi/com/sun/star/form/XResetListener.idl b/offapi/com/sun/star/form/XResetListener.idl index 3bf1b0f1b5f1..62f666b27e30 100644 --- a/offapi/com/sun/star/form/XResetListener.idl +++ b/offapi/com/sun/star/form/XResetListener.idl @@ -51,7 +51,7 @@ published interface XResetListener: com::sun::star::lang::XEventListener the event happened. @returns - <TRUE/> when reset was approved, <FALSE/> when the reset operation should be canceled. + `TRUE` when reset was approved, `FALSE` when the reset operation should be canceled. */ boolean approveReset( [in] com::sun::star::lang::EventObject rEvent ); diff --git a/offapi/com/sun/star/form/XSubmitListener.idl b/offapi/com/sun/star/form/XSubmitListener.idl index 87f6cb3df180..40dae6c764d9 100644 --- a/offapi/com/sun/star/form/XSubmitListener.idl +++ b/offapi/com/sun/star/form/XSubmitListener.idl @@ -48,7 +48,7 @@ published interface XSubmitListener: com::sun::star::lang::XEventListener the event happened @returns - <TRUE/> when submitting was approved, otherwise <FALSE/>. + `TRUE` when submitting was approved, otherwise `FALSE`. */ boolean approveSubmit( [in] com::sun::star::lang::EventObject rEvent ); diff --git a/offapi/com/sun/star/form/XUpdateListener.idl b/offapi/com/sun/star/form/XUpdateListener.idl index 24731f6ff2a7..8d8111b0a6a3 100644 --- a/offapi/com/sun/star/form/XUpdateListener.idl +++ b/offapi/com/sun/star/form/XUpdateListener.idl @@ -46,7 +46,7 @@ published interface XUpdateListener: com::sun::star::lang::XEventListener An event descriptor specifying the broadcaster of the change. @returns - <TRUE/> when the update was approved, otherwise <FALSE/>. + `TRUE` when the update was approved, otherwise `FALSE`. */ boolean approveUpdate( [in] com::sun::star::lang::EventObject aEvent ); diff --git a/offapi/com/sun/star/form/binding/BindableControlModel.idl b/offapi/com/sun/star/form/binding/BindableControlModel.idl index 3aa58c75422f..0822e8c7a709 100644 --- a/offapi/com/sun/star/form/binding/BindableControlModel.idl +++ b/offapi/com/sun/star/form/binding/BindableControlModel.idl @@ -62,8 +62,8 @@ service BindableControlModel <p>In both cases, explicit changes of the model's property are ignored if they would relax the restriction imposed by the binding.<br/> For instance, if the binding declares it's value to - be read-only (indicated by ValueBinding::ReadOnly being <TRUE/>), then - any attempt to set the <code>ReadOnly</code> property of the control model to <FALSE/> will + be read-only (indicated by ValueBinding::ReadOnly being `TRUE`), then + any attempt to set the <code>ReadOnly</code> property of the control model to `FALSE` will fail. However, if the binding's value is not read-only, then the <code>ReadOnly</code> property at the control model can be freely set.<br/> The very same holds for the binding's ValueBinding::Relevant and the control diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseCheckBox.idl b/offapi/com/sun/star/form/binding/BindableDatabaseCheckBox.idl index b11e438bb128..8ee368b8edd7 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseCheckBox.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseCheckBox.idl @@ -33,11 +33,11 @@ module com { module sun { module star { module form { module binding { <p>The com::sun::star::form::binding::XValueBinding instance which can be associated with a BindableDatabaseCheckBox must support exchanging boolean values. The following mapping between external values and control states apply: - <ul><li><TRUE/> will be mapped to the box being checked, and vice versa</li> - <li><FALSE/> will be mapped to it being unchecked, and vice versa</li> - <li><NULL/> will be mapped to it being in undetermined state, if the box currently supports + <ul><li>`TRUE` will be mapped to the box being checked, and vice versa</li> + <li>`FALSE` will be mapped to it being unchecked, and vice versa</li> + <li>`NULL` will be mapped to it being in undetermined state, if the box currently supports this, or being unchecked else. The undetermined of the check box will always be - mapped to <NULL/> when writing the external value.</li> + mapped to `NULL` when writing the external value.</li> </ul></p> <p>If the value binding associated with a BindableDatabaseCheckBox @@ -45,7 +45,7 @@ module com { module sun { module star { module form { module binding { is <em>not</em> empty, then the radio button will exchange it's value as string: <ul><li>A string equal to the reference value will be mapped to the button being checked, and vice versa</li> <li>A string not equal to the reference value will be mapped to the button being unchecked, and vice versa</li> - <li><NULL/> will be mapped to it being in undetermined state</li> + <li>`NULL` will be mapped to it being in undetermined state</li> </ul></p> @see com::sun::star::form::binding::XValueBinding::supportsType diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseListBox.idl b/offapi/com/sun/star/form/binding/BindableDatabaseListBox.idl index b667d01e7468..d181d359cd66 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseListBox.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseListBox.idl @@ -43,18 +43,18 @@ module com { module sun { module star { module form { module binding { The value will represent the value of the selected entry (taken from ValueList or read from BoundColumn). If more than one entry is selected, - <NULL/> will be transfered. + `NULL` will be transfered. In other words, the SelectedValue property.</li> <li><em>sequences of long integers</em>: When used, the integers in the sequence will represent the indexes of the selected entries of the list box.</li> <li><em>long integer value</em>: When used, the value will represent the index of the selected entry. - If no entry is selected, -1 will be transfered. If more than one entry is selected, <NULL/> + If no entry is selected, -1 will be transfered. If more than one entry is selected, `NULL` will be transfered.</li> <li><em>sequences of strings</em>: When used, the strings in the sequence present the texts of the selected entries of the list box.</li> <li><em>string values</em>: When used. the value will represent the text of the selected entry. If no entry is selected, an empty string will be transfered. If more than one entry is selected, - <NULL/> will be transfered.</li> + `NULL` will be transfered.</li> </ol></p> @see com::sun::star::form::binding::XValueBinding::supportsType diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl b/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl index 2fab1999040c..daa73cbdad5a 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl @@ -33,9 +33,9 @@ module com { module sun { module star { module form { module binding { <p>The com::sun::star::form::binding::XValueBinding instance which can be associated with a BindableDatabaseRadioButton must support exchanging boolean values. The following mapping between external values and control states apply: - <ul><li><TRUE/> will be mapped to the button being checked, and vice versa</li> - <li><FALSE/> will be mapped to it being unchecked, and vice versa</li> - <li><NULL/> will be mapped to it being in undetermined state</li> + <ul><li>`TRUE` will be mapped to the button being checked, and vice versa</li> + <li>`FALSE` will be mapped to it being unchecked, and vice versa</li> + <li>`NULL` will be mapped to it being in undetermined state</li> </ul></p> <p>If the value binding associated with a BindableDatabaseRadioButton @@ -43,7 +43,7 @@ module com { module sun { module star { module form { module binding { is <em>not</em> empty, then the radio button will exchange it's value as string: <ul><li>A string equal to the reference value will be mapped to the button being checked, and vice versa</li> <li>A string not equal to the reference value will be mapped to the button being unchecked, and vice versa</li> - <li><NULL/> will be mapped to it being in undetermined state</li> + <li>`NULL` will be mapped to it being in undetermined state</li> </ul></p> @see com::sun::star::form::binding::XValueBinding::supportsType diff --git a/offapi/com/sun/star/form/binding/BindableIntegerValueRange.idl b/offapi/com/sun/star/form/binding/BindableIntegerValueRange.idl index dc00f06c0eb5..8a330b432e40 100644 --- a/offapi/com/sun/star/form/binding/BindableIntegerValueRange.idl +++ b/offapi/com/sun/star/form/binding/BindableIntegerValueRange.idl @@ -44,7 +44,7 @@ service BindableIntegerValueRange <p>When the external (double) value changes, it's converted as follows to an integer value: - <ul><li>If the external value is <NULL/>, the current value of the control model + <ul><li>If the external value is `NULL`, the current value of the control model will be set to it's minimum.</li> <li>If the external value is the <em>infinite</em> value, the control value will be set to its maximum or minimum, depending on the sign of the external value.</li> diff --git a/offapi/com/sun/star/form/binding/ValueBinding.idl b/offapi/com/sun/star/form/binding/ValueBinding.idl index eb1f1371fca8..56d294d716cb 100644 --- a/offapi/com/sun/star/form/binding/ValueBinding.idl +++ b/offapi/com/sun/star/form/binding/ValueBinding.idl @@ -42,7 +42,7 @@ service ValueBinding represents a cell in a spreadsheet document, and whose value is readonly as long as the spreadsheet is locked.</p> - <p>As long as this property is <TRUE/>, the value binding should throw + <p>As long as this property is `TRUE`, the value binding should throw a InvalidBindingStateException when its XValueBinding::setValue() method is invoked.</p> */ @@ -53,14 +53,14 @@ service ValueBinding <p>In a more complex scenario, where different form controls are bound to different values, which all are part of a larger data structure, some of the items in this data structure may not be relevant currently. This is indicated by the - #Relevant property being <FALSE/>.</p> + #Relevant property being `FALSE`.</p> <p>XBindableValues which are bound to this binding may or may not react in certain ways on the (ir)relevance of their bound value.</p> <p>One possible reaction could be that user interface elements which are associated with the XBindableValue are disabled as long as #Relevant - is <FALSE/>.</p> + is `FALSE`.</p> */ [optional, property, bound, readonly] boolean Relevant; diff --git a/offapi/com/sun/star/form/binding/XBindableValue.idl b/offapi/com/sun/star/form/binding/XBindableValue.idl index 708084a61aff..0659bdacebf0 100644 --- a/offapi/com/sun/star/form/binding/XBindableValue.idl +++ b/offapi/com/sun/star/form/binding/XBindableValue.idl @@ -40,11 +40,11 @@ interface XBindableValue : com::sun::star::uno::XInterface <p>Any previously active binding will be revoked. There can be only one!</p> @param aBinding - the new binding which is to be used by the component. May be <NULL/>, + the new binding which is to be used by the component. May be `NULL`, in this case only the current binding is revoked. @throws IncompatibleTypesException - if the new binding (provided it's not <NULL/>) supports only types + if the new binding (provided it's not `NULL`) supports only types which are incompatible with the types of the bindable component. */ void setValueBinding( [in] XValueBinding aBinding ) diff --git a/offapi/com/sun/star/form/binding/XListEntrySink.idl b/offapi/com/sun/star/form/binding/XListEntrySink.idl index b70ed7646911..aa4a80e87b5d 100644 --- a/offapi/com/sun/star/form/binding/XListEntrySink.idl +++ b/offapi/com/sun/star/form/binding/XListEntrySink.idl @@ -38,7 +38,7 @@ interface XListEntrySink : com::sun::star::uno::XInterface filled with the entries from the new list source.</p> @param Source - the new source for the list entries. May be <NULL/>, in this + the new source for the list entries. May be `NULL`, in this case, the current source is revoked. */ void setListEntrySource( [in] XListEntrySource Source ); diff --git a/offapi/com/sun/star/form/binding/XListEntrySource.idl b/offapi/com/sun/star/form/binding/XListEntrySource.idl index 5d51089d574f..81236a0ff12a 100644 --- a/offapi/com/sun/star/form/binding/XListEntrySource.idl +++ b/offapi/com/sun/star/form/binding/XListEntrySource.idl @@ -62,7 +62,7 @@ interface XListEntrySource : com::sun::star::uno::XInterface reflected by the component. @throws com::sun::star::lang::NullPointerException - if the given listener is <NULL/> + if the given listener is `NULL` */ void addListEntryListener( [in] XListEntryListener Listener ) raises( com::sun::star::lang::NullPointerException ); @@ -71,7 +71,7 @@ interface XListEntrySource : com::sun::star::uno::XInterface be notified about changes in the entry list. @throws com::sun::star::lang::NullPointerException - if the given listener is <NULL/> + if the given listener is `NULL` */ void removeListEntryListener( [in] XListEntryListener Listener ) raises( com::sun::star::lang::NullPointerException ); diff --git a/offapi/com/sun/star/form/component/CommandButton.idl b/offapi/com/sun/star/form/component/CommandButton.idl index 09d0198b9845..451326ce6d24 100644 --- a/offapi/com/sun/star/form/component/CommandButton.idl +++ b/offapi/com/sun/star/form/component/CommandButton.idl @@ -78,7 +78,7 @@ published service CommandButton /** specifies the default toggle state for the button, used when it is reset. <p>This property is meaningful only when com::sun::star::awt::UnoControlButtonModel::Toggle - is <TRUE/>. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will + is `TRUE`. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will be reset.</p> <p>For a given implementation of the interface, if this (optional) property is present, then also the optional @@ -89,7 +89,7 @@ published service CommandButton /** allows resetting the button <p>This property is meaningful only when com::sun::star::awt::UnoControlButtonModel::Toggle - is <TRUE/>. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will + is `TRUE`. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will be reset, when com::sun::star::form::XReset::reset() is invoked.</p> <p>For a given implementation of the interface, if this (optional) interface is present, then also the optional diff --git a/offapi/com/sun/star/form/component/DataForm.idl b/offapi/com/sun/star/form/component/DataForm.idl index 5edcce71d509..347716768b28 100644 --- a/offapi/com/sun/star/form/component/DataForm.idl +++ b/offapi/com/sun/star/form/component/DataForm.idl @@ -63,7 +63,7 @@ published service DataForm service have been sent, the DataForm resets itself, if all com::sun::star::form::XResetListeners approve this.</li> <li>After the reset happened, the com::sun::star::sdb::RowSet::IsModified - property is reset to <FALSE/>. This property might have been switched to <TRUE/> during listener + property is reset to `FALSE`. This property might have been switched to `TRUE` during listener notifications, since listeners are allowed to change field values. Also, the com::sun::star::form::XReset::reset() implementations of bound control models might have modified the fields they're bound to (by filling them with default values).</li> @@ -164,7 +164,7 @@ published service DataForm <p>Note that this is a recommendation for user interface components displaying the form. Form implementations may decide to allow for insertions done via the API, even - if the property is set to <FALSE/>, but the user interface should respect the property + if the property is set to `FALSE`, but the user interface should respect the property value.</p> */ [property] boolean AllowInserts; @@ -173,7 +173,7 @@ published service DataForm <p>Note that this is a recommendation for user interface components displaying the form. Form implementations may decide to allow for updates done via the API, even - if the property is set to <FALSE/>, but the user interface should respect the property + if the property is set to `FALSE`, but the user interface should respect the property value.</p> */ [property] boolean AllowUpdates; @@ -182,7 +182,7 @@ published service DataForm <p>Note that this is a recommendation for user interface components displaying the form. Form implementations may decide to allow for deletions done via the API, even - if the property is set to <FALSE/>, but the user interface should respect the property + if the property is set to `FALSE`, but the user interface should respect the property value.</p> */ [property] boolean AllowDeletes; diff --git a/offapi/com/sun/star/form/component/DatabaseCheckBox.idl b/offapi/com/sun/star/form/component/DatabaseCheckBox.idl index e187cfe4d44f..cdf1e234763a 100644 --- a/offapi/com/sun/star/form/component/DatabaseCheckBox.idl +++ b/offapi/com/sun/star/form/component/DatabaseCheckBox.idl @@ -31,7 +31,7 @@ /** This service specifies a check box which is data-aware, and can be bound to a database field. <p>Mostly, you will create data-aware checkboxes as tristate checkboxes, because this - is a requirement to correctly handle <NULL/> values in databases.</p> + is a requirement to correctly handle `NULL` values in databases.</p> @see ::com::sun::star::awt::UnoControlCheckBoxModel::TriState */ diff --git a/offapi/com/sun/star/form/component/DatabaseComboBox.idl b/offapi/com/sun/star/form/component/DatabaseComboBox.idl index a94f5fb68ea2..5e231f3ef656 100644 --- a/offapi/com/sun/star/form/component/DatabaseComboBox.idl +++ b/offapi/com/sun/star/form/component/DatabaseComboBox.idl @@ -44,15 +44,15 @@ published service DatabaseComboBox service com::sun::star::form::DataAwareControlModel; - /** determines if an empty text should be treated as a <NULL/> value. + /** determines if an empty text should be treated as a `NULL` value. <p>When the user enters text into a combo box, and after this, the control content is to be committed into the database field the control is bound to, a decision must be made how to deal with empty strings.<br/> This is controlled by #ConvertEmptyToNull.</p> - <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is - converted into <NULL/>, else it is written as empty string.</p> + <p>If the property is set to `TRUE`, and an empty text is to be commited, this is + converted into `NULL`, else it is written as empty string.</p> */ [property] boolean ConvertEmptyToNull; diff --git a/offapi/com/sun/star/form/component/DatabaseFormattedField.idl b/offapi/com/sun/star/form/component/DatabaseFormattedField.idl index 92277a0c7fe5..f3b6d4554f86 100644 --- a/offapi/com/sun/star/form/component/DatabaseFormattedField.idl +++ b/offapi/com/sun/star/form/component/DatabaseFormattedField.idl @@ -37,15 +37,15 @@ published service DatabaseFormattedField service com::sun::star::form::DataAwareControlModel; - /** determines if an empty text should be treated as a <NULL/> value. + /** determines if an empty text should be treated as a `NULL` value. <p>When the user enters text into a formatted field control, and after this, the control content is to be committed into the database field the control is bound to, a decision must be made how to deal with empty strings.<br/> This is controlled by #ConvertEmptyToNull.</p> - <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is - converted into <NULL/>, else it is written as empty string.</p> + <p>If the property is set to `TRUE`, and an empty text is to be commited, this is + converted into `NULL`, else it is written as empty string.</p> */ [property] boolean ConvertEmptyToNull; diff --git a/offapi/com/sun/star/form/component/DatabasePatternField.idl b/offapi/com/sun/star/form/component/DatabasePatternField.idl index 0af61e14ea5e..b1fd540d1859 100644 --- a/offapi/com/sun/star/form/component/DatabasePatternField.idl +++ b/offapi/com/sun/star/form/component/DatabasePatternField.idl @@ -38,15 +38,15 @@ published service DatabasePatternField service com::sun::star::form::DataAwareControlModel; - /** determines if an empty text should be treated as a <NULL/> value. + /** determines if an empty text should be treated as a `NULL` value. <p>When the user enters text into a pattern field, and after this, the control content is to be committed into the database field the control is bound to, a decision must be made how to deal with empty strings.<br/> This is controlled by this property.</p> - <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is - converted into <NULL/>, else it is written as empty string.</p> + <p>If the property is set to `TRUE`, and an empty text is to be commited, this is + converted into `NULL`, else it is written as empty string.</p> */ [property] boolean ConvertEmptyToNull; diff --git a/offapi/com/sun/star/form/component/DatabaseTextField.idl b/offapi/com/sun/star/form/component/DatabaseTextField.idl index 8535ba447ccb..109a5b6e4aec 100644 --- a/offapi/com/sun/star/form/component/DatabaseTextField.idl +++ b/offapi/com/sun/star/form/component/DatabaseTextField.idl @@ -37,15 +37,15 @@ published service DatabaseTextField service com::sun::star::form::DataAwareControlModel; - /** determines if an empty text should be treated as a <NULL/> value. + /** determines if an empty text should be treated as a `NULL` value. <p>When the user enters text into a text field, and after this, the control content is to be committed into the database field the control is bound to, a decision must be made how to deal with empty strings.<br/> This is controlled by this property.</p> - <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is - converted into <NULL/>, else it is written as empty string.</p> + <p>If the property is set to `TRUE`, and an empty text is to be commited, this is + converted into `NULL`, else it is written as empty string.</p> */ [property] boolean ConvertEmptyToNull; diff --git a/offapi/com/sun/star/form/component/GridControl.idl b/offapi/com/sun/star/form/component/GridControl.idl index b79013145ab3..bbe67f21d6d9 100644 --- a/offapi/com/sun/star/form/component/GridControl.idl +++ b/offapi/com/sun/star/form/component/GridControl.idl @@ -141,7 +141,7 @@ published service GridControl /** specifies the height of a row of the grid. - <p>If the value is set to <NULL/>, the height is determined automatically according + <p>If the value is set to `NULL`, the height is determined automatically according to the current font used.</p> @see GridControl::FontDescriptor diff --git a/offapi/com/sun/star/form/component/RichTextControl.idl b/offapi/com/sun/star/form/component/RichTextControl.idl index c5c6ad509cac..180da427034c 100644 --- a/offapi/com/sun/star/form/component/RichTextControl.idl +++ b/offapi/com/sun/star/form/component/RichTextControl.idl @@ -44,17 +44,17 @@ published service RichTextControl /** specifies whether text should be automatically wrapped to fit into the control. - <p>If set to <TRUE/>, users need to manually press the enter key to insert a line break. - If set to <FALSE/>, text is automatically wrapped at the control border.</p> + <p>If set to `TRUE`, users need to manually press the enter key to insert a line break. + If set to `FALSE`, text is automatically wrapped at the control border.</p> */ [property] boolean HardLineBreaks; /** specifies whether the control should display the text including all its formatting. - <p>If this is set to <FALSE/>, the control will act as ordinary + <p>If this is set to `FALSE`, the control will act as ordinary com::sun::star::awt::UnoControlEditModel.</p> - <p>If the property is set to <TRUE/>, the control will ignore the following properties: + <p>If the property is set to `TRUE`, the control will ignore the following properties: <ul> <li>com::sun::star::awt::UnoControlEditModel::EchoChar</li> <li>com::sun::star::awt::UnoControlEditModel::MaxTextLen</li> diff --git a/offapi/com/sun/star/form/component/TextField.idl b/offapi/com/sun/star/form/component/TextField.idl index a8cd8f9d273d..f641d55a05ec 100644 --- a/offapi/com/sun/star/form/component/TextField.idl +++ b/offapi/com/sun/star/form/component/TextField.idl @@ -40,7 +40,7 @@ published service TextField /** specifies optional capabilities for displaying and inputting formatted text. - <p>If the RichTextControl::RichText property is set to <TRUE/>, + <p>If the RichTextControl::RichText property is set to `TRUE`, then the TextField component will disable it's reset capabilities. This means that all calls to com::sun::star::form::XReset::reset() will be ignored.</p> */ diff --git a/offapi/com/sun/star/form/runtime/FormOperations.idl b/offapi/com/sun/star/form/runtime/FormOperations.idl index b3723d73b3b3..032042d4b08a 100644 --- a/offapi/com/sun/star/form/runtime/FormOperations.idl +++ b/offapi/com/sun/star/form/runtime/FormOperations.idl @@ -39,7 +39,7 @@ service FormOperations : XFormOperations /** creates a <code>FormOperations</code> instance which works on a com::sun::star::form::FormController instance. @throws IllegalArgumentException - if the given form controller is <NULL/>, or does not have a model denoting a valid + if the given form controller is `NULL`, or does not have a model denoting a valid com::sun::star::form::component::DataForm instance. */ createWithFormController( @@ -53,7 +53,7 @@ service FormOperations : XFormOperations instance. @throws IllegalArgumentException - if the given form is <NULL/>, or does not support the com::sun::star::form::component::DataForm + if the given form is `NULL`, or does not support the com::sun::star::form::component::DataForm service. */ createWithForm( diff --git a/offapi/com/sun/star/form/runtime/XFormController.idl b/offapi/com/sun/star/form/runtime/XFormController.idl index 25b63bea16fc..ccfd0a6c2ca5 100644 --- a/offapi/com/sun/star/form/runtime/XFormController.idl +++ b/offapi/com/sun/star/form/runtime/XFormController.idl @@ -77,18 +77,18 @@ interface XFormControllerContext; is displayed to the user, the control is focused, and the update of the record is vetoed.</p> <p>Second, the controls are examined for NULL values. If a control is bound to a database field which - is declared to be <code>NOT NULL</code>, no auto-increment field, but still <NULL/>, then an error + is declared to be <code>NOT NULL</code>, no auto-increment field, but still `NULL`, then an error message is shown to the user saying that input is required, the respective control is focused, and the update of the record is vetoed.</p> - <p>Note that you can present the second check - for database fields containing <NULL/> values - on + <p>Note that you can present the second check - for database fields containing `NULL` values - on a per-form and a per-database basis.<br/> For the former, you need to add a boolean property <code>FormsCheckRequiredFields</code> to the form (aka the <code>FormController</code>'s model), using its com::sun::star::beans::XPropertyContainer::addProperty() method, with a value - of <FALSE/>.<br/> + of `FALSE`.<br/> For the latter, you need to set the respective property of the data source's <code>Settings</code> - (also named <code>FormsCheckRequiredFields</code>) to <FALSE/>.</p> + (also named <code>FormsCheckRequiredFields</code>) to `FALSE`.</p> <p>Alternatively, you can prevent the check on a per-control basis, using the DataAwareControlModel::InputRequired property of a single control model.</p> @@ -137,7 +137,7 @@ interface XFormControllerContext; notified when the record count changes.<br/> The status value which is being notified (com::sun::star::frame::FeatureStateEvent::State) is a string which can be used to display the record count. In particular, if the record count is not yet known - (com::sun::star::sdb::RowSet::IsRowCountFinal is <FALSE/>), this is indicated in the + (com::sun::star::sdb::RowSet::IsRowCountFinal is `FALSE`), this is indicated in the string, too.</td> </tr> @@ -332,7 +332,7 @@ interface XFormController */ [attribute] XFormControllerContext Context; - /** used (if not <NULL/>) for user interactions triggered by the form controller. + /** used (if not `NULL`) for user interactions triggered by the form controller. */ [attribute] ::com::sun::star::task::XInteractionHandler InteractionHandler; @@ -348,7 +348,7 @@ interface XFormController /** adds a controller to the list of child controllers @throws ::com::sun::star::lang::IllegalArgumentException - if the given controller is <NULL/>, or cannot rightfully be a child controller. Since controllers + if the given controller is `NULL`, or cannot rightfully be a child controller. Since controllers mirror the hierarchy of the forms the are responsible for, this means that the form of the given child controller must be a child of the controller at which the method is invoked. */ diff --git a/offapi/com/sun/star/form/runtime/XFormOperations.idl b/offapi/com/sun/star/form/runtime/XFormOperations.idl index 72ee295590b9..cccd187308a1 100644 --- a/offapi/com/sun/star/form/runtime/XFormOperations.idl +++ b/offapi/com/sun/star/form/runtime/XFormOperations.idl @@ -93,13 +93,13 @@ interface XFormOperations : ::com::sun::star::lang::XComponent For instance, you could imagine a toolbar button which is associated with a given feature. This button would be enabled if and only if the respective feature is currently available, and be checked if and only if the feature state is a <code>boolean</code> - evaluating to <TRUE/>.<p> + evaluating to `TRUE`.<p> @param Feature the feature whose state is to be determined. Must be one of the FormFeature constants.<br/> An invalid value here will be silently ignored, and simply return a FeatureState - indicating <em>disabled</em> with a <NULL/> state.</p> + indicating <em>disabled</em> with a `NULL` state.</p> */ FeatureState getState( [in] short Feature @@ -113,7 +113,7 @@ interface XFormOperations : ::com::sun::star::lang::XComponent @param Feature the feature whose state is to be determined. Must be one of the FormFeature constants.<br/> - An invalid value here will be silently ignored, and simply return <FALSE/>. + An invalid value here will be silently ignored, and simply return `FALSE`. */ boolean isEnabled( [in] short Feature @@ -181,11 +181,11 @@ interface XFormOperations : ::com::sun::star::lang::XComponent /** commits the current record of the form @param RecordInserted - will be <TRUE/> if a record has been inserted, i.e. the form was positioned + will be `TRUE` if a record has been inserted, i.e. the form was positioned on the insertion row. @return - <TRUE/> if and only if the current record needed being committed. That's the + `TRUE` if and only if the current record needed being committed. That's the case if the record or the active control of the form were modified. @throws ::com::sun::star::sdbc::SQLException @@ -231,7 +231,7 @@ interface XFormOperations : ::com::sun::star::lang::XComponent /** denotes the instance which should be notified about features whose state might have changed. - <p>If this attribute is not <NULL/>, the instance which it denotes will be notified + <p>If this attribute is not `NULL`, the instance which it denotes will be notified whenever the state of any supported feature might have changed.</p> <p>For instance, imagine a form whose current row has just been moved to another diff --git a/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl b/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl index 319008cd5267..33a94d2c66a3 100644 --- a/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl +++ b/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl @@ -47,7 +47,7 @@ service ValidatableBindableControlModel /** specifies support for binding the control value to an external component <p>If a value binding is established at the control model (by using - com::sun::star::form::binding::XBindableValue::setValueBinding() with a non-<NULL/> + com::sun::star::form::binding::XBindableValue::setValueBinding() with a non-`NULL` binding), this binding is analyzed for validation support. If it is present (read: if the binding also supports the XValidator interface), the binding is also established as validator, as if it has been passed to XValidatable::setValidator().<br/> diff --git a/offapi/com/sun/star/form/validation/XValidatable.idl b/offapi/com/sun/star/form/validation/XValidatable.idl index b16197bee711..5aa5aee25f70 100644 --- a/offapi/com/sun/star/form/validation/XValidatable.idl +++ b/offapi/com/sun/star/form/validation/XValidatable.idl @@ -40,7 +40,7 @@ interface XValidatable : com::sun::star::uno::XInterface <p>Any previously active validator will be revoked - there can be only one!</p> @param Validator - the new validator which is to be used by the component. May be <NULL/>, + the new validator which is to be used by the component. May be `NULL`, in this case only the current validator is revoked. @throws com::sun::star::util::VetoException diff --git a/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl b/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl index d75475013af0..f15bfc53538c 100644 --- a/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl +++ b/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl @@ -87,7 +87,7 @@ interface XValidatableFormComponent : XValidatable of the validatable form component (the validity flag, or the value) changed.</p> @throws com::sun::star::lang::NullPointerException - if the given listener is <NULL/> + if the given listener is `NULL` */ void addFormComponentValidityListener( [in] XFormComponentValidityListener Listener ) raises( com::sun::star::lang::NullPointerException ); @@ -95,7 +95,7 @@ interface XValidatableFormComponent : XValidatable /** registers the given listener. @throws com::sun::star::lang::NullPointerException - if the given listener is <NULL/> + if the given listener is `NULL` */ void removeFormComponentValidityListener( [in] XFormComponentValidityListener Listener ) raises( com::sun::star::lang::NullPointerException ); diff --git a/offapi/com/sun/star/form/validation/XValidator.idl b/offapi/com/sun/star/form/validation/XValidator.idl index 0b1096949e04..83520fc2a3e1 100644 --- a/offapi/com/sun/star/form/validation/XValidator.idl +++ b/offapi/com/sun/star/form/validation/XValidator.idl @@ -47,7 +47,7 @@ interface XValidator : com::sun::star::uno::XInterface @param aValue the value to check for validity @return - <TRUE/> if and only if the value is considered valid. + `TRUE` if and only if the value is considered valid. */ boolean isValid( [in] any Value ); @@ -69,7 +69,7 @@ interface XValidator : com::sun::star::uno::XInterface call.</p> @throws com::sun::star::lang::NullPointerException - if the given listener is <NULL/> + if the given listener is `NULL` @see XValidityConstraintListener */ void addValidityConstraintListener( [in] XValidityConstraintListener Listener ) @@ -78,7 +78,7 @@ interface XValidator : com::sun::star::uno::XInterface /** revokes the given validity listener @throws com::sun::star::lang::NullPointerException - if the given listener is <NULL/> + if the given listener is `NULL` @see XValidityConstraintListener */ void removeValidityConstraintListener( [in] XValidityConstraintListener Listener ) diff --git a/offapi/com/sun/star/frame/DispatchRecorder.idl b/offapi/com/sun/star/frame/DispatchRecorder.idl index 7f119a2db857..5eacc157912c 100644 --- a/offapi/com/sun/star/frame/DispatchRecorder.idl +++ b/offapi/com/sun/star/frame/DispatchRecorder.idl @@ -33,7 +33,7 @@ possible to generate e.g. Java/Basic or may Perl code. By using of a DispatchRecorderSupplier, which is available on a property of a Frame::DispatchRecorderSupplier, it's possible to change such code generation - for further requests or disable it in general by setting this property to <NULL/>. + for further requests or disable it in general by setting this property to `NULL`. </p> @see DispatchRecorderSupplier diff --git a/offapi/com/sun/star/frame/FeatureStateEvent.idl b/offapi/com/sun/star/frame/FeatureStateEvent.idl index 948991adaf60..e18e3e958c0d 100644 --- a/offapi/com/sun/star/frame/FeatureStateEvent.idl +++ b/offapi/com/sun/star/frame/FeatureStateEvent.idl @@ -59,7 +59,7 @@ published struct FeatureStateEvent: com::sun::star::lang::EventObject /** contains the state of the feature in this dispatch. <p> - This can be, for example, simply <TRUE/> for a boolean feature like + This can be, for example, simply `TRUE` for a boolean feature like underline on/off. Some simple types like <code>string</code> or `boolean` are useful here for generic UI elements, like a checkmark in a menu. diff --git a/offapi/com/sun/star/frame/Task.idl b/offapi/com/sun/star/frame/Task.idl index db110e922811..7bc2944c64e7 100644 --- a/offapi/com/sun/star/frame/Task.idl +++ b/offapi/com/sun/star/frame/Task.idl @@ -29,7 +29,7 @@ <p> Please use the service Frame instead of this deprecated Task. If it's - method XFrame.isTop() returns <TRUE/>, it's the same + method XFrame.isTop() returns `TRUE`, it's the same as a check for the Task service. </p> diff --git a/offapi/com/sun/star/frame/XComponentLoader.idl b/offapi/com/sun/star/frame/XComponentLoader.idl index b13fc90d6ae5..23b64ff3d90e 100644 --- a/offapi/com/sun/star/frame/XComponentLoader.idl +++ b/offapi/com/sun/star/frame/XComponentLoader.idl @@ -108,7 +108,7 @@ published interface XComponentLoader: com::sun::star::uno::XInterface a com::sun::star::lang::XComponent for successfully loaded documents or <br> - <NULL/>if it failed + `NULL`if it failed <p> This interface is a generic one and can be used to start further requests on diff --git a/offapi/com/sun/star/frame/XController.idl b/offapi/com/sun/star/frame/XController.idl index fb6e01c5b076..dbe168535019 100644 --- a/offapi/com/sun/star/frame/XController.idl +++ b/offapi/com/sun/star/frame/XController.idl @@ -49,22 +49,22 @@ published interface XController: com::sun::star::lang::XComponent the new model for this controller @return - <TRUE/>if attach was successfully + `TRUE`if attach was successfully <br> - <FALSE/>otherwise + `FALSE`otherwise */ boolean attachModel( [in] XModel Model ); /** is called to prepare the controller for closing the view @param Suspend - <TRUE/>force the controller to suspend his work - <FALSE/>try to reactivate the controller + `TRUE`force the controller to suspend his work + `FALSE`try to reactivate the controller @return - <TRUE/>if request was accepted and of course successfully finished + `TRUE`if request was accepted and of course successfully finished <br> - <FALSE/>otherwise + `FALSE`otherwise */ boolean suspend( [in] boolean Suspend ); diff --git a/offapi/com/sun/star/frame/XDesktop.idl b/offapi/com/sun/star/frame/XDesktop.idl index cbb8cc3adf25..4a338c80564d 100644 --- a/offapi/com/sun/star/frame/XDesktop.idl +++ b/offapi/com/sun/star/frame/XDesktop.idl @@ -54,9 +54,9 @@ published interface XDesktop: com::sun::star::uno::XInterface </p> @return - <TRUE/>if all listener agree with this request + `TRUE`if all listener agree with this request <br> - <FALSE/>otherwise + `FALSE`otherwise @see XTerminateListener @see TerminationVetoException diff --git a/offapi/com/sun/star/frame/XDispatchProvider.idl b/offapi/com/sun/star/frame/XDispatchProvider.idl index 5a41437113da..5259404748bf 100644 --- a/offapi/com/sun/star/frame/XDispatchProvider.idl +++ b/offapi/com/sun/star/frame/XDispatchProvider.idl @@ -51,7 +51,7 @@ published interface XDispatchProvider: com::sun::star::uno::XInterface @return the dispatch object which provides queried functionality <br> - or <NULL/> if no dispatch object is available + or `NULL` if no dispatch object is available @see XFrame::findFrame() @see XDispatchProvider::queryDispatches() @@ -72,7 +72,7 @@ published interface XDispatchProvider: com::sun::star::uno::XInterface <p> It's not allowed to pack it - because every request must match - to his real result. Means: don't delete <NULL/> entries inside this list. + to his real result. Means: don't delete `NULL` entries inside this list. </p> */ sequence< XDispatch > queryDispatches( diff --git a/offapi/com/sun/star/frame/XDocumentTemplates.idl b/offapi/com/sun/star/frame/XDocumentTemplates.idl index 2d8555239637..68085643004b 100644 --- a/offapi/com/sun/star/frame/XDocumentTemplates.idl +++ b/offapi/com/sun/star/frame/XDocumentTemplates.idl @@ -62,9 +62,9 @@ published interface XDocumentTemplates: com::sun::star::uno::XInterface specifies the target @return - <TRUE/> if operation was successful + `TRUE` if operation was successful <br> - <FALSE/> otherwise + `FALSE` otherwise @see XDocumentTemplates::addTemplate() */ @@ -86,9 +86,9 @@ published interface XDocumentTemplates: com::sun::star::uno::XInterface specifies the position of template @return - <TRUE/> if operation was successful + `TRUE` if operation was successful <br> - <FALSE/> otherwise + `FALSE` otherwise @see XDocumentTemplates::storeTemplate() */ @@ -106,9 +106,9 @@ published interface XDocumentTemplates: com::sun::star::uno::XInterface specifies the template for delete @return - <TRUE/> if operation was successful + `TRUE` if operation was successful <br> - <FALSE/> otherwise + `FALSE` otherwise */ boolean removeTemplate( [in] string GroupName, @@ -123,9 +123,9 @@ published interface XDocumentTemplates: com::sun::star::uno::XInterface specifies the template for renaming @return - <TRUE/> if operation was successful + `TRUE` if operation was successful <br> - <FALSE/> otherwise + `FALSE` otherwise */ boolean renameTemplate( [in] string GroupName, @@ -138,9 +138,9 @@ published interface XDocumentTemplates: com::sun::star::uno::XInterface the name of the group to be created @return - <TRUE/> if operation was successful + `TRUE` if operation was successful <br> - <FALSE/> otherwise + `FALSE` otherwise */ boolean addGroup( [in] string GroupName ); @@ -150,9 +150,9 @@ published interface XDocumentTemplates: com::sun::star::uno::XInterface the name of the group to be removed @return - <TRUE/> if operation was successful + `TRUE` if operation was successful <br> - <FALSE/> otherwise + `FALSE` otherwise */ boolean removeGroup( [in] string GroupName ); @@ -165,9 +165,9 @@ published interface XDocumentTemplates: com::sun::star::uno::XInterface the new name of the group @return - <TRUE/> if operation was successful + `TRUE` if operation was successful <br> - <FALSE/> otherwise + `FALSE` otherwise */ boolean renameGroup( [in] string OldGroupName, diff --git a/offapi/com/sun/star/frame/XFrame.idl b/offapi/com/sun/star/frame/XFrame.idl index 9901eada9e82..05d7f172ad00 100644 --- a/offapi/com/sun/star/frame/XFrame.idl +++ b/offapi/com/sun/star/frame/XFrame.idl @@ -192,9 +192,9 @@ published interface XFrame: com::sun::star::lang::XComponent </p> @return - <TRUE/> if frame supports top frame specification + `TRUE` if frame supports top frame specification <br> - <FALSE/> otherwise + `FALSE` otherwise */ boolean isTop(); @@ -235,9 +235,9 @@ published interface XFrame: com::sun::star::lang::XComponent /** determines if the frame is active. @return - <TRUE/> for active or UI active frames + `TRUE` for active or UI active frames <br> - <FALSE/> otherwise + `FALSE` otherwise @see XFrame::activate() @see XFrame::deactivate() @@ -247,14 +247,14 @@ published interface XFrame: com::sun::star::lang::XComponent /** sets a new component into the frame or release an existing one from a frame. @param xComponentWindow - the window of the new component or <NULL/> for release + the window of the new component or `NULL` for release <p> A valid component window should be a child of the frame container window. </p> @param xController - the controller of the new component or <NULL/> for release + the controller of the new component or `NULL` for release <p> Simple components may implement a com::sun::star::awt::XWindow only. @@ -262,9 +262,9 @@ published interface XFrame: com::sun::star::lang::XComponent </p> @return - <TRUE/>if setting of new component or release of an existing one was successfully + `TRUE`if setting of new component or release of an existing one was successfully <br> - <FALSE/> otherwise (especially, if an existing controller disagree within his + `FALSE` otherwise (especially, if an existing controller disagree within his XController::suspend() call) @see XFrame::getComponentWindow() @@ -284,7 +284,7 @@ published interface XFrame: com::sun::star::lang::XComponent @returns the current visible component in this frame <br> - or <NULL/> if no one currently exist + or `NULL` if no one currently exist @see XFrame::setComponent() */ @@ -302,7 +302,7 @@ published interface XFrame: com::sun::star::lang::XComponent @returns the current controller within this frame <br> - or <NULL/> if no one currently exist + or `NULL` if no one currently exist @see XFrame::setComponent() */ diff --git a/offapi/com/sun/star/frame/XFrame2.idl b/offapi/com/sun/star/frame/XFrame2.idl index 9905bafca9f3..00543c148f06 100644 --- a/offapi/com/sun/star/frame/XFrame2.idl +++ b/offapi/com/sun/star/frame/XFrame2.idl @@ -115,7 +115,7 @@ published interface XFrame2 That means: if someone wishes to enable recoding on a frame he must set a supplier with a recorder object inside of it. Every user of dispatches has to check then if such supplier is available at this frame property. - If value of this property is <NULL/> he must call XDispatch::dispatch() + If value of this property is `NULL` he must call XDispatch::dispatch() on the original dispatch object. If it's a valid value he must use the supplier by calling his method XDispatchRecorderSupplier::dispatchAndRecord() with the original dispatch object as argument. diff --git a/offapi/com/sun/star/frame/XLayoutManager.idl b/offapi/com/sun/star/frame/XLayoutManager.idl index b593aa9ca439..a6ba65dae90a 100644 --- a/offapi/com/sun/star/frame/XLayoutManager.idl +++ b/offapi/com/sun/star/frame/XLayoutManager.idl @@ -162,8 +162,8 @@ interface XLayoutManager : com::sun::star::uno::XInterface name. @return - returns <TRUE/> if the user interface element could be made visible, otherwise - <FALSE/> will be returned. + returns `TRUE` if the user interface element could be made visible, otherwise + `FALSE` will be returned. <p> If a user interface element should forced to the visible state @@ -209,7 +209,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface name. @return - returns <TRUE/> if the user interface element has been shown, otherwise <FALSE/> will be returned. + returns `TRUE` if the user interface element has been shown, otherwise `FALSE` will be returned. */ boolean showElement( [in] string ResourceURL ); @@ -221,7 +221,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface name. @return - returns <TRUE/> if the user interface element has been hidden, otherwise <FALSE/> will be returned. + returns `TRUE` if the user interface element has been hidden, otherwise `FALSE` will be returned. */ boolean hideElement( [in] string ResourceURL ); @@ -239,7 +239,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface specifies the position inside the docking area. @return - returns <TRUE/> if the user interface element has been docked, otherwise <FALSE/> will be returned. + returns `TRUE` if the user interface element has been docked, otherwise `FALSE` will be returned. @see com::sun::star::ui::DockingArea */ @@ -251,8 +251,8 @@ interface XLayoutManager : com::sun::star::uno::XInterface specifies which user interface element type should be docked. @return - returns <TRUE/> if all user interface elements of the requested type could be - docked, otherwise <FALSE/> will be returned. + returns `TRUE` if all user interface elements of the requested type could be + docked, otherwise `FALSE` will be returned. @see com::sun::star::ui::UIElementType */ @@ -266,7 +266,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface name. @return - returns <TRUE/> if the user interface element has been docked, otherwise <FALSE/> will be returned. + returns `TRUE` if the user interface element has been docked, otherwise `FALSE` will be returned. */ boolean floatWindow( [in] string ResourceURL ); @@ -278,7 +278,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface name. @return - returns <TRUE/> if the user interface element has been locked, otherwise <FALSE/> will be returned. + returns `TRUE` if the user interface element has been locked, otherwise `FALSE` will be returned. */ boolean lockWindow( [in] string ResourceURL ); @@ -290,8 +290,8 @@ interface XLayoutManager : com::sun::star::uno::XInterface to use ASCII characters for type and name. @return - returns <TRUE/> if the user interface element has been unlocked, otherwise - <FALSE/> will be returned. + returns `TRUE` if the user interface element has been unlocked, otherwise + `FALSE` will be returned. */ boolean unlockWindow( [in] string ResourceURL ); @@ -357,7 +357,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface name. @return - <TRUE/> if the user interface element is visible, otherwise <FALSE/>. + `TRUE` if the user interface element is visible, otherwise `FALSE`. */ boolean isElementVisible( [in] string ResourceURL ); @@ -369,7 +369,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface name. @return - <TRUE/> if the user interface element is floating, otherwise <FALSE/>. + `TRUE` if the user interface element is floating, otherwise `FALSE`. */ boolean isElementFloating( [in] string ResourceURL ); @@ -381,7 +381,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface name. @return - <TRUE/> if the user interface element is docked, otherwise <FALSE/>. + `TRUE` if the user interface element is docked, otherwise `FALSE`. */ boolean isElementDocked( [in] string ResourceURL ); @@ -393,7 +393,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface name. @return - <TRUE/> if the user interface element is locked, otherwise <FALSE/>. + `TRUE` if the user interface element is locked, otherwise `FALSE`. */ boolean isElementLocked( [in] string ResourceURL ); @@ -453,8 +453,8 @@ interface XLayoutManager : com::sun::star::uno::XInterface </p> @param Visible - provide <FALSE/> to make layout manager invisible otherwise this must be - set to <TRUE/>. + provide `FALSE` to make layout manager invisible otherwise this must be + set to `TRUE`. */ void setVisible( [in] boolean Visible ); diff --git a/offapi/com/sun/star/frame/XModel.idl b/offapi/com/sun/star/frame/XModel.idl index a779f74c6739..7bd8139ef374 100644 --- a/offapi/com/sun/star/frame/XModel.idl +++ b/offapi/com/sun/star/frame/XModel.idl @@ -67,9 +67,9 @@ published interface XModel: com::sun::star::lang::XComponent (see com::sun::star::document::MediaDescriptor) @return - <TRUE/> for success + `TRUE` for success <br> - <FALSE/> otherwise + `FALSE` otherwise */ boolean attachResource( [in] string URL, @@ -156,9 +156,9 @@ published interface XModel: com::sun::star::lang::XComponent </p> @return - <TRUE/> if any lock exist + `TRUE` if any lock exist <br> - <FALSE/> otherwise + `FALSE` otherwise */ boolean hasControllersLocked(); @@ -169,7 +169,7 @@ published interface XModel: com::sun::star::lang::XComponent it will be returned. If not, the controller which was the last active of this model is returned. If no controller of this model ever was active, the controller first registered is returned. If no - controller is registered for this model, <NULL/> is returned. + controller is registered for this model, `NULL` is returned. */ XController getCurrentController(); @@ -189,7 +189,7 @@ published interface XModel: com::sun::star::lang::XComponent @returns the current selection in the current controller. - If there is no current controller, it returns <NULL/>. + If there is no current controller, it returns `NULL`. */ com::sun::star::uno::XInterface getCurrentSelection(); }; diff --git a/offapi/com/sun/star/frame/XSessionManagerClient.idl b/offapi/com/sun/star/frame/XSessionManagerClient.idl index 5bce6297aced..c784f77346c7 100644 --- a/offapi/com/sun/star/frame/XSessionManagerClient.idl +++ b/offapi/com/sun/star/frame/XSessionManagerClient.idl @@ -82,8 +82,8 @@ module com { module sun { module star { module frame { /** Call cancelShutdown to try to cancel a desktop shutdown in progress @returns - <TRUE/> if shutdown was canceled, - <FALSE/> else. + `TRUE` if shutdown was canceled, + `FALSE` else. */ boolean cancelShutdown(); }; diff --git a/offapi/com/sun/star/frame/XSessionManagerListener.idl b/offapi/com/sun/star/frame/XSessionManagerListener.idl index 9c8db2f5bd20..d82e7b09188c 100644 --- a/offapi/com/sun/star/frame/XSessionManagerListener.idl +++ b/offapi/com/sun/star/frame/XSessionManagerListener.idl @@ -40,12 +40,12 @@ module com { module sun { module star { module frame { on the session manager client service object.</p> @param bShutdown - <TRUE/> if a shutdown is in progress, - <FALSE/> if just a save point was requested + `TRUE` if a shutdown is in progress, + `FALSE` if just a save point was requested @param bCancelable - <TRUE/> if a shutdown in progress can be canceled by the listener, - <FALSE/> else + `TRUE` if a shutdown in progress can be canceled by the listener, + `FALSE` else <p>the listener may choose to ignore the saveDone() event in case no real shutdown is in progress. He @@ -62,8 +62,8 @@ module com { module sun { module star { module frame { interaction request was processed by the session manager @param bInteractionGranted - If <FALSE/> the listener must not interact with the user. - If <TRUE/> the listener can interact with the user now. + If `FALSE` the listener must not interact with the user. + If `TRUE` the listener can interact with the user now. After interaction the listener must call XSessionManagerClient::interactionDone() on the session manager client service object. diff --git a/offapi/com/sun/star/frame/XStatusbarController.idl b/offapi/com/sun/star/frame/XStatusbarController.idl index ac9c83e2d623..079fd3191153 100644 --- a/offapi/com/sun/star/frame/XStatusbarController.idl +++ b/offapi/com/sun/star/frame/XStatusbarController.idl @@ -117,7 +117,7 @@ interface XStatusbarController current information about the mouse pointer. @return - return <TRUE/> if the event should not be processed and <FALSE/> + return `TRUE` if the event should not be processed and `FALSE` if the event should be processed by the status bar. */ boolean mouseButtonDown( [in] ::com::sun::star::awt::MouseEvent aMouseEvent ); @@ -131,7 +131,7 @@ interface XStatusbarController current information about the mouse pointer. @return - return <TRUE/> if the event should not be processed and <FALSE/> + return `TRUE` if the event should not be processed and `FALSE` if the event should be processed by the status bar. */ boolean mouseMove( [in] ::com::sun::star::awt::MouseEvent aMouseEvent ); @@ -145,7 +145,7 @@ interface XStatusbarController current information about the mouse pointer. @return - return <TRUE/> if the event should not be processed and <FALSE/> + return `TRUE` if the event should not be processed and `FALSE` if the event should be processed by the status bar. */ boolean mouseButtonUp( [in] ::com::sun::star::awt::MouseEvent aMouseEvent ); @@ -161,7 +161,7 @@ interface XStatusbarController possible values. @param bMouseEvent - <TRUE/> if the command is based on a mouse event, otherwise <FALSE/>. + `TRUE` if the command is based on a mouse event, otherwise `FALSE`. @param aData for future use only. diff --git a/offapi/com/sun/star/frame/XStorable.idl b/offapi/com/sun/star/frame/XStorable.idl index 3ce4d27d5a60..ed0427fbff09 100644 --- a/offapi/com/sun/star/frame/XStorable.idl +++ b/offapi/com/sun/star/frame/XStorable.idl @@ -50,8 +50,8 @@ published interface XStorable: com::sun::star::uno::XInterface or because it is stored there. @returns - <TRUE/> if the object knows a location where it is persistent - <FALSE/> otherwise + `TRUE` if the object knows a location where it is persistent + `FALSE` otherwise */ boolean hasLocation(); @@ -67,8 +67,8 @@ published interface XStorable: com::sun::star::uno::XInterface when the data store is read-only. @returns - <TRUE/> if the data store is readonly or opened readonly - <FALSE/> otherwise + `TRUE` if the data store is readonly or opened readonly + `FALSE` otherwise */ boolean isReadonly(); diff --git a/offapi/com/sun/star/frame/XSubToolbarController.idl b/offapi/com/sun/star/frame/XSubToolbarController.idl index eaf677041c2f..624218e827ce 100644 --- a/offapi/com/sun/star/frame/XSubToolbarController.idl +++ b/offapi/com/sun/star/frame/XSubToolbarController.idl @@ -42,7 +42,7 @@ interface XSubToolbarController : com::sun::star::uno::XInterface /** if the controller features a sub-toolbar. @return - <TRUE/> if the controller offers a sub toolbar, otherwise <FALSE/>. + `TRUE` if the controller offers a sub toolbar, otherwise `FALSE`. <p> Enables implementations to dynamically decide to support sub-toolbars diff --git a/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl b/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl index b58deeb38b42..f4673de36cb1 100644 --- a/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl +++ b/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl @@ -46,9 +46,9 @@ published interface XSynchronousFrameLoader: com::sun::star::uno::XInterface the target frame which should contain the new loaded component @return - <TRUE/> if loading is successfully + `TRUE` if loading is successfully <br> - <FALSE/> otherwise + `FALSE` otherwise */ boolean load( [in] sequence< com::sun::star::beans::PropertyValue > Descriptor, @@ -60,7 +60,7 @@ published interface XSynchronousFrameLoader: com::sun::star::uno::XInterface No notifications (neither to the frame or the caller) must be notified. Because it's a synchronous process this cancel call can be forced by another thread the loader thread only. Method - XSynchronousFrameLoader::load() must return <FALSE/> + XSynchronousFrameLoader::load() must return `FALSE` then and caller of this method XSynchronousFrameLoader::cancel() already knows the state ... </p> diff --git a/offapi/com/sun/star/frame/status/Visibility.idl b/offapi/com/sun/star/frame/status/Visibility.idl index 4a1b007d7973..0533ccbfa312 100644 --- a/offapi/com/sun/star/frame/status/Visibility.idl +++ b/offapi/com/sun/star/frame/status/Visibility.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module frame { module status { struct Visibility { - /** <TRUE/> if the property is visible otherwise <FALSE/>. + /** `TRUE` if the property is visible otherwise `FALSE`. */ boolean bVisible; }; diff --git a/offapi/com/sun/star/geometry/EllipticalArc.idl b/offapi/com/sun/star/geometry/EllipticalArc.idl index cdc5d97899a6..7fe9b40e9c62 100644 --- a/offapi/com/sun/star/geometry/EllipticalArc.idl +++ b/offapi/com/sun/star/geometry/EllipticalArc.idl @@ -61,13 +61,13 @@ struct EllipticalArc double XAxisRotation; - /** If <TRUE/>, and there's a choice, take the longer one of two arcs + /** If `TRUE`, and there's a choice, take the longer one of two arcs connecting start and end point. */ boolean IsLargeArc; - /** If <TRUE/>, and there's a choice, take the arc that goes + /** If `TRUE`, and there's a choice, take the arc that goes clock-wise from start to end point. */ boolean IsClockwiseSweep; diff --git a/offapi/com/sun/star/graphic/GraphicDescriptor.idl b/offapi/com/sun/star/graphic/GraphicDescriptor.idl index 00d4f680133f..248e95f72467 100644 --- a/offapi/com/sun/star/graphic/GraphicDescriptor.idl +++ b/offapi/com/sun/star/graphic/GraphicDescriptor.idl @@ -113,7 +113,7 @@ published service GraphicDescriptor /** Indicates that it is a transparent graphic - <p>This property is always <TRUE/> for vector graphics. + <p>This property is always `TRUE` for vector graphics. The status of this flag is not always clear if the graphic was not loaded at all, e.g. in case of just querying for the GraphicDescriptor.</p> diff --git a/offapi/com/sun/star/i18n/XBreakIterator.idl b/offapi/com/sun/star/i18n/XBreakIterator.idl index 37930fcee43a..7ea9c5d5b023 100644 --- a/offapi/com/sun/star/i18n/XBreakIterator.idl +++ b/offapi/com/sun/star/i18n/XBreakIterator.idl @@ -123,7 +123,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface of one word and EndPos of previous word. In this situation, the outcome of the algorithm can be indeterminate. In this situation the <em>bPreferForward</em> flag is used. If bPreferForward == - <FALSE/>, <em>nPos</em> is considered to be the end of the word + `FALSE`, <em>nPos</em> is considered to be the end of the word and we look backwards for beginning of word, otherwise <em>nPos</em> is considered to be the start of the next word and we look forwards for the end of the word. </p> @@ -156,7 +156,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface <p> It is possible that both of this method and following method <em>isEndWord</em> all return - <TRUE/>, since StartPos of a word is inclusive + `TRUE`, since StartPos of a word is inclusive while EndPos of a word is exclusive. </p> diff --git a/offapi/com/sun/star/i18n/XExtendedIndexEntrySupplier.idl b/offapi/com/sun/star/i18n/XExtendedIndexEntrySupplier.idl index eca414a78200..d7e1a46e1018 100644 --- a/offapi/com/sun/star/i18n/XExtendedIndexEntrySupplier.idl +++ b/offapi/com/sun/star/i18n/XExtendedIndexEntrySupplier.idl @@ -79,8 +79,8 @@ published interface XExtendedIndexEntrySupplier : ::com::sun::star::i18n::XIndex comparing index entries @return - <TRUE/> if algorithm successfully loaded, - <FALSE/> else. + `TRUE` if algorithm successfully loaded, + `FALSE` else. */ boolean loadAlgorithm( [in] com::sun::star::lang::Locale aLocale, [in] string aIndexAlgorithm, diff --git a/offapi/com/sun/star/i18n/XIndexEntrySupplier.idl b/offapi/com/sun/star/i18n/XIndexEntrySupplier.idl index b95dce043ad1..72195f86a1d7 100644 --- a/offapi/com/sun/star/i18n/XIndexEntrySupplier.idl +++ b/offapi/com/sun/star/i18n/XIndexEntrySupplier.idl @@ -50,8 +50,8 @@ published interface XIndexEntrySupplier : com::sun::star::uno::XInterface com::sun::star::lang::Locale. <p> For example, in English locale it returns <br/> - <b>"p."</b> for <em>bMorePages</em> == <FALSE/> <br/> - <b>"pp."</b> for <em>bMorePages</em> == <TRUE/> </p> + <b>"p."</b> for <em>bMorePages</em> == `FALSE` <br/> + <b>"pp."</b> for <em>bMorePages</em> == `TRUE` </p> */ string getIndexFollowPageWord( [in] boolean bMorePages, [in] com::sun::star::lang::Locale aLocale ); diff --git a/offapi/com/sun/star/i18n/XTextConversion.idl b/offapi/com/sun/star/i18n/XTextConversion.idl index e809cebb9973..0c48f84df33b 100644 --- a/offapi/com/sun/star/i18n/XTextConversion.idl +++ b/offapi/com/sun/star/i18n/XTextConversion.idl @@ -111,8 +111,8 @@ published interface XTextConversion : ::com::sun::star::uno::XInterface @param nTextConversionOptions Combination of TextConversionOption values. @returns - <TRUE/> if the entry is a valid entry for the dictionary - <FALSE/> otherwise. + `TRUE` if the entry is a valid entry for the dictionary + `FALSE` otherwise. @throws NoSupportException when <var>nConversionDictionaryType</var> is not known by the implementation, diff --git a/offapi/com/sun/star/i18n/XTransliteration.idl b/offapi/com/sun/star/i18n/XTransliteration.idl index 22e8f494481b..4c4867782bae 100644 --- a/offapi/com/sun/star/i18n/XTransliteration.idl +++ b/offapi/com/sun/star/i18n/XTransliteration.idl @@ -203,9 +203,9 @@ published interface XTransliteration: com::sun::star::uno::XInterface <p> Returns the number of matched code points in any case, even if strings are not equal, for example: <br/> equals( "a", 0, 1, nMatch1, "aaa", 0, 3, nMatch2 ) <br/> - returns <FALSE/> and nMatch:=1 and nMatch2:=1 <br/> + returns `FALSE` and nMatch:=1 and nMatch2:=1 <br/> equals( "aab", 0, 3, nMatch1, "aaa", 0, 3, nMatch2 ) <br/> - returns <FALSE/> and nMatch:=2 and nMatch2:=2 <br/> </p> + returns `FALSE` and nMatch:=2 and nMatch2:=2 <br/> </p> @param aStr1 First string to match. @@ -232,9 +232,9 @@ published interface XTransliteration: com::sun::star::uno::XInterface Returns number of matched code points in aStr2. @returns - <TRUE/> if the substrings are equal per this + `TRUE` if the substrings are equal per this transliteration <br/> - <FALSE/> else. + `FALSE` else. */ boolean equals( [in] string aStr1, [in] long nPos1, [in] long nCount1, diff --git a/offapi/com/sun/star/inspection/DefaultHelpProvider.idl b/offapi/com/sun/star/inspection/DefaultHelpProvider.idl index 2e365def0c46..5c2be9aa7c87 100644 --- a/offapi/com/sun/star/inspection/DefaultHelpProvider.idl +++ b/offapi/com/sun/star/inspection/DefaultHelpProvider.idl @@ -41,9 +41,9 @@ service DefaultHelpProvider : com::sun::star::uno::XInterface /** creates a help provider instance @param InspectorUI provides access to the UI of the ObjectInspector which should be - observed. Must not be <NULL/>. + observed. Must not be `NULL`. @throws ::com::sun::star::lang::IllegalArgumentException - if the given inspector UI is <NULL/>. + if the given inspector UI is `NULL`. */ create( [in] XObjectInspectorUI InspectorUI ) raises ( ::com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/inspection/LineDescriptor.idl b/offapi/com/sun/star/inspection/LineDescriptor.idl index 4c6cad8b8788..6bbeaba55628 100644 --- a/offapi/com/sun/star/inspection/LineDescriptor.idl +++ b/offapi/com/sun/star/inspection/LineDescriptor.idl @@ -89,7 +89,7 @@ struct LineDescriptor <p>This URL will be used to obtain an actual com::sun::star::graphic::XGraphic object from an com::sun::star::graphic::GraphicProvider.</p> - <p>The property will be ignored if #HasPrimaryButton is <FALSE/>.</p> + <p>The property will be ignored if #HasPrimaryButton is `FALSE`.</p> <p>If you need to specify a graphic which does not have an URL, but is available as com::sun::star::graphic::XGraphic only, then you must leave @@ -101,7 +101,7 @@ struct LineDescriptor /** describes a graphics to display at the primary button, if any. - <p>The property will be ignored if #HasPrimaryButton is <FALSE/>, or + <p>The property will be ignored if #HasPrimaryButton is `FALSE`, or if #PrimaryButtonImageURL is a non-empty string.</p> @see HasPrimaryButton @@ -134,7 +134,7 @@ struct LineDescriptor <p>This URL will be used to obtain an actual com::sun::star::graphic::XGraphic object from an com::sun::star::graphic::GraphicProvider.</p> - <p>The property will be ignored if #HasSecondaryButton is <FALSE/>.</p> + <p>The property will be ignored if #HasSecondaryButton is `FALSE`.</p> <p>If you need to specify a graphic which does not have an URL, but is available as com::sun::star::graphic::XGraphic only, then you must leave @@ -146,7 +146,7 @@ struct LineDescriptor /** describes a graphics to display at the secondary button, if any. - <p>The property will be ignored if #HasSecondaryButton is <FALSE/>, or + <p>The property will be ignored if #HasSecondaryButton is `FALSE`, or if #SecondaryButtonImageURL is a non-empty string.</p> @see HasSecondaryButton diff --git a/offapi/com/sun/star/inspection/ObjectInspector.idl b/offapi/com/sun/star/inspection/ObjectInspector.idl index 3ad5098703e5..64a8464ce1ac 100644 --- a/offapi/com/sun/star/inspection/ObjectInspector.idl +++ b/offapi/com/sun/star/inspection/ObjectInspector.idl @@ -78,7 +78,7 @@ service ObjectInspector : XObjectInspector /** creates an instance of the ObjectInspector, using a given ObjectInspectorModel @throws ::com::sun::star::lang::IllegalArgumentException - if Model is <NULL/>. + if Model is `NULL`. @since OOo 2.2 */ diff --git a/offapi/com/sun/star/inspection/XObjectInspector.idl b/offapi/com/sun/star/inspection/XObjectInspector.idl index bea67d040923..6ec9169d9ca3 100644 --- a/offapi/com/sun/star/inspection/XObjectInspector.idl +++ b/offapi/com/sun/star/inspection/XObjectInspector.idl @@ -40,8 +40,8 @@ interface XObjectInspector /** allows to plug the inspector into an com::sun::star::frame::XFrame <p>The com::sun::star::frame::XController::setModel() method - accepts only XObjectInspectorModels, and will return <FALSE/> if the - to-be-attached model is not <NULL/>, but does not support this interface.</p> + 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 com::sun::star::frame::XModel, use the #InspectorModel attribute instead.</p> diff --git a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl index 741c89b6e76f..b83348fcd941 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl @@ -130,7 +130,7 @@ interface XObjectInspectorModel section. <p>This property is ignored by the ObjectInspector if - #HasHelpSection is <FALSE/>.</p> + #HasHelpSection is `FALSE`.</p> <p>The layout of the ObjectInspector is undefined if #MinHelpTextLines is larger than @@ -144,7 +144,7 @@ interface XObjectInspectorModel section. <p>This property is ignored by the ObjectInspector if - #HasHelpSection is <FALSE/>.</p> + #HasHelpSection is `FALSE`.</p> <p>The layout of the ObjectInspector is undefined if #MaxHelpTextLines is smaller than diff --git a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl index 5d3ea226dbe3..465c28c34fac 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl @@ -51,7 +51,7 @@ interface XObjectInspectorUI @param PropertyName denotes the name of the property whose UI is to be enabled or disabled. @param Enable - <TRUE/> if and only if the UI should be disabled, <FALSE/> otherwise. + `TRUE` if and only if the UI should be disabled, `FALSE` otherwise. */ void enablePropertyUI( [in] string PropertyName, [in] boolean Enable ); @@ -71,7 +71,7 @@ interface XObjectInspectorUI 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 - <TRUE/> if the elements denoted by _nElements should be enabled, <FALSE/> if + `TRUE` if the elements denoted by _nElements should be enabled, `FALSE` if they should be disabled. */ void enablePropertyUIElements( @@ -123,7 +123,7 @@ interface XObjectInspectorUI the name of the property whose control should be retrieved @return - the XPropertyControl 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 232517f1d971..f257a3bbb0a5 100644 --- a/offapi/com/sun/star/inspection/XPropertyControl.idl +++ b/offapi/com/sun/star/inspection/XPropertyControl.idl @@ -68,9 +68,9 @@ interface XPropertyControl /** determines whether the control content is currently modified <p>An XPropertyControl internally manages a flag indicating whether - its content is modified. This flag is reset to <FALSE/> every time our + its content is modified. This flag is reset to `FALSE` every time our #ControlContext is notified of our current value. Also, the control - implementation must set this flag to <TRUE/> if and only if the user changed the + implementation must set this flag to `TRUE` if and only if the user changed the control content.</p> @see notifyModifiedValue @@ -93,7 +93,7 @@ interface XPropertyControl <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> + <p>This Window must not be `NULL`, else the whole control is not usable.</p> */ [attribute, readonly] com::sun::star::awt::XWindow ControlWindow; }; diff --git a/offapi/com/sun/star/inspection/XPropertyControlFactory.idl b/offapi/com/sun/star/inspection/XPropertyControlFactory.idl index 06b3a40b237b..3429647b8b99 100644 --- a/offapi/com/sun/star/inspection/XPropertyControlFactory.idl +++ b/offapi/com/sun/star/inspection/XPropertyControlFactory.idl @@ -43,13 +43,13 @@ interface XPropertyControlFactory @param CreateReadOnly 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 + <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 LineDescriptor::PrimaryButton.</p> <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> + attribute is `TRUE`, in which case all created property controls must be readonly.</p> @returns a control of the given type. diff --git a/offapi/com/sun/star/inspection/XPropertyHandler.idl b/offapi/com/sun/star/inspection/XPropertyHandler.idl index bd1a0d0ab36b..a1dddb1a27d0 100644 --- a/offapi/com/sun/star/inspection/XPropertyHandler.idl +++ b/offapi/com/sun/star/inspection/XPropertyHandler.idl @@ -59,9 +59,9 @@ interface XPropertyHandler /** binds the property handler to a new component @param Component - the component to inspect. Must not be <NULL/> + the component to inspect. Must not be `NULL` @throws com::sun::star::lang::NullPointerException - if the component is <NULL/> + if the component is `NULL` */ void inspect( [in] com::sun::star::uno::XInterface Component ) raises( com::sun::star::lang::NullPointerException ); @@ -106,13 +106,13 @@ interface XPropertyHandler the name of the property whose user interface is to be described implementation @param ControlFactory - a factory for creating XPropertyControl 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 if the given property is not supported by this handler @throws com::sun::star::lang::NullPointerException - if ControlFactory is <NULL/>. + if ControlFactory is `NULL`. @see PropertyControlType @see LineDescriptor */ @@ -215,7 +215,7 @@ interface XPropertyHandler @param Listener the listener to notify about property changes @throws com::sun::star::lang::NullPointerException - if the listener is <NULL/> + if the listener is `NULL` @see removePropertyChangeListener */ void @@ -340,7 +340,7 @@ interface XPropertyHandler The name of the property whose browse button has been clicked @param Primary - <TRUE/> if and only if the primary button has been clicked, <FALSE/> otherwise + `TRUE` if and only if the primary button has been clicked, `FALSE` otherwise @param out_Data If the method returns InteractiveSelectionResult::ObtainedValue, @@ -359,7 +359,7 @@ interface XPropertyHandler @throws com::sun::star::beans::UnknownPropertyException if the given property is not supported by the property handler @throws com::sun::star::lang::NullPointerException - if InspectorUI is <NULL/> + if InspectorUI is `NULL` @see describePropertyLine @see addPropertyChangeListener @@ -388,17 +388,17 @@ interface XPropertyHandler @param InspectorUI a callback for updating the object inspector UI @param FirstTimeInit - If <TRUE/>, the method is called for the first-time update of the respective property, that + If `TRUE`, the method is called for the first-time update of the respective property, that is, when the property browser is just initializing with the properties of the introspected object.<br/> - If <FALSE/>, there was a real com::sun::star::beans::XPropertyChangeListener::propertyChange() + If `FALSE`, there was a real com::sun::star::beans::XPropertyChangeListener::propertyChange() event which triggered the call.<br/> <br/> In some cases it may be necessary to differentiate between both situations. For instance, if you want to set the value of another property when an actuating property's value changed, - you should definitely not do this when FirstTimeInit is <TRUE/>. + you should definitely not do this when FirstTimeInit is `TRUE`. @throws com::sun::star::lang::NullPointerException - if InspectorUI is <NULL/> + if InspectorUI is `NULL` */ void actuatingPropertyChanged( @@ -427,12 +427,12 @@ interface XPropertyHandler by the handler should have been closed when it returns from the suspend() call.</p> @param Suspend - Whether the handler is to be suspended <TRUE/> or reactivated (<FALSE/>). The + Whether the handler is to be suspended `TRUE` or reactivated (`FALSE`). The latter happens if a handler was successfully suspended, but an external instance vetoed the whole suspension process. @return - <TRUE/> if the handler does allow suspension, <FALSE/> if it vetoes it. + `TRUE` if the handler does allow suspension, `FALSE` if it vetoes it. */ boolean suspend( [in] boolean Suspend ); }; diff --git a/offapi/com/sun/star/linguistic2/XConversionDictionary.idl b/offapi/com/sun/star/linguistic2/XConversionDictionary.idl index 6c9890dcbccc..6951fdd2b6fd 100644 --- a/offapi/com/sun/star/linguistic2/XConversionDictionary.idl +++ b/offapi/com/sun/star/linguistic2/XConversionDictionary.idl @@ -76,14 +76,14 @@ published interface XConversionDictionary : com::sun::star::uno::XInterface /** specifies whether the dictionary should be used or not . @param bAcvtivate - <TRUE/> if the dictionary should be used, <FALSE/> otherwise. + `TRUE` if the dictionary should be used, `FALSE` otherwise. */ void setActive( [in] boolean bActivate ); /** @returns - <TRUE/> if the dictionary is active, <FALSE/> otherwise. + `TRUE` if the dictionary is active, `FALSE` otherwise. */ boolean isActive(); diff --git a/offapi/com/sun/star/linguistic2/XConversionDictionaryList.idl b/offapi/com/sun/star/linguistic2/XConversionDictionaryList.idl index 330c122faccd..541734c417db 100644 --- a/offapi/com/sun/star/linguistic2/XConversionDictionaryList.idl +++ b/offapi/com/sun/star/linguistic2/XConversionDictionaryList.idl @@ -70,7 +70,7 @@ published interface XConversionDictionaryList : com::sun::star::uno::XInterface @returns an empty dictionary with the given name, locale and conversion type. - <NULL/> on failure. + `NULL` on failure. @param aName is the name of the dictionary (should be unique). diff --git a/offapi/com/sun/star/linguistic2/XDictionary.idl b/offapi/com/sun/star/linguistic2/XDictionary.idl index 7d95abb84509..f70ed85cea5a 100644 --- a/offapi/com/sun/star/linguistic2/XDictionary.idl +++ b/offapi/com/sun/star/linguistic2/XDictionary.idl @@ -60,14 +60,14 @@ published interface XDictionary : com::sun::star::container::XNamed /** specifies whether the dictionary should be used or not . @param bAcvtivate - <TRUE/> if the dictionary should be used, <FALSE/> otherwise. + `TRUE` if the dictionary should be used, `FALSE` otherwise. */ void setActive( [in] boolean bActivate ); /** @returns - <TRUE/> if the dictionary is active, <FALSE/> otherwise. + `TRUE` if the dictionary is active, `FALSE` otherwise. */ boolean isActive(); @@ -110,7 +110,7 @@ published interface XDictionary : com::sun::star::container::XNamed /** is used to add an entry to the dictionary. <P>If an entry already exists, the dictionary remains unchanged - and <FALSE/> will be returned.</P> + and `FALSE` will be returned.</P> <P>In positive dictionaries only positive entries can be made, and in negative ones only negative entries.</P> @@ -119,7 +119,7 @@ published interface XDictionary : com::sun::star::container::XNamed the entry to be added. @returns - <TRUE/> if the entry was successfully added <FALSE/> otherwise. + `TRUE` if the entry was successfully added `FALSE` otherwise. @see com::sun::star::linguistic2::XDictionaryEntry @see com::sun::star::linguistic2::DictionaryType @@ -130,7 +130,7 @@ published interface XDictionary : com::sun::star::container::XNamed /** is used to make an entry in the dictionary. <P>If an entry already exists, the dictionary remains unchanged - and <FALSE/> will be returned.</P> + and `FALSE` will be returned.</P> <P>In positive dictionaries only positive entries can be made, and in negative ones only negative entries.</P> @@ -146,7 +146,7 @@ published interface XDictionary : com::sun::star::container::XNamed be used when replacing aWord. Otherwise, it is undefined. @returns - <TRUE/> if the entry was successfully added, <FALSE/> otherwise. + `TRUE` if the entry was successfully added, `FALSE` otherwise. @see com::sun::star::linguistic2::DictionaryType */ @@ -161,15 +161,15 @@ published interface XDictionary : com::sun::star::container::XNamed the word matching the entry to be removed. @returns - <TRUE/> if the entry was successfully removed, <FALSE/> + `TRUE` if the entry was successfully removed, `FALSE` otherwise (especially if the entry was not found). */ boolean remove( [in] string aWord ); /** @returns - <TRUE/> if the dictionary is full and no further - entry can be made, <FALSE/> otherwise. + `TRUE` if the dictionary is full and no further + entry can be made, `FALSE` otherwise. */ boolean isFull(); @@ -201,7 +201,7 @@ published interface XDictionary : com::sun::star::container::XNamed the entry to be made, that is, the object that wants notifications. @returns - <TRUE/> if the entry was successfully made, <FALSE/> otherwise. + `TRUE` if the entry was successfully made, `FALSE` otherwise. If com::sun::star::lang::XEventListener::disposing() was called before, it will always fail. @@ -217,8 +217,8 @@ published interface XDictionary : com::sun::star::container::XNamed the reference to the listening object to be removed. @returns - <TRUE/> if the object to be removed was found and removed, - <FALSE/> if the object was not found in the list. + `TRUE` if the object to be removed was found and removed, + `FALSE` if the object was not found in the list. @see com::sun::star::linguistic2::XDictionary::addDictionaryEventListener() @see com::sun::star::linguistic2::XDictionaryEventListener diff --git a/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl b/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl index 475b773101c7..0dc4d73a1605 100644 --- a/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl +++ b/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl @@ -55,8 +55,8 @@ published interface XDictionaryEntry : com::sun::star::uno::XInterface /** @returns - <TRUE/> if the word (entry) is a negative one and should not be - used, <FALSE/> otherwise. + `TRUE` if the word (entry) is a negative one and should not be + used, `FALSE` otherwise. */ boolean isNegative(); diff --git a/offapi/com/sun/star/linguistic2/XDictionaryList.idl b/offapi/com/sun/star/linguistic2/XDictionaryList.idl index 6d0ff70f82a5..63ec6a0ae0de 100644 --- a/offapi/com/sun/star/linguistic2/XDictionaryList.idl +++ b/offapi/com/sun/star/linguistic2/XDictionaryList.idl @@ -57,7 +57,7 @@ published interface XDictionaryList : com::sun::star::uno::XInterface @returns the XDictionary with the specified name. If no such - dictionary exists, <NULL/> will be returned. + dictionary exists, `NULL` will be returned. @param aDictionaryName specifies the name of the dictionary to look for. @@ -73,8 +73,8 @@ published interface XDictionaryList : com::sun::star::uno::XInterface event listeners of that dictionary.</P> @returns - <TRUE/> if the dictionary was added successfully, - <FALSE/> otherwise. + `TRUE` if the dictionary was added successfully, + `FALSE` otherwise. @param xDictionary the dictionary to be added. @@ -91,7 +91,7 @@ published interface XDictionaryList : com::sun::star::uno::XInterface dictionary event listeners of the dictionary.</P> @returns - <TRUE/> if the dictionary was removed successfully, <FALSE/> + `TRUE` if the dictionary was removed successfully, `FALSE` otherwise. @param xDictionary @@ -109,7 +109,7 @@ published interface XDictionaryList : com::sun::star::uno::XInterface com::sun::star::linguistic2::XDictionaryListEventListener::processDictionaryListEvent().</P> @returns - <TRUE/> if the entry was made, <FALSE/> otherwise. + `TRUE` if the entry was made, `FALSE` otherwise. If com::sun::star::lang::XEventListener::disposing() was called before, it will always fail. @@ -117,7 +117,7 @@ published interface XDictionaryList : com::sun::star::uno::XInterface the object to be notified of dictionary-list events. @param bReceiveVerbose - <TRUE/> if the listener requires more detailed event + `TRUE` if the listener requires more detailed event notification than usual. @see com::sun::star::linguistic2::XDictionaryListEventListener @@ -130,8 +130,8 @@ published interface XDictionaryList : com::sun::star::uno::XInterface /** removes an entry from the list of dictionary-list event listeners. @returns - <TRUE/> if the object to be removed was found and removed, - <FALSE/> otherwise. + `TRUE` if the object to be removed was found and removed, + `FALSE` otherwise. @param xListener the object to be removed from the listener list. @@ -194,7 +194,7 @@ published interface XDictionaryList : com::sun::star::uno::XInterface @returns an empty dictionary with the given name, language and type. - <NULL/> on failure. + `NULL` on failure. @param aName is the name of the dictionary (should be unique). diff --git a/offapi/com/sun/star/linguistic2/XHyphenatedWord.idl b/offapi/com/sun/star/linguistic2/XHyphenatedWord.idl index 39c679452d62..0b03b11c57c0 100644 --- a/offapi/com/sun/star/linguistic2/XHyphenatedWord.idl +++ b/offapi/com/sun/star/linguistic2/XHyphenatedWord.idl @@ -82,7 +82,7 @@ published interface XHyphenatedWord : com::sun::star::uno::XInterface word is different from the word that was hyphenated.</p> @returns - <TRUE/> if it is an alternative spelling, <FALSE/> otherwise. + `TRUE` if it is an alternative spelling, `FALSE` otherwise. */ boolean isAlternativeSpelling(); diff --git a/offapi/com/sun/star/linguistic2/XHyphenator.idl b/offapi/com/sun/star/linguistic2/XHyphenator.idl index f07b5faa2aaa..96d095f77dc7 100644 --- a/offapi/com/sun/star/linguistic2/XHyphenator.idl +++ b/offapi/com/sun/star/linguistic2/XHyphenator.idl @@ -61,7 +61,7 @@ published interface XHyphenator : com::sun::star::linguistic2::XSupportedLocales @returns the XHyphenatedWord for the last valid hyphenation position that is less than or equal to nMaxLeading - 1. - If there is no such valid hyphenation position, <NULL/> is returned. + If there is no such valid hyphenation position, `NULL` is returned. @param aWord is the word to be hyphenated. @@ -107,7 +107,7 @@ published interface XHyphenator : com::sun::star::linguistic2::XSupportedLocales @returns the information about the alternative spelling found at the specified position. Otherwise, if no alternative spelling was - found, <NULL/> is returned. + found, `NULL` is returned. @param aWord is the original word to be looked at for having an alternative @@ -145,7 +145,7 @@ published interface XHyphenator : com::sun::star::linguistic2::XSupportedLocales @returns an com::sun::star::linguistic2::XPossibleHyphens for the given word and language if there are any hyphenation - positions. <NULL/> otherwise. + positions. `NULL` otherwise. @param aWord is the word for which information about the possible diff --git a/offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl b/offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl index c48b550278bf..9a5af31f1b0b 100644 --- a/offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl +++ b/offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl @@ -46,8 +46,8 @@ published interface XLinguServiceEventBroadcaster : com::sun::star::uno::XInterf { /** @returns - <TRUE/> if the listener was successfully added, - <FALSE/> otherwise. + `TRUE` if the listener was successfully added, + `FALSE` otherwise. @param xLstnr the listener to be added. @@ -57,8 +57,8 @@ published interface XLinguServiceEventBroadcaster : com::sun::star::uno::XInterf /** @returns - <TRUE/> if the listener was successfully removed, - <FALSE/> otherwise. + `TRUE` if the listener was successfully removed, + `FALSE` otherwise. @param xLstnr the listener to be removed. diff --git a/offapi/com/sun/star/linguistic2/XLinguServiceManager.idl b/offapi/com/sun/star/linguistic2/XLinguServiceManager.idl index 63c330384980..55faa12a9bb2 100644 --- a/offapi/com/sun/star/linguistic2/XLinguServiceManager.idl +++ b/offapi/com/sun/star/linguistic2/XLinguServiceManager.idl @@ -88,7 +88,7 @@ published interface XLinguServiceManager : com::sun::star::uno::XInterface </P> @returns - <TRUE/> if the listener was successfully added, <FALSE/> otherwise. + `TRUE` if the listener was successfully added, `FALSE` otherwise. @param xListener the listener to be added. @@ -99,7 +99,7 @@ published interface XLinguServiceManager : com::sun::star::uno::XInterface /** removes a listener from the list of event listeners. @returns - <TRUE/> if the listener was successfully removed, <FALSE/> otherwise. + `TRUE` if the listener was successfully removed, `FALSE` otherwise. @param xListener the listener to be removed. diff --git a/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl b/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl index 54d5dbbc60e7..dd68e618754f 100644 --- a/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl +++ b/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl @@ -43,7 +43,7 @@ published interface XSearchableDictionaryList : com::sun::star::linguistic2::XDi /** looks for an entry for a given word in the list of dictionaries. @returns - the dictionary entry that was found, <NULL/> otherwise. + the dictionary entry that was found, `NULL` otherwise. @param aWord the word (entry) to be looked for. @@ -52,12 +52,12 @@ published interface XSearchableDictionaryList : com::sun::star::linguistic2::XDi the language of the word to be looked for. @param bSearchPosDic - <TRUE/> if only positive dictionaries should be searched. - <FALSE/> if only negative dictionaries should be searched. + `TRUE` if only positive dictionaries should be searched. + `FALSE` if only negative dictionaries should be searched. @param bSpellEntry - <TRUE/> if entries for purposes of spell checking are required. - <FALSE/> if only entries for hyphenation purposes are required. + `TRUE` if entries for purposes of spell checking are required. + `FALSE` if only entries for hyphenation purposes are required. */ com::sun::star::linguistic2::XDictionaryEntry queryDictionaryEntry( [in] string aWord , diff --git a/offapi/com/sun/star/linguistic2/XSpellChecker.idl b/offapi/com/sun/star/linguistic2/XSpellChecker.idl index 0c6e9d3a7eed..8fb1525a7b23 100644 --- a/offapi/com/sun/star/linguistic2/XSpellChecker.idl +++ b/offapi/com/sun/star/linguistic2/XSpellChecker.idl @@ -41,8 +41,8 @@ published interface XSpellChecker : com::sun::star::linguistic2::XSupportedLocal /** checks if a word is spelled correctly in a given language. @returns - <TRUE/> if the word is spelled correctly using - the specified language, <FALSE/> otherwise. + `TRUE` if the word is spelled correctly using + the specified language, `FALSE` otherwise. @param aWord the word to be checked. @@ -72,7 +72,7 @@ published interface XSpellChecker : com::sun::star::linguistic2::XSupportedLocal language. @returns - <NULL/> if <var>aWord</var> is spelled correctly using + `NULL` if <var>aWord</var> is spelled correctly using <var>aLocale</var>. Otherwise, an XSpellAlternatives object with information about the reason of failure and, if available, proposals for spelling alternatives will be returned. diff --git a/offapi/com/sun/star/linguistic2/XSupportedLocales.idl b/offapi/com/sun/star/linguistic2/XSupportedLocales.idl index 453ef2309489..025b5b449687 100644 --- a/offapi/com/sun/star/linguistic2/XSupportedLocales.idl +++ b/offapi/com/sun/star/linguistic2/XSupportedLocales.idl @@ -53,7 +53,7 @@ published interface XSupportedLocales : com::sun::star::uno::XInterface by the object. @returns - <TRUE/> if the language is supported, otherwise <FALSE/>. + `TRUE` if the language is supported, otherwise `FALSE`. */ boolean hasLocale( [in] com::sun::star::lang::Locale aLocale ); }; diff --git a/offapi/com/sun/star/logging/XLogHandler.idl b/offapi/com/sun/star/logging/XLogHandler.idl index 2a93d1bca923..cdb770c3b96d 100644 --- a/offapi/com/sun/star/logging/XLogHandler.idl +++ b/offapi/com/sun/star/logging/XLogHandler.idl @@ -75,7 +75,7 @@ interface XLogHandler /** publish the given log record at the handler's output channel. @return - <TRUE/> if and only if the record was actually published. A handler + `TRUE` if and only if the record was actually published. A handler will not publish a record if its log level doesn't meet the handler's log level, if the record is filtered, or if any other handler-specified restrictions apply. diff --git a/offapi/com/sun/star/logging/XLogger.idl b/offapi/com/sun/star/logging/XLogger.idl index fd35b0adea77..ea2912d8672d 100644 --- a/offapi/com/sun/star/logging/XLogger.idl +++ b/offapi/com/sun/star/logging/XLogger.idl @@ -67,7 +67,7 @@ interface XLogger @param LogHandler the handler to add to the list of handlers. The call is ignored if this - parameter is <NULL/>. + parameter is `NULL`. */ void addLogHandler( [in] XLogHandler LogHandler ); @@ -75,7 +75,7 @@ interface XLogger @param LogHandler the handler to remove from the list of handlers. The call is ignored if this - parameter is <NULL/>, or if the handler has not previously been added. + parameter is `NULL`, or if the handler has not previously been added. */ void removeLogHandler( [in] XLogHandler LogHandler ); @@ -88,8 +88,8 @@ interface XLogger level to be checked against @returns - <TRUE/> if there would be some output for this XLogger for the given level, <FALSE/> - otherwise. Note that a return value of <FALSE/> could also indicate that the logger + `TRUE` if there would be some output for this XLogger for the given level, `FALSE` + otherwise. Note that a return value of `FALSE` could also indicate that the logger does not have any log handlers associated with it. @see addLogHandler diff --git a/offapi/com/sun/star/mail/XMailService.idl b/offapi/com/sun/star/mail/XMailService.idl index efedf9f3c0ef..c56c791650e1 100644 --- a/offapi/com/sun/star/mail/XMailService.idl +++ b/offapi/com/sun/star/mail/XMailService.idl @@ -191,7 +191,7 @@ interface XMailService: ::com::sun::star::uno::XInterface { currently exist or not. @returns - <TRUE/> if a connection to a mail service is established. + `TRUE` if a connection to a mail service is established. */ boolean isConnected(); }; diff --git a/offapi/com/sun/star/media/XPlayer.idl b/offapi/com/sun/star/media/XPlayer.idl index f93b1d276b12..1fb48fe94028 100644 --- a/offapi/com/sun/star/media/XPlayer.idl +++ b/offapi/com/sun/star/media/XPlayer.idl @@ -42,7 +42,7 @@ interface XPlayer /** indicates whether the stream is played or not. @returns - <TRUE/> if the stream is played, <FALSE/> otherwise + `TRUE` if the stream is played, `FALSE` otherwise */ boolean isPlaying(); @@ -80,7 +80,7 @@ interface XPlayer start after the end of the stream. @param bSet - loops if set to <TRUE/>, otherwise stops at the end of the + loops if set to `TRUE`, otherwise stops at the end of the stream. */ void setPlaybackLoop( [in] boolean bSet ); @@ -89,7 +89,7 @@ interface XPlayer end of the stream. @returns - <TRUE/> if the stream will loop, <FALSE/> otherwise. + `TRUE` if the stream will loop, `FALSE` otherwise. */ boolean isPlaybackLoop(); @@ -110,8 +110,8 @@ interface XPlayer /** sets the volume to <code>0</code> or to its previous value. @param bSet - sets the volume to <code>0</code> if <TRUE/>, and switch - to the previous non-null value if <FALSE/> + sets the volume to <code>0</code> if `TRUE`, and switch + to the previous non-null value if `FALSE` */ void setMute( [in] boolean bSet ); @@ -119,8 +119,8 @@ interface XPlayer or not. @returns - <TRUE/> if the volume is temporarily set to <code>0</code>, - <FALSE/> otherwise. + `TRUE` if the volume is temporarily set to <code>0</code>, + `FALSE` otherwise. */ boolean isMute(); diff --git a/offapi/com/sun/star/presentation/Presentation.idl b/offapi/com/sun/star/presentation/Presentation.idl index 7bfba46e6367..fbff66501aac 100644 --- a/offapi/com/sun/star/presentation/Presentation.idl +++ b/offapi/com/sun/star/presentation/Presentation.idl @@ -65,26 +65,26 @@ published service Presentation [property] string FirstPage; - /** If this property is set to <TRUE/>, the window of the presentation is + /** If this property is set to `TRUE`, the window of the presentation is always on top of all other windows. */ [property] boolean IsAlwaysOnTop; - /** If this property is <TRUE/>, all pages are changed automatically. + /** If this property is `TRUE`, all pages are changed automatically. <p>This overrides the properties of the pages.</p> */ [property] boolean IsAutomatic; - /** If this property is set to <TRUE/>, the presentation is repeated + /** If this property is set to `TRUE`, the presentation is repeated endlessly. */ [property] boolean IsEndless; - /** If this property is set to <TRUE/>, the presentation runs in + /** If this property is set to `TRUE`, the presentation runs in full-screen mode. */ [property] boolean IsFullScreen; @@ -97,7 +97,7 @@ published service Presentation [property] boolean IsLivePresentation; - /** If this property is <TRUE/>, the mouse is visible during the + /** If this property is `TRUE`, the mouse is visible during the presentation. */ [property] boolean IsMouseVisible; @@ -111,13 +111,13 @@ published service Presentation [property] long Pause; - /** If this is set to <TRUE/>, the Navigator is opened at the start of the + /** If this is set to `TRUE`, the Navigator is opened at the start of the presentation. */ [property] boolean StartWithNavigator; - /** If this is <TRUE/>, a pen is shown during presentation. + /** If this is `TRUE`, a pen is shown during presentation. <p>You can draw on the presentation with this pen.</p> */ diff --git a/offapi/com/sun/star/presentation/Shape.idl b/offapi/com/sun/star/presentation/Shape.idl index 1cb6f2b8d411..9b2a63409968 100644 --- a/offapi/com/sun/star/presentation/Shape.idl +++ b/offapi/com/sun/star/presentation/Shape.idl @@ -48,18 +48,18 @@ published service Shape /** This is the color for dimming this shape. <p>This color is used if the property com::sun::star::drawing::Shape::DimPrev - is <TRUE/> and com::sun::star::drawing::Shape::DimHide is <FALSE/>.</p> + is `TRUE` and com::sun::star::drawing::Shape::DimHide is `FALSE`.</p> */ [property] com::sun::star::util::Color DimColor; /** If this property and the property com::sun::star::drawing::Shape::DimPrev - are both <TRUE/>, the shape is hidden instead of dimmed to a color. + are both `TRUE`, the shape is hidden instead of dimmed to a color. */ [property] boolean DimHide; - /** If this property is <TRUE/>, this shape is dimmed to the color of + /** If this property is `TRUE`, this shape is dimmed to the color of property com::sun::star::drawing::Shape::DimColor after executing its animation effect. */ @@ -72,12 +72,12 @@ published service Shape /** If this is a default presentation object and if it is empty, - this property is <TRUE/>. + this property is `TRUE`. */ [property] boolean IsEmptyPresentationObject; - /** If this is a presentation object, this property is <TRUE/>. + /** If this is a presentation object, this property is `TRUE`. <p>Presentation objects are objects like TitleTextShape and OutlinerShape.</p> */ @@ -90,7 +90,7 @@ published service Shape [property] com::sun::star::presentation::ClickAction OnClick; - /** If this property is <TRUE/>, the sound of this shape is played in + /** If this property is `TRUE`, the sound of this shape is played in full. <p>The default behavior is to stop the sound after completing the @@ -116,7 +116,7 @@ published service Shape [property] string Sound; - /** If this property is set to <TRUE/>, a sound is played while the + /** If this property is set to `TRUE`, a sound is played while the animation effect is executed. */ [property] boolean SoundOn; diff --git a/offapi/com/sun/star/presentation/XSlideShow.idl b/offapi/com/sun/star/presentation/XSlideShow.idl index da8a12c73e4f..e17bbbdcb287 100644 --- a/offapi/com/sun/star/presentation/XSlideShow.idl +++ b/offapi/com/sun/star/presentation/XSlideShow.idl @@ -74,8 +74,8 @@ interface XSlideShow : ::com::sun::star::uno::XInterface If there is currently no slide show running, this method does nothing.<p> - @return <TRUE/>, if the previous effect was successfully - triggered. This method returns <FALSE/>, if there is no show + @return `TRUE`, if the previous effect was successfully + triggered. This method returns `FALSE`, if there is no show running, the first effect on the first slide was not yet triggered, or the implementation failed to trigger the previous effect. @@ -138,20 +138,20 @@ interface XSlideShow : ::com::sun::star::uno::XInterface improvements </li> <li>name: SkipAllMainSequenceEffects, value: boolean. - When <TRUE/> then all main sequence effects on the new slide + When `TRUE` then all main sequence effects on the new slide are triggered. This is typically used when going back one effect leads to the previous slide. On that slide all effects have to be shown in order to continue the backward traveling. - When <FALSE/>, the default, then no main sequence effect is + When `FALSE`, the default, then no main sequence effect is triggered. </li> <li>name: SkipSlideTransition, value: boolean. - When <TRUE/> then the slide transition animation, if there + When `TRUE` then the slide transition animation, if there is any, is not displayed. This is typically used when going back one effect leads to the previous slide. Typically used - together with SkipAllMainSequenceEffects also being <TRUE/>. - When <FALSE/>, the default, then the slide transition + together with SkipAllMainSequenceEffects also being `TRUE`. + When `FALSE`, the default, then the slide transition effect, if it exists, is played. </li> </ul> diff --git a/offapi/com/sun/star/presentation/XSlideShowController.idl b/offapi/com/sun/star/presentation/XSlideShowController.idl index d0251c805143..a5c619c301fd 100644 --- a/offapi/com/sun/star/presentation/XSlideShowController.idl +++ b/offapi/com/sun/star/presentation/XSlideShowController.idl @@ -153,7 +153,7 @@ interface XSlideShowController void resume(); - /** returns <TRUE/> if the slide show is currently paused. + /** returns `TRUE` if the slide show is currently paused. @see pause() @see resume() @@ -187,9 +187,9 @@ interface XSlideShowController /** determines if the slide show is active. @return - <TRUE/> for UI active slide show + `TRUE` for UI active slide show <br> - <FALSE/> otherwise + `FALSE` otherwise */ boolean isActive(); @@ -206,29 +206,29 @@ interface XSlideShowController long getNextSlideIndex(); - /** returns <TRUE/> if the slide show was started to run endlessly. + /** returns `TRUE` if the slide show was started to run endlessly. */ boolean isEndless(); - /** Returns <TRUE/> if the slide show was started in full-screen mode. + /** Returns `TRUE` if the slide show was started in full-screen mode. */ boolean isFullScreen(); - /** If this attribute is set to <TRUE/>, the window of the slide show is + /** If this attribute is set to `TRUE`, the window of the slide show is always on top of all other windows. */ [attribute] boolean AlwaysOnTop; - /** If this attribute is <TRUE/>, the mouse is visible during the + /** If this attribute is `TRUE`, the mouse is visible during the slide show. */ [attribute] boolean MouseVisible; - /** If this is <TRUE/>, a pen is shown during presentation. + /** If this is `TRUE`, a pen is shown during presentation. <p>You can draw on the presentation with this pen.</p> */ diff --git a/offapi/com/sun/star/presentation/XSlideShowListener.idl b/offapi/com/sun/star/presentation/XSlideShowListener.idl index 6efa4eca518a..9a4d5656877c 100644 --- a/offapi/com/sun/star/presentation/XSlideShowListener.idl +++ b/offapi/com/sun/star/presentation/XSlideShowListener.idl @@ -52,9 +52,9 @@ interface XSlideShowListener : ::com::sun::star::animations::XAnimationListener e.g. the user has clicked on the slide. Calling displaySlide() twice will not issue this event. @param reverse - For the default order (forward) this flag is <FALSE/>. + For the default order (forward) this flag is `FALSE`. When the main sequence was traversed in reverse order then this - flag is <TRUE/>. + flag is `TRUE`. */ void slideEnded( [in] boolean reverse ); diff --git a/offapi/com/sun/star/rdf/Statement.idl b/offapi/com/sun/star/rdf/Statement.idl index a8fb5a04c0e0..5f6852cfc0a5 100644 --- a/offapi/com/sun/star/rdf/Statement.idl +++ b/offapi/com/sun/star/rdf/Statement.idl @@ -40,7 +40,7 @@ struct Statement XURI Predicate; /// the object of the RDF statement. XNode Object; - /// the named graph that contains this statement, or <NULL/>. + /// the named graph that contains this statement, or `NULL`. XURI Graph; }; diff --git a/offapi/com/sun/star/rdf/XDocumentMetadataAccess.idl b/offapi/com/sun/star/rdf/XDocumentMetadataAccess.idl index 6322300b7027..c076b0d543f3 100644 --- a/offapi/com/sun/star/rdf/XDocumentMetadataAccess.idl +++ b/offapi/com/sun/star/rdf/XDocumentMetadataAccess.idl @@ -72,7 +72,7 @@ interface XDocumentMetadataAccess @returns the ODF element with the given metadata references if it exists, - else <NULL/> + else `NULL` */ XMetadatable getElementByMetadataReference( [in] com::sun::star::beans::StringPair MetadataReference); @@ -83,10 +83,10 @@ interface XDocumentMetadataAccess an URI that may identify an ODF element @returns - the ODF element that corresponds to the given URI, or <NULL/> + the ODF element that corresponds to the given URI, or `NULL` @throws com::sun::star::lang::IllegalArgumentException - if the given URI is <NULL/> + if the given URI is `NULL` */ XMetadatable getElementByURI([in] XURI URI) raises( com::sun::star::lang::IllegalArgumentException ); @@ -101,7 +101,7 @@ interface XDocumentMetadataAccess property with the given Type as object @throws com::sun::star::lang::IllegalArgumentException - if the given Type is <NULL/> + if the given Type is `NULL` */ sequence<XURI> getMetadataGraphsWithType([in] XURI Type) raises( com::sun::star::lang::IllegalArgumentException ); @@ -169,8 +169,8 @@ interface XDocumentMetadataAccess the name of the new graph @throws com::sun::star::lang::IllegalArgumentException - if the given stream is <NULL/>, - or BaseURI is <NULL/> and the format requires use of a base URI, + if the given stream is `NULL`, + or BaseURI is `NULL` and the format requires use of a base URI, or the FileName is invalid @throws com::sun::star::datatransfer::UnsupportedFlavorException @@ -210,7 +210,7 @@ interface XDocumentMetadataAccess the name of the graph that is to be removed @throws com::sun::star::lang::IllegalArgumentException - if the given GraphName is <NULL/> + if the given GraphName is `NULL` @throws com::sun::star::container::NoSuchElementException if a graph with the given GraphName does not exist @@ -298,7 +298,7 @@ interface XDocumentMetadataAccess an InteractionHandler, used for error reporting @throws com::sun::star::lang::IllegalArgumentException - if any argument is <NULL/> + if any argument is `NULL` @throws com::sun::star::lang::WrappedTargetException if an error occurs while loading and no InteractionHandler given @@ -326,7 +326,7 @@ interface XDocumentMetadataAccess a storage, representing e.g. an ODF package file, or sub-document @throws com::sun::star::lang::IllegalArgumentException - if Storage argument is <NULL/> + if Storage argument is `NULL` @throws com::sun::star::lang::WrappedTargetException if an error occurs while loading diff --git a/offapi/com/sun/star/rdf/XDocumentRepository.idl b/offapi/com/sun/star/rdf/XDocumentRepository.idl index 9e056048db4f..039e376994f5 100644 --- a/offapi/com/sun/star/rdf/XDocumentRepository.idl +++ b/offapi/com/sun/star/rdf/XDocumentRepository.idl @@ -98,10 +98,10 @@ interface XDocumentRepository : XRepository `string`). @param RDFaDatatype - the <code>rdfa:datatype</code> attribute (may be <NULL/>) + the <code>rdfa:datatype</code> attribute (may be `NULL`) @throws com::sun::star::lang::IllegalArgumentException - if any parameter is <NULL/>, Predicates is empty, + if any parameter is `NULL`, Predicates is empty, or Object is of a type that can not have RDFa metadata attached. @throws RepositoryException @@ -128,7 +128,7 @@ interface XDocumentRepository : XRepository the element whose RDFa statement(s) should be removed @throws com::sun::star::lang::IllegalArgumentException - if the given Element is <NULL/>, or of a type that can not have + if the given Element is `NULL`, or of a type that can not have RDFa metadata attached. @throws RepositoryException @@ -158,7 +158,7 @@ interface XDocumentRepository : XRepository </ul> @throws com::sun::star::lang::IllegalArgumentException - if the given Element is <NULL/>, or of a type that can not have + if the given Element is `NULL`, or of a type that can not have RDFa metadata attached. @throws RepositoryException @@ -180,7 +180,7 @@ interface XDocumentRepository : XRepository </p> <p> - Any parameter may be <NULL/>, which acts as a wildcard. + Any parameter may be `NULL`, which acts as a wildcard. For example, to get all statements about myURI: <code>getStatementsRDFa(myURI, null, null)</code> </p> diff --git a/offapi/com/sun/star/rdf/XLiteral.idl b/offapi/com/sun/star/rdf/XLiteral.idl index 4233291e2d36..de67596b35d1 100644 --- a/offapi/com/sun/star/rdf/XLiteral.idl +++ b/offapi/com/sun/star/rdf/XLiteral.idl @@ -48,7 +48,7 @@ interface XLiteral : XNode [readonly, attribute] string Value; /// the language of the literal; may be the empty `string` [readonly, attribute] string Language; - /// the data type of the literal; may be <NULL/> + /// the data type of the literal; may be `NULL` [readonly, attribute] XURI Datatype; //FIXME: TODO: have not looked at handling all kinds of types, maybe just have an any attr here... }; diff --git a/offapi/com/sun/star/rdf/XNamedGraph.idl b/offapi/com/sun/star/rdf/XNamedGraph.idl index 899829215515..3de01b4763b9 100644 --- a/offapi/com/sun/star/rdf/XNamedGraph.idl +++ b/offapi/com/sun/star/rdf/XNamedGraph.idl @@ -95,7 +95,7 @@ interface XNamedGraph : XURI the object of the RDF triple. @throws com::sun::star::lang::IllegalArgumentException - if any parameter is <NULL/> + if any parameter is `NULL` @throws com::sun::star::container::NoSuchElementException if this graph does not exist in the repository any more @@ -120,7 +120,7 @@ interface XNamedGraph : XURI </p> <p> - Any parameter may be <NULL/>, which acts as a wildcard. + Any parameter may be `NULL`, which acts as a wildcard. For example, to remove all statements about myURI: <code>removeStatement(myURI, null, null)</code> </p> @@ -156,7 +156,7 @@ interface XNamedGraph : XURI </p> <p> - Any parameter may be <NULL/>, which acts as a wildcard. + Any parameter may be `NULL`, which acts as a wildcard. For example, to get all statements about myURI: <code>getStatements(myURI, null, null)</code> </p> diff --git a/offapi/com/sun/star/rdf/XRepository.idl b/offapi/com/sun/star/rdf/XRepository.idl index 5899461593e6..aacf57ded31c 100644 --- a/offapi/com/sun/star/rdf/XRepository.idl +++ b/offapi/com/sun/star/rdf/XRepository.idl @@ -108,8 +108,8 @@ interface XRepository the imported graph @throws com::sun::star::lang::IllegalArgumentException - if the given stream or the GraphName is <NULL/>, - or BaseURI is <NULL/> and the format requires use of a base URI + if the given stream or the GraphName is `NULL`, + or BaseURI is `NULL` and the format requires use of a base URI @throws com::sun::star::datatransfer::UnsupportedFlavorException if the format requested is unknown or not supported @@ -162,8 +162,8 @@ interface XRepository a base URI to resolve relative URI references @throws com::sun::star::lang::IllegalArgumentException - if the given stream or the GraphName is <NULL/>, - or BaseURI is <NULL/> and the format requires use of a base URI + if the given stream or the GraphName is `NULL`, + or BaseURI is `NULL` and the format requires use of a base URI @throws com::sun::star::datatransfer::UnsupportedFlavorException if the format requested is unknown or not supported @@ -205,7 +205,7 @@ interface XRepository the name of the graph that is to be returned @returns - the graph with the given name if it exists, else <NULL/> + the graph with the given name if it exists, else `NULL` @throws com::sun::star::lang::IllegalArgumentException if the given GraphName is invalid @@ -271,7 +271,7 @@ interface XRepository /** gets matching RDF statements from the repository. <p> - Any parameter may be <NULL/>, which acts as a wildcard. + Any parameter may be `NULL`, which acts as a wildcard. For example, to get all statements about myURI: <code>getStatements(myURI, null, null)</code> </p> @@ -309,7 +309,7 @@ interface XRepository This method runs a SPARQL query that returns a list of variable bindings, i.e., a query beginning with "SELECT". The result is basically a (rectangular) table with labeled columns, - where individual cells may be <NULL/>. + where individual cells may be `NULL`. </p> @param Query diff --git a/offapi/com/sun/star/rendering/IntegerBitmapLayout.idl b/offapi/com/sun/star/rendering/IntegerBitmapLayout.idl index f511b907312a..d1af5ae9cac4 100644 --- a/offapi/com/sun/star/rendering/IntegerBitmapLayout.idl +++ b/offapi/com/sun/star/rendering/IntegerBitmapLayout.idl @@ -95,15 +95,15 @@ struct IntegerBitmapLayout /** This member determines the bit order (only relevant if a pixel uses less than 8 bits, of course).<p> - When <TRUE/>, this member denotes that the leftmost pixel from + When `TRUE`, this member denotes that the leftmost pixel from an 8 bit amount of pixel data consists of the bits starting - with the most significant bit. When <FALSE/>, it's starting + with the most significant bit. When `FALSE`, it's starting with the least significant bit.<p> Example: for a 1bpp bitmap, each pixel is represented by - exactly one bit. If this member is <TRUE/>, the first pixel is + exactly one bit. If this member is `TRUE`, the first pixel is the MSB of the first byte, and the eighth pixel is the LSB of - the first byte. If this member is <FALSE/>, it's just the + the first byte. If this member is `FALSE`, it's just the opposite. */ boolean IsMsbFirst; diff --git a/offapi/com/sun/star/rendering/TextHit.idl b/offapi/com/sun/star/rendering/TextHit.idl index fbf44fb41aef..2b5591304a97 100644 --- a/offapi/com/sun/star/rendering/TextHit.idl +++ b/offapi/com/sun/star/rendering/TextHit.idl @@ -52,7 +52,7 @@ struct TextHit language (i.e. the leading edge of an Arabic glyph is the right half of it, whereas it is the left half of a Latin character). If the hit was on the leading edge, this member is - set to <TRUE/>. + set to `TRUE`. */ boolean IsLeadingEdge; }; diff --git a/offapi/com/sun/star/rendering/XBitmap.idl b/offapi/com/sun/star/rendering/XBitmap.idl index 1fe3e26ca9b8..ce6611bdc295 100644 --- a/offapi/com/sun/star/rendering/XBitmap.idl +++ b/offapi/com/sun/star/rendering/XBitmap.idl @@ -57,7 +57,7 @@ interface XBitmap : ::com::sun::star::uno::XInterface component flagged ColorComponentTag::ALPHA).<p> - @return <TRUE/>, if the bitmap has alpha data, or <FALSE/> if + @return `TRUE`, if the bitmap has alpha data, or `FALSE` if not. */ boolean hasAlpha(); diff --git a/offapi/com/sun/star/rendering/XBitmapPalette.idl b/offapi/com/sun/star/rendering/XBitmapPalette.idl index 365c138877e9..0f67a3500950 100644 --- a/offapi/com/sun/star/rendering/XBitmapPalette.idl +++ b/offapi/com/sun/star/rendering/XBitmapPalette.idl @@ -50,8 +50,8 @@ interface XBitmapPalette : ::com::sun::star::uno::XInterface The index of the palette entry to be retrieved. Valid range is [0,getNumberOfEntries()-1]. - @return <TRUE/>, if the given palette entry should be displayed - opaque, and <FALSE/> if the entry should be displayed + @return `TRUE`, if the given palette entry should be displayed + opaque, and `FALSE` if the entry should be displayed transparent. This is sometimes used for so-called mask transparency, by flagging certain palette entries to be fully transparent when displaying the bitmap. @@ -71,8 +71,8 @@ interface XBitmapPalette : ::com::sun::star::uno::XInterface device color format. @param transparency - When <TRUE/>, the specified palette entry is displayed as - opaque color. When <FALSE/>, the given entry displays as fully + When `TRUE`, the specified palette entry is displayed as + opaque color. When `FALSE`, the given entry displays as fully transparent during output. @param nIndex @@ -80,7 +80,7 @@ interface XBitmapPalette : ::com::sun::star::uno::XInterface [0,getNumberOfEntries()-1]. @return whether the palette entry was changed. For read-only - entries, this method always returns <FALSE/>. + entries, this method always returns `FALSE`. @throws com::sun::star::lang::IndexOutOfBoundsException if the index is smaller than zero or larger than diff --git a/offapi/com/sun/star/rendering/XBufferController.idl b/offapi/com/sun/star/rendering/XBufferController.idl index bb49143ee5c9..b9ddcf001c8e 100644 --- a/offapi/com/sun/star/rendering/XBufferController.idl +++ b/offapi/com/sun/star/rendering/XBufferController.idl @@ -70,7 +70,7 @@ interface XBufferController : ::com::sun::star::uno::XInterface with other things, e.g. sound playback.<p> @param bUpdateAll - When <TRUE/>, update the whole screen. When <FALSE/>, + When `TRUE`, update the whole screen. When `FALSE`, implementation is permitted to restrict update to areas the canvas itself changed (e.g. because of render operations, or changes on the sprites). The former is useful for updates @@ -102,7 +102,7 @@ interface XBufferController : ::com::sun::star::uno::XInterface other things, e.g. sound playback.<p> @param bUpdateAll - When <TRUE/>, update the whole screen. When <FALSE/>, + When `TRUE`, update the whole screen. When `FALSE`, implementation is permitted to restrict update to areas the canvas itself changed (e.g. because of render operations, or changes on the sprites). The former is useful for updates diff --git a/offapi/com/sun/star/rendering/XCanvas.idl b/offapi/com/sun/star/rendering/XCanvas.idl index 74121faa78e6..8206b2ba590d 100644 --- a/offapi/com/sun/star/rendering/XCanvas.idl +++ b/offapi/com/sun/star/rendering/XCanvas.idl @@ -472,10 +472,10 @@ interface XCanvas : ::com::sun::star::uno::XInterface 0 completely disables kerning. Whether kerning is on or off by default is font-dependent.</il> - <il>IsEmphasisMarks: a boolean, where <TRUE/> + <il>IsEmphasisMarks: a boolean, where `TRUE` enables automatic placements of emphasis marks, e.g. for Hebrew. The default value, if this property is not - specified, is <FALSE/>.</il> + specified, is `FALSE`.</il> <il>ExpandedSpacing: a double value which is added between all cell distances for this font. The default value for diff --git a/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl b/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl index 5d0c025c077b..32f966c82c24 100644 --- a/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl +++ b/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl @@ -69,7 +69,7 @@ interface XIntegerBitmapColorSpace : XColorSpace /** Query whether color data bytes need to be swapped.<p> - @return <TRUE/>, This method returns the endianness of the color + @return `TRUE`, This method returns the endianness of the color data. The value is one of the Endianness constants. If color data is represented using more than one byte, the actual channel positions are specified using bit diff --git a/offapi/com/sun/star/rendering/XSpriteCanvas.idl b/offapi/com/sun/star/rendering/XSpriteCanvas.idl index 53b9fa5696a0..eb98a4f3e830 100644 --- a/offapi/com/sun/star/rendering/XSpriteCanvas.idl +++ b/offapi/com/sun/star/rendering/XSpriteCanvas.idl @@ -127,13 +127,13 @@ interface XSpriteCanvas : XBitmapCanvas associated XSpriteCanvas instances.<p> @param bUpdateAll - When <TRUE/>, update the whole screen. When <FALSE/>, + When `TRUE`, update the whole screen. When `FALSE`, implementation is permitted to restrict update to areas the canvas itself changed (e.g. because of render operations, or changes on the sprites). The former is useful for updates after window expose events. the latter for animation display. - @return <TRUE/>, if the screen update was successfully + @return `TRUE`, if the screen update was successfully performed */ boolean updateScreen( [in] boolean bUpdateAll ); diff --git a/offapi/com/sun/star/rendering/XTextLayout.idl b/offapi/com/sun/star/rendering/XTextLayout.idl index 602aef021009..d803c0eca78d 100644 --- a/offapi/com/sun/star/rendering/XTextLayout.idl +++ b/offapi/com/sun/star/rendering/XTextLayout.idl @@ -250,7 +250,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface in the range 0 up to the number of characters in the string. @param bExcludeLigatures - Set this to <TRUE/>, to skip the positions inside ligatures as + Set this to `TRUE`, to skip the positions inside ligatures as valid caret placements. That means, on cannot e.g. set the caret between the "f" and the "i" in a "fi" ligature. diff --git a/offapi/com/sun/star/report/XFormatCondition.idl b/offapi/com/sun/star/report/XFormatCondition.idl index aab255e02205..bc6383310b80 100644 --- a/offapi/com/sun/star/report/XFormatCondition.idl +++ b/offapi/com/sun/star/report/XFormatCondition.idl @@ -37,7 +37,7 @@ interface XFormatCondition [attribute,bound] boolean Enabled; /** defines the formula of the format condition. - If the formula evaluates to <TRUE/> then the format will be applied. + If the formula evaluates to `TRUE` then the format will be applied. */ [attribute,bound] string Formula; }; diff --git a/offapi/com/sun/star/report/XGroup.idl b/offapi/com/sun/star/report/XGroup.idl index c9b5278edded..790f9a3ccc86 100644 --- a/offapi/com/sun/star/report/XGroup.idl +++ b/offapi/com/sun/star/report/XGroup.idl @@ -51,7 +51,7 @@ interface XGroup interface XFunctionsSupplier; /** Defines if the group is sorted ascending or descending. - The default is <TRUE/>. + The default is `TRUE`. */ [attribute,bound] boolean SortAscending; diff --git a/offapi/com/sun/star/report/XReportComponent.idl b/offapi/com/sun/star/report/XReportComponent.idl index 043632ea3779..058c6f150561 100644 --- a/offapi/com/sun/star/report/XReportComponent.idl +++ b/offapi/com/sun/star/report/XReportComponent.idl @@ -110,8 +110,8 @@ interface XReportComponent }; /** Specifies that recurring values are printed. - If set to <TRUE/> then the value will be printed every time. If set to <FALSE/> then the value will only be printed once. - The default value is <TRUE/>. + If set to `TRUE` then the value will be printed every time. If set to `FALSE` then the value will only be printed once. + The default value is `TRUE`. */ [attribute,bound] boolean PrintRepeatedValues { @@ -166,7 +166,7 @@ interface XReportComponent /** Specifies the section where the control belongs to. This is a shortcut to get control hierarchy up. - This value is <NULL/> when the control was not inserted in any section. + This value is `NULL` when the control was not inserted in any section. */ [attribute,readonly] com::sun::star::report::XSection Section; }; diff --git a/offapi/com/sun/star/report/XReportControlFormat.idl b/offapi/com/sun/star/report/XReportControlFormat.idl index d6b93fd738b7..836253dd2276 100644 --- a/offapi/com/sun/star/report/XReportControlFormat.idl +++ b/offapi/com/sun/star/report/XReportControlFormat.idl @@ -127,7 +127,7 @@ interface XReportControlFormat get raises ( com::sun::star::beans::UnknownPropertyException ); }; - /** If this optional property is <TRUE/>, then the characters are invisible. + /** If this optional property is `TRUE`, then the characters are invisible. @since OOo 2.0 */ @@ -214,7 +214,7 @@ interface XReportControlFormat get raises ( com::sun::star::beans::UnknownPropertyException ); }; - /** If this optional property is <TRUE/>, then the characters are flashing. + /** If this optional property is `TRUE`, then the characters are flashing. */ [attribute,bound] boolean CharFlash { @@ -340,7 +340,7 @@ interface XReportControlFormat get raises ( com::sun::star::beans::UnknownPropertyException ); }; - /** If this attribute is <TRUE/>, the underline and strike-through + /** If this attribute is `TRUE`, the underline and strike-through properties are not applied to white spaces. */ [attribute,bound] boolean CharWordMode diff --git a/offapi/com/sun/star/report/XReportControlModel.idl b/offapi/com/sun/star/report/XReportControlModel.idl index 469ca6d08721..05ea753961ae 100644 --- a/offapi/com/sun/star/report/XReportControlModel.idl +++ b/offapi/com/sun/star/report/XReportControlModel.idl @@ -66,7 +66,7 @@ interface XReportControlModel }; /** Specifies that the element gets printed when the group changes. - The default value is <TRUE/>. + The default value is `TRUE`. */ [attribute,bound] boolean PrintWhenGroupChange { diff --git a/offapi/com/sun/star/report/XReportDefinition.idl b/offapi/com/sun/star/report/XReportDefinition.idl index f3cb208c1322..a4ddd2582053 100644 --- a/offapi/com/sun/star/report/XReportDefinition.idl +++ b/offapi/com/sun/star/report/XReportDefinition.idl @@ -172,7 +172,7 @@ interface XReportDefinition It then can be to used to specify whether the SQL statement should be analyzed on the client side before sending it to the database server.<br/> The default value for com::sun::star::sdbc::RowSet::EscapeProcessing - is <TRUE/>. By switching it to <FALSE/>, you can pass backend-specific SQL statements, + is `TRUE`. By switching it to `FALSE`, you can pass backend-specific SQL statements, which are not standard SQL, to your database.</p> @@ -210,7 +210,7 @@ interface XReportDefinition /** specifies if the #Command should be analyzed on the client side before sending it to the database server. - <p>The default value of this property is <TRUE/>. By switching it to <FALSE/>, you can pass + <p>The default value of this property is `TRUE`. By switching it to `FALSE`, you can pass backend-specific SQL statements, which are not standard SQL, to your database.</p> <p>This property is usually present together with the #Command and @@ -232,22 +232,22 @@ interface XReportDefinition [attribute,bound] string DataSourceName; /** Defines that the report header is on. - Default is <FALSE/>. + Default is `FALSE`. */ [attribute,bound] boolean ReportHeaderOn; /** Defines that the report footer is on. - Default is <FALSE/>. + Default is `FALSE`. */ [attribute,bound] boolean ReportFooterOn; /** Defines that the page header is on. - Default is <TRUE/>. + Default is `TRUE`. */ [attribute,bound] boolean PageHeaderOn; /** Defines that the page footer is on. - Default is <TRUE/>. + Default is `TRUE`. */ [attribute,bound] boolean PageFooterOn; @@ -255,7 +255,7 @@ interface XReportDefinition */ [attribute,readonly] com::sun::star::report::XGroups Groups; - /** returns the report header if the #ReportHeaderOnis <TRUE/>. + /** returns the report header if the #ReportHeaderOnis `TRUE`. @throws com::sun::star::container::NoSuchElementException If the report has the report header disabled. @see XSection @@ -265,7 +265,7 @@ interface XReportDefinition get raises (com::sun::star::container::NoSuchElementException); }; - /** returns the page header if the #PageHeaderOnis <TRUE/>. + /** returns the page header if the #PageHeaderOnis `TRUE`. @throws com::sun::star::container::NoSuchElementException If the report has the page header disabled. @see XSection @@ -280,7 +280,7 @@ interface XReportDefinition */ [attribute,readonly] com::sun::star::report::XSection Detail; - /** returns the page footer if the #PageFooterOnis <TRUE/>. + /** returns the page footer if the #PageFooterOnis `TRUE`. @throws com::sun::star::container::NoSuchElementException If the report has the page footer disabled. @see XSection @@ -290,7 +290,7 @@ interface XReportDefinition get raises (com::sun::star::container::NoSuchElementException); }; - /** returns the report footer if the #ReportFooterOnis <TRUE/>. + /** returns the report footer if the #ReportFooterOnis `TRUE`. @throws com::sun::star::container::NullPointerException If the report has the report footer disabled. @see XSection diff --git a/offapi/com/sun/star/report/XReportEngine.idl b/offapi/com/sun/star/report/XReportEngine.idl index 965aad1555b8..6372e441804b 100644 --- a/offapi/com/sun/star/report/XReportEngine.idl +++ b/offapi/com/sun/star/report/XReportEngine.idl @@ -59,7 +59,7 @@ interface XReportEngine @throws com::sun::star::lang::DisposedException If the report engine is already disposed. @throws com::sun::star::lang::IllegalArgumentException - If the report definition was not set or is <NULL/>. + If the report definition was not set or is `NULL`. */ com::sun::star::frame::XModel createDocumentModel() raises( ::com::sun::star::lang::DisposedException, @@ -72,7 +72,7 @@ interface XReportEngine @throws com::sun::star::lang::DisposedException If the report engine is already disposed. @throws com::sun::star::lang::IllegalArgumentException - If the report definition was not set or is <NULL/>. + If the report definition was not set or is `NULL`. OJ: Has to be discussed if this method is useful. */ @@ -87,7 +87,7 @@ interface XReportEngine @throws com::sun::star::lang::DisposedException If the report engine is already disposed. @throws com::sun::star::lang::IllegalArgumentException - If the report definition was not set or is <NULL/>. + If the report definition was not set or is `NULL`. */ com::sun::star::util::URL createDocument() raises( ::com::sun::star::lang::DisposedException, diff --git a/offapi/com/sun/star/report/XSection.idl b/offapi/com/sun/star/report/XSection.idl index 76a1c9abd368..dd29ee8f896f 100644 --- a/offapi/com/sun/star/report/XSection.idl +++ b/offapi/com/sun/star/report/XSection.idl @@ -87,7 +87,7 @@ interface XSection [attribute,bound] boolean BackTransparent; /** Defines the expression which is executed before printing the section. - If the return value of the expression is <TRUE/> then the section will be printed. + If the return value of the expression is `TRUE` then the section will be printed. */ [attribute,bound] string ConditionalPrintExpression; diff --git a/offapi/com/sun/star/resource/XLocale.idl b/offapi/com/sun/star/resource/XLocale.idl index 799c616b295b..8efe7c50ded4 100644 --- a/offapi/com/sun/star/resource/XLocale.idl +++ b/offapi/com/sun/star/resource/XLocale.idl @@ -181,7 +181,7 @@ published interface XLocale: com::sun::star::uno::XInterface [in] com::sun::star::lang::Locale inLocale ); /** @returns - <TRUE/> if the com::sun::star::lang::Locale <var>l1</var> is equal to the + `TRUE` if the com::sun::star::lang::Locale <var>l1</var> is equal to the other one. <p>A locale is deemed equal to another locale with identical diff --git a/offapi/com/sun/star/resource/XStringResourceManager.idl b/offapi/com/sun/star/resource/XStringResourceManager.idl index 208dac558a5a..3e53ef98bd1a 100644 --- a/offapi/com/sun/star/resource/XStringResourceManager.idl +++ b/offapi/com/sun/star/resource/XStringResourceManager.idl @@ -49,7 +49,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol /** Returns the resource's read only state - @return <TRUE/> if the resource is read only, otherwise <FALSE/> + @return `TRUE` if the resource is read only, otherwise `FALSE` */ boolean isReadOnly(); @@ -63,7 +63,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol <p>If true: If the exact locale that should be set is not available the method tries to find the closest match. E.g. if en_US is re- quired but not available, en would be the next choice. Finally - the default locale will be used <TRUE/>. + the default locale will be used `TRUE`. <p>If false: If the exact locale that should be set is not available a com::sun::star::lang::IllegalArgumentException diff --git a/offapi/com/sun/star/resource/XStringResourcePersistence.idl b/offapi/com/sun/star/resource/XStringResourcePersistence.idl index 3e19e7dfc964..eff8f275866c 100644 --- a/offapi/com/sun/star/resource/XStringResourcePersistence.idl +++ b/offapi/com/sun/star/resource/XStringResourcePersistence.idl @@ -79,10 +79,10 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM provides the current modify state of the StringResourceManager instance. @return - <TRUE/> if the string table has changed since the last call to + `TRUE` if the string table has changed since the last call to store() or, if supported <code>XStringResourceWithStorage::storeAsStorage</code>. - <FALSE/> if the table hasn't changed. + `FALSE` if the table hasn't changed. */ boolean isModified(); diff --git a/offapi/com/sun/star/resource/XStringResourceResolver.idl b/offapi/com/sun/star/resource/XStringResourceResolver.idl index e4967038702e..5f21022d7236 100644 --- a/offapi/com/sun/star/resource/XStringResourceResolver.idl +++ b/offapi/com/sun/star/resource/XStringResourceResolver.idl @@ -98,7 +98,7 @@ interface XStringResourceResolver: com::sun::star::util::XModifyBroadcaster @param ResourceID ID to specify the string inside the resource. - @return <TRUE/> if an entry exists, otherwise <FALSE/> + @return `TRUE` if an entry exists, otherwise `FALSE` */ boolean hasEntryForId( [in] string ResourceID ); @@ -119,7 +119,7 @@ interface XStringResourceResolver: com::sun::star::util::XModifyBroadcaster The locale has to match exactly with one of the locales provided by getLocales(). A closest match search is not supported. - @return <TRUE/> if an entry exists, otherwise <FALSE/> + @return `TRUE` if an entry exists, otherwise `FALSE` */ boolean hasEntryForIdAndLocale( [in] string ResourceID, [in] com::sun::star::lang::Locale locale ); diff --git a/offapi/com/sun/star/script/DocumentDialogLibraryContainer.idl b/offapi/com/sun/star/script/DocumentDialogLibraryContainer.idl index 18cd9a8aa085..3ee68bf4ba4a 100644 --- a/offapi/com/sun/star/script/DocumentDialogLibraryContainer.idl +++ b/offapi/com/sun/star/script/DocumentDialogLibraryContainer.idl @@ -46,7 +46,7 @@ service DocumentDialogLibraryContainer : XStorageBasedLibraryContainer @param Document The document to which the container should belong to. Must not be - <NULL/>. + `NULL`. @throws ::com::sun::star::lang::IllegalArgumentException if <code>Document</code> does not denote a valid diff --git a/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl b/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl index 9bf4767b3e4b..1c09688d2f72 100644 --- a/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl +++ b/offapi/com/sun/star/script/DocumentScriptLibraryContainer.idl @@ -46,7 +46,7 @@ service DocumentScriptLibraryContainer : XStorageBasedLibraryContainer @param Document The document to which the container should belong to. Must not be - <NULL/>. + `NULL`. @throws ::com::sun::star::lang::IllegalArgumentException if <code>Document</code> does not denote a valid diff --git a/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl b/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl index 2c0acbd524d4..c57564d387ca 100644 --- a/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl +++ b/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl @@ -67,12 +67,12 @@ interface XStorageBasedLibraryContainer @param RootStorage denotes the root storage into which the libraries should be written, which - must not be <NULL/>.<br/> + must not be `NULL`.<br/> Note that the actual libraries are written into a sub storage of this root storage, as usual. @throws ::com::sun::star::lang::IllegalArgumentException - if the <code>RootStorage</code> parameter is <NULL/>, or equals + if the <code>RootStorage</code> parameter is `NULL`, or equals #RootStorage. @throws ::com::sun::star::lang::WrappedTargetException diff --git a/offapi/com/sun/star/script/provider/XScriptContext.idl b/offapi/com/sun/star/script/provider/XScriptContext.idl index 56b8fb2af213..096c7f12eb48 100644 --- a/offapi/com/sun/star/script/provider/XScriptContext.idl +++ b/offapi/com/sun/star/script/provider/XScriptContext.idl @@ -56,10 +56,10 @@ interface XScriptContext : ::com::sun::star::uno::XInterface { itself. In this case, the <code>getInvocationContext</code> member allows to access this context.</p> - <p>Note that the returned context is allowed to be <NULL/>, in this case, + <p>Note that the returned context is allowed to be `NULL`, in this case, the document as returned by <code>getDocument</code> is the invocation context.</p> - <p>If the returned context is not <NULL/>, its <code>ScriptContainer</code> attribute + <p>If the returned context is not `NULL`, its <code>ScriptContainer</code> attribute equals the document as returned by <code>XScriptContext::getDocument</code>.</p> @since OOo 3.0 diff --git a/offapi/com/sun/star/script/vba/XVBAEventProcessor.idl b/offapi/com/sun/star/script/vba/XVBAEventProcessor.idl index 79c1993386df..750cc4d22bb3 100644 --- a/offapi/com/sun/star/script/vba/XVBAEventProcessor.idl +++ b/offapi/com/sun/star/script/vba/XVBAEventProcessor.idl @@ -43,7 +43,7 @@ interface XVBAEventProcessor sheet index for spreadsheet events. @return - <TRUE/>, if the VBA event handler exists. + `TRUE`, if the VBA event handler exists. @throws ::com::sun::star::lang::IllegalArgumentException if the passed event identifier is not supported, or if the passed @@ -63,7 +63,7 @@ interface XVBAEventProcessor event handler. @return - <TRUE/>, if event handing is enabled, and the event handler macro + `TRUE`, if event handing is enabled, and the event handler macro exists and has been invoked. @throws ::com::sun::star::lang::IllegalArgumentException diff --git a/offapi/com/sun/star/sdb/ColumnSettings.idl b/offapi/com/sun/star/sdb/ColumnSettings.idl index 72334d212e1e..d1c5421787cd 100644 --- a/offapi/com/sun/star/sdb/ColumnSettings.idl +++ b/offapi/com/sun/star/sdb/ColumnSettings.idl @@ -94,7 +94,7 @@ published service ColumnSettings /** indicates a control model which defines the settings for layouting. The default is - <NULL/> + `NULL` . */ [optional, property] com::sun::star::beans::XPropertySet ControlModel; @@ -102,14 +102,14 @@ published service ColumnSettings /** describes an optional help text which can be used by UI components when representing this column. The default is - <NULL/> + `NULL` . */ [optional, property] string HelpText; /** describes the default value which should be displayed by a control when moving to a new row. The default is - <NULL/> + `NULL` . */ [optional, property] string ControlDefault; diff --git a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl index 90e3feff8733..d3734b76492f 100644 --- a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl +++ b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl @@ -163,7 +163,7 @@ published service DataAccessDescriptor /** specifies if the #Command should be analyzed on the client side before sending it to the database server. - <p>The default value of this property is <TRUE/>. By switching it to <FALSE/>, you can pass + <p>The default value of this property is `TRUE`. By switching it to `FALSE`, you can pass backend-specific SQL statements, which are not standard SQL, to your database.</p> <p>This property is usually present together with the #Command and @@ -216,8 +216,8 @@ published service DataAccessDescriptor <p>If present, #BookmarkSelection specifies the semantics of #Selection. If not present, it's up to the implementing component to specify this semantics.</p> - <p>If <TRUE/>, then the single elements of the array specified by #Selection are - bookmarks relative to the result set, if <FALSE/>, they're record numbers.</p> + <p>If `TRUE`, then the single elements of the array specified by #Selection are + bookmarks relative to the result set, if `FALSE`, they're record numbers.</p> @see com::sun::star::sdbcx::XRowLocate @see com::sun::star::sdbc::XResultSet diff --git a/offapi/com/sun/star/sdb/DataSettings.idl b/offapi/com/sun/star/sdb/DataSettings.idl index 950e4e4c7c6b..6fd16d17592e 100644 --- a/offapi/com/sun/star/sdb/DataSettings.idl +++ b/offapi/com/sun/star/sdb/DataSettings.idl @@ -41,7 +41,7 @@ published service DataSettings /** indicates whether the filter should be applied or not, - default is <FALSE/>. + default is `FALSE`. */ [property] boolean ApplyFilter; diff --git a/offapi/com/sun/star/sdb/DataSourceBrowser.idl b/offapi/com/sun/star/sdb/DataSourceBrowser.idl index 87896c076691..452d90827334 100644 --- a/offapi/com/sun/star/sdb/DataSourceBrowser.idl +++ b/offapi/com/sun/star/sdb/DataSourceBrowser.idl @@ -188,18 +188,18 @@ published service DataSourceBrowser name or a SQL string is controller by the <em>CommandType</em> parameter.</li> <li><b>EnableBrowser</b><br/> - is a boolean value (defaulting to <TRUE/>), which specifies whether to enable the data source browser + is a boolean value (defaulting to `TRUE`), which specifies whether to enable the data source browser control. This is a tree control on the left hand side of the view, which allows to browse all registered data sources, including their tables and queries.</li> <li><b>ShowBrowser</b><br/> - is a boolean value (defaulting to <TRUE/>), which specifies whether to initially show the data source - browser control. If <code>EnableBrowser</code> is <FALSE/>, then this parameter is ignored. If - <code>EnableBrowser</code> is <TRUE/>, and <code>ShowBrowser</code> is <FALSE/>, then the control + is a boolean value (defaulting to `TRUE`), which specifies whether to initially show the data source + browser control. If <code>EnableBrowser</code> is `FALSE`, then this parameter is ignored. If + <code>EnableBrowser</code> is `TRUE`, and <code>ShowBrowser</code> is `FALSE`, then the control is initially hidden, but can be toggled by a toolbar button.</p> <li><b>ShowMenu</b><br/> - is a boolean value (defaulting to <TRUE/>), specifying whether or not to show a menu in the frame + is a boolean value (defaulting to `TRUE`), specifying whether or not to show a menu in the frame where the component is plugged.</li> </ul> </p> diff --git a/offapi/com/sun/star/sdb/OrderColumn.idl b/offapi/com/sun/star/sdb/OrderColumn.idl index a3b449f08599..d693fd775ec0 100644 --- a/offapi/com/sun/star/sdb/OrderColumn.idl +++ b/offapi/com/sun/star/sdb/OrderColumn.idl @@ -32,7 +32,7 @@ service OrderColumn service com::sun::star::sdbcx::Column; /** describes which sort order this column has.. - The default is <TRUE/>. + The default is `TRUE`. */ [property] boolean IsAscending; }; diff --git a/offapi/com/sun/star/sdb/QueryDesign.idl b/offapi/com/sun/star/sdb/QueryDesign.idl index d302b382227c..af75ff403333 100644 --- a/offapi/com/sun/star/sdb/QueryDesign.idl +++ b/offapi/com/sun/star/sdb/QueryDesign.idl @@ -121,14 +121,14 @@ module com { module sun { module star { module sdb { <li><b>EscapeProcessing</b><br/> Specifies whether or not escape processing should be initially enabled in the query designer. If set - to <FALSE/>, then the designer can operate in text view only (as opposed to the graphical view). The - <a href="#graphical_design">GraphicalDesign</a> parameter will be ignored then, and assumed to be <FALSE/>.<br/> - If not present, <TRUE/> is assumed for this parameter.</li> + to `FALSE`, then the designer can operate in text view only (as opposed to the graphical view). The + <a href="#graphical_design">GraphicalDesign</a> parameter will be ignored then, and assumed to be `FALSE`.<br/> + If not present, `TRUE` is assumed for this parameter.</li> <li><a name="graphical_design"></a><b>GraphicalDesign</b><br/> This value indicates whether the designer should be opened in the graphical design view - (<TRUE/>) or in the text view (<FALSE/>).<br/> - If not present, <FALSE/> is assumed for this parameter. + (`TRUE`) or in the text view (`FALSE`).<br/> + If not present, `FALSE` is assumed for this parameter. </li> </ul> </p> diff --git a/offapi/com/sun/star/sdb/RowSet.idl b/offapi/com/sun/star/sdb/RowSet.idl index 6691370dacea..3e9026083107 100644 --- a/offapi/com/sun/star/sdb/RowSet.idl +++ b/offapi/com/sun/star/sdb/RowSet.idl @@ -149,7 +149,7 @@ published interface XParametersSupplier; <h3>Deletions</h3> <p>Via com::sun::star::sdbc::XResultSetUpdate::deleteRow(), you can delete the current row of a RowSet. This deleted row then doesn't vanish immediately, but is still present, and subsequent calls to - com::sun::star::sdbc::XResultSet::rowDeleted() will return <TRUE/>. The deleted row "vanishes" from + com::sun::star::sdbc::XResultSet::rowDeleted() will return `TRUE`. The deleted row "vanishes" from the RowSet as soon as the cursor is moved away from it.<br/> As a consequence, the behavior of several other methods is affected:<br/> <dl> @@ -246,7 +246,7 @@ published service RowSet </p> <p> If the row set is not alive (i.e., it was not executed before), - <NULL/> + `NULL` is returned. </p> */ @@ -287,7 +287,7 @@ published service RowSet It then can be to used to specify whether the SQL statement should be analyzed on the client side before sending it to the database server.<br/> The default value for com::sun::star::sdbc::RowSet::EscapeProcessing - is <TRUE/>. By switching it to <FALSE/>, you can pass backend-specific SQL statements, + is `TRUE`. By switching it to `FALSE`, you can pass backend-specific SQL statements, which are not standard SQL, to your database.</p> @see com::sun::star::sdb::CommandType @@ -317,7 +317,7 @@ published service RowSet /** indicates whether the filter should be applied or not, - default is <FALSE/>. + default is `FALSE`. */ [property] boolean ApplyFilter; diff --git a/offapi/com/sun/star/sdb/XAlterQuery.idl b/offapi/com/sun/star/sdb/XAlterQuery.idl index 7858d2a9ab25..924ddd7fed4d 100644 --- a/offapi/com/sun/star/sdb/XAlterQuery.idl +++ b/offapi/com/sun/star/sdb/XAlterQuery.idl @@ -34,7 +34,7 @@ published interface XAlterQuery: com::sun::star::uno::XInterface @param command the SQL statement @param useEscapeProcessing - <TRUE/> when escape processing should be used + `TRUE` when escape processing should be used @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/sdb/XColumn.idl b/offapi/com/sun/star/sdb/XColumn.idl index 86fa55cdf944..1ac46d82726f 100644 --- a/offapi/com/sun/star/sdb/XColumn.idl +++ b/offapi/com/sun/star/sdb/XColumn.idl @@ -58,7 +58,7 @@ published interface XColumn: com::sun::star::uno::XInterface <code>wasNull()</code> to see if the value read was SQL NULL. @returns - <TRUE/> if so + `TRUE` if so @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/sdb/XRowSetApproveListener.idl b/offapi/com/sun/star/sdb/XRowSetApproveListener.idl index 30eaac5c35f6..7c4ebf4c3a91 100644 --- a/offapi/com/sun/star/sdb/XRowSetApproveListener.idl +++ b/offapi/com/sun/star/sdb/XRowSetApproveListener.idl @@ -34,14 +34,14 @@ published interface XRowSetApproveListener: com::sun::star::lang::XEventListener /** is called before a row set's cursor is moved. @param event the event which happened - @returns <TRUE/> when moving is allowed, otherwise <FALSE/> + @returns `TRUE` when moving is allowed, otherwise `FALSE` */ boolean approveCursorMove([in]com::sun::star::lang::EventObject event); /** is called before a row is inserted, updated, or deleted. @param event the event which happened - @returns <TRUE/> when changing is allowed, otherwise <FALSE/> + @returns `TRUE` when changing is allowed, otherwise `FALSE` */ boolean approveRowChange([in]RowChangeEvent event); @@ -49,7 +49,7 @@ published interface XRowSetApproveListener: com::sun::star::lang::XEventListener before a row set is reexecuted. @param event the event which happened - @returns <TRUE/> when changing is allowed, otherwise <FALSE/> + @returns `TRUE` when changing is allowed, otherwise `FALSE` */ boolean approveRowSetChange([in]com::sun::star::lang::EventObject event); }; diff --git a/offapi/com/sun/star/sdb/XSQLQueryComposer.idl b/offapi/com/sun/star/sdb/XSQLQueryComposer.idl index 749c94a45e07..a5c9c18e7b9d 100644 --- a/offapi/com/sun/star/sdb/XSQLQueryComposer.idl +++ b/offapi/com/sun/star/sdb/XSQLQueryComposer.idl @@ -113,7 +113,7 @@ published interface XSQLQueryComposer: com::sun::star::uno::XInterface @param column the column which is used to create a order part @param ascending - <TRUE/> when the order should be ascending, otherwise <FALSE/> + `TRUE` when the order should be ascending, otherwise `FALSE` @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl index af71b7016f27..c95fbdfc09d2 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl @@ -201,7 +201,7 @@ interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface It then can be to used to specify whether the SQL statement should be analyzed on the client side before sending it to the database server.<br/> The default value for com::sun::star::sdbc::RowSet::EscapeProcessing - is <TRUE/>. By switching it to <FALSE/>, you can pass backend-specific SQL statements, + is `TRUE`. By switching it to `FALSE`, you can pass backend-specific SQL statements, which are not standard SQL, to your database.</p> @see com::sun::star::sdb::CommandType diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl index 85d136bfe092..bfe62e56828d 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl @@ -75,7 +75,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer @param column the column which is used to create a filter @param andCriteria - If <TRUE/> the filter condition will be appended as an AND condition, otherwise + If `TRUE` the filter condition will be appended as an AND condition, otherwise the new filter condition will be appended as OR criteria. E.g. (xx AND bb AND cc) OR newCriteria @param filterOperator @@ -144,7 +144,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer @param column the column which is used to create a filter @param andCriteria - If <TRUE/> the filter condition will be appended as an AND condition, otherwise + If `TRUE` the filter condition will be appended as an AND condition, otherwise the new filter condition will be appended as OR criteria. E.g. (xx AND bb AND cc) OR newCriteria @param filterOperator @@ -174,7 +174,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer @param column the column which is used to create a order part @param ascending - <TRUE/> when the order should be ascending, otherwise if <FALSE/> descending. + `TRUE` when the order should be ascending, otherwise if `FALSE` descending. @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/sdb/XSubDocument.idl b/offapi/com/sun/star/sdb/XSubDocument.idl index fe3e84ec97ef..ee7ff640a061 100644 --- a/offapi/com/sun/star/sdb/XSubDocument.idl +++ b/offapi/com/sun/star/sdb/XSubDocument.idl @@ -74,7 +74,7 @@ interface XSubDocument /** closes the sub document, if it had previously been opened in either mode - @return <TRUE/> if and only if the document could be closed, <FALSE/> otherwise, + @return `TRUE` if and only if the document could be closed, `FALSE` otherwise, e.g. if the closing has been vetoed by the user. @throws ::com::sun::star::lang::WrappedTargetException diff --git a/offapi/com/sun/star/sdb/application/CopyTableWizard.idl b/offapi/com/sun/star/sdb/application/CopyTableWizard.idl index 2292c0d2d37d..2b2aaa9d9807 100644 --- a/offapi/com/sun/star/sdb/application/CopyTableWizard.idl +++ b/offapi/com/sun/star/sdb/application/CopyTableWizard.idl @@ -142,7 +142,7 @@ service CopyTableWizard : XCopyTableWizard @throws ::com::sun::star::lang::IllegalArgumentException if - <ul><li>either <code>Source</code> or <code>Destination</code> is <NULL/></li> + <ul><li>either <code>Source</code> or <code>Destination</code> is `NULL`</li> <li>either <code>Source</code> or <code>Destination</code> are not sufficient to describe a database connection.</li> <li><code>Source</code> is not sufficient to describe the to-be-copied data</li> diff --git a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl index eff20522c23b..a8e200e617fd 100644 --- a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl +++ b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl @@ -149,7 +149,7 @@ interface XDatabaseDocumentUI listener registered at the component.</p> @return - <TRUE/> if and only if both suspending and closing all sub components succeeds. + `TRUE` if and only if both suspending and closing all sub components succeeds. @since OOo 3.0 */ @@ -181,15 +181,15 @@ interface XDatabaseDocumentUI (as is the case form forms and reports), hierarchical names are supported here, too. @param ForEditing - specifies whether the object should be opened for editing (<TRUE/>) or viewing (<FALSE/>). + specifies whether the object should be opened for editing (`TRUE`) or viewing (`FALSE`). <p>For the different object types, this means the following <a name="component_types"></a> <table style="width:100%;" border="1 solid black" cellpadding="2" cellspacing="2"><tbody> <tr style="vertical-align: top;"> <td></td> - <td><code>ForEditing</code> = <TRUE/></td> - <td><code>ForEditing</code> = <FALSE/></td> + <td><code>ForEditing</code> = `TRUE`</td> + <td><code>ForEditing</code> = `FALSE`</td> </tr> <tr style="vertical-align: top;"> @@ -298,7 +298,7 @@ interface XDatabaseDocumentUI or DatabaseObject::REPORT, this will contain the com::sun::star::sdb::DocumentDefinition object which controls the sub component.<br/> You can use this object to control various aspects of the sub component. For instance, you could decide - to create the component hidden, by passing a <code>Hidden</code> flag (set to <TRUE/>) in Arguments, + to create the component hidden, by passing a <code>Hidden</code> flag (set to `TRUE`) in Arguments, manipulate the component, and then finally show it by invoking the <code>show</code> command at the definition object. */ diff --git a/offapi/com/sun/star/sdb/application/XTableUIProvider.idl b/offapi/com/sun/star/sdb/application/XTableUIProvider.idl index 727ee7b33cc9..e9bb5b53e2f8 100644 --- a/offapi/com/sun/star/sdb/application/XTableUIProvider.idl +++ b/offapi/com/sun/star/sdb/application/XTableUIProvider.idl @@ -54,7 +54,7 @@ interface XTableUIProvider com::sun::star::graphic::GraphicColorMode constants. @return the icon which should be used to represent the table in the - database application window, or <NULL/> if the default icon + database application window, or `NULL` if the default icon should be used. */ com::sun::star::graphic::XGraphic getTableIcon( @@ -74,7 +74,7 @@ interface XTableUIProvider @return a component which can be used to edit the definition of an - existing table, or <NULL/> if the default component should + existing table, or `NULL` if the default component should be used.<br/> Two component types are supported so far <ul><li>modal dialogs<br/> diff --git a/offapi/com/sun/star/sdb/tools/XConnectionTools.idl b/offapi/com/sun/star/sdb/tools/XConnectionTools.idl index 49273cb94af6..1ed998867845 100644 --- a/offapi/com/sun/star/sdb/tools/XConnectionTools.idl +++ b/offapi/com/sun/star/sdb/tools/XConnectionTools.idl @@ -58,14 +58,14 @@ interface XConnectionTools /** creates an instance supporting the XTableName interface, which can be used to manipulate table names for various purposes. - <p>The returned object is guaranteed to not be <NULL/>.</p> + <p>The returned object is guaranteed to not be `NULL`.</p> */ XTableName createTableName(); /** returns an instance supporting the XObjectNames interface, which provides access to functionality around table and query names. - <p>The returned object is guaranteed to not be <NULL/>.</p> + <p>The returned object is guaranteed to not be `NULL`.</p> */ XObjectNames getObjectNames(); diff --git a/offapi/com/sun/star/sdb/tools/XObjectNames.idl b/offapi/com/sun/star/sdb/tools/XObjectNames.idl index d0b5662431ba..4069e4c0dc4f 100644 --- a/offapi/com/sun/star/sdb/tools/XObjectNames.idl +++ b/offapi/com/sun/star/sdb/tools/XObjectNames.idl @@ -114,7 +114,7 @@ interface XObjectNames specifies the to-be-checked name of the object. @return - <TRUE/> if and only if the given name is legitimate as table respectively query name + `TRUE` if and only if the given name is legitimate as table respectively query name to be used in the database. @throws com::sun::star::lang::IllegalArgumentException diff --git a/offapi/com/sun/star/sdbc/DBASEConnectionProperties.idl b/offapi/com/sun/star/sdbc/DBASEConnectionProperties.idl index d0a7d9567bff..58fd2afdecc5 100644 --- a/offapi/com/sun/star/sdbc/DBASEConnectionProperties.idl +++ b/offapi/com/sun/star/sdbc/DBASEConnectionProperties.idl @@ -41,7 +41,7 @@ service DBASEConnectionProperties { service com::sun::star::sdbc:: FILEConnectionProperties; - /** <TRUE/> when deleted rows should be shown, otherwise <FALSE/> + /** `TRUE` when deleted rows should be shown, otherwise `FALSE` */ [optional, property] boolean ShowDeleted; }; diff --git a/offapi/com/sun/star/sdbc/DataTruncation.idl b/offapi/com/sun/star/sdbc/DataTruncation.idl index f619796c3e53..2fd35f1c08e0 100644 --- a/offapi/com/sun/star/sdbc/DataTruncation.idl +++ b/offapi/com/sun/star/sdbc/DataTruncation.idl @@ -44,14 +44,14 @@ published exception DataTruncation: SQLWarning /** is - <TRUE/> + `TRUE` if a parameter value is truncated. */ boolean IsParameter; /** is - <TRUE/> + `TRUE` if a read was truncated. */ boolean DuringRead; diff --git a/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl b/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl index 77a35d8a8840..6282fc4aa0d6 100644 --- a/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl +++ b/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl @@ -44,12 +44,12 @@ published struct DriverPropertyInfo /** is - <TRUE/> + `TRUE` if a value must be supplied for this property during <code>Driver.connect</code> and - <FALSE/> + `FALSE` otherwise. */ boolean IsRequired; diff --git a/offapi/com/sun/star/sdbc/FLATConnectionProperties.idl b/offapi/com/sun/star/sdbc/FLATConnectionProperties.idl index 342d7ac040c4..99bcfb0b9296 100644 --- a/offapi/com/sun/star/sdbc/FLATConnectionProperties.idl +++ b/offapi/com/sun/star/sdbc/FLATConnectionProperties.idl @@ -41,7 +41,7 @@ service FLATConnectionProperties { service com::sun::star::sdbc::FILEConnectionProperties; - /** <TRUE/> when the file contains a header line otherwise <FALSE/> + /** `TRUE` when the file contains a header line otherwise `FALSE` */ [optional, property] boolean HeaderLine; diff --git a/offapi/com/sun/star/sdbc/JDBCConnectionProperties.idl b/offapi/com/sun/star/sdbc/JDBCConnectionProperties.idl index c9f8bad87325..0bf18a2524ef 100644 --- a/offapi/com/sun/star/sdbc/JDBCConnectionProperties.idl +++ b/offapi/com/sun/star/sdbc/JDBCConnectionProperties.idl @@ -71,7 +71,7 @@ service JDBCConnectionProperties [optional, property] sequence< ::com::sun::star::beans::NamedValue > SystemProperties; /** specifies if retrieving of auto generated values should be enabled or not. - If <TRUE/> than the statement will support the XGeneratedResultSet (future concept) interface, otherwise not. + If `TRUE` than the statement will support the XGeneratedResultSet (future concept) interface, otherwise not. */ [optional, property] boolean IsAutoRetrievingEnabled; diff --git a/offapi/com/sun/star/sdbc/ODBCConnectionProperties.idl b/offapi/com/sun/star/sdbc/ODBCConnectionProperties.idl index b7e0ad9e36dc..39764d38b07c 100644 --- a/offapi/com/sun/star/sdbc/ODBCConnectionProperties.idl +++ b/offapi/com/sun/star/sdbc/ODBCConnectionProperties.idl @@ -64,7 +64,7 @@ service ODBCConnectionProperties [optional, property] string CharSet; /** specifies if retrieving of auto generated values should be enabled or not. - If <TRUE/> than the statement will support the XGeneratedResultSet (future concept) interface, otherwise not. + If `TRUE` than the statement will support the XGeneratedResultSet (future concept) interface, otherwise not. */ [optional, property] boolean IsAutoRetrievingEnabled; diff --git a/offapi/com/sun/star/sdbc/PreparedStatement.idl b/offapi/com/sun/star/sdbc/PreparedStatement.idl index 3c34ad5dcab7..57bcc5f204e3 100644 --- a/offapi/com/sun/star/sdbc/PreparedStatement.idl +++ b/offapi/com/sun/star/sdbc/PreparedStatement.idl @@ -126,7 +126,7 @@ published service PreparedStatement for execution. <p> A driver implementing batch execution must return - <TRUE/> + `TRUE` for <member scope= "com::sun::star::sdbc">XDatabaseMetaData::supportsBatchUpdates()</member> </p> diff --git a/offapi/com/sun/star/sdbc/Statement.idl b/offapi/com/sun/star/sdbc/Statement.idl index b4ed4d579805..e49728cae380 100644 --- a/offapi/com/sun/star/sdbc/Statement.idl +++ b/offapi/com/sun/star/sdbc/Statement.idl @@ -77,7 +77,7 @@ published service Statement for execution. <p> A driver implementing batch execution must return - <TRUE/> + `TRUE` for <member scope= "com::sun::star::sdbc"> XDatabaseMetaData::supportsBatchUpdates()</member> </p> diff --git a/offapi/com/sun/star/sdbc/XArray.idl b/offapi/com/sun/star/sdbc/XArray.idl index 25b56c6e0d24..e6694dc3c5f3 100644 --- a/offapi/com/sun/star/sdbc/XArray.idl +++ b/offapi/com/sun/star/sdbc/XArray.idl @@ -94,7 +94,7 @@ published interface XArray: com::sun::star::uno::XInterface services. If the <code>typeMap</code> is - <NULL/> + `NULL` , the type-map associated with the connection for customizations of the type-mappings is used. @@ -127,7 +127,7 @@ published interface XArray: com::sun::star::uno::XInterface services. If the <code>typeMap</code> is - <NULL/> + `NULL` , the type-map associated with the connection for customizations of the type-mappings is used. @@ -159,7 +159,7 @@ published interface XArray: com::sun::star::uno::XInterface or the <code>typeMap</code> is - <NULL/> + `NULL` , the connection type mapping is used instead. @@ -198,7 +198,7 @@ published interface XArray: com::sun::star::uno::XInterface or the <code>typeMap</code> is - <NULL/> + `NULL` , the connection type mapping is used instead. diff --git a/offapi/com/sun/star/sdbc/XConnection.idl b/offapi/com/sun/star/sdbc/XConnection.idl index c736cbf871c9..a54a39fd8876 100644 --- a/offapi/com/sun/star/sdbc/XConnection.idl +++ b/offapi/com/sun/star/sdbc/XConnection.idl @@ -207,7 +207,7 @@ published interface XConnection: com::sun::star::sdbc::XCloseable </p> @param autoCommit - <TRUE/> enables auto-commit; <FALSE/> disables auto-commit. + `TRUE` enables auto-commit; `FALSE` disables auto-commit. @throws SQLException if a database access error occurs. */ @@ -259,7 +259,7 @@ published interface XConnection: com::sun::star::sdbc::XCloseable </p> @returns - <TRUE/> if the connection is closed; <FALSE/> if it's still open. + `TRUE` if the connection is closed; `FALSE` if it's still open. @throws SQLException if a database access error occurs. */ @@ -293,13 +293,13 @@ published interface XConnection: com::sun::star::sdbc::XCloseable </b> This method cannot be called while in the middle of a transaction. Calling setReadOnly with - <TRUE/> + `TRUE` does not necessarily cause writes to be prohibited. </p> @param readONly - <TRUE/> enables read-only mode; <FALSE/> disables read-only mode. + `TRUE` enables read-only mode; `FALSE` disables read-only mode. @throws SQLException if a database access error occurs. */ @@ -307,7 +307,7 @@ published interface XConnection: com::sun::star::sdbc::XCloseable /** tests to see if the connection is in read-only mode. @returns - <TRUE/> if connection is read-only and <FALSE/> otherwise. + `TRUE` if connection is read-only and `FALSE` otherwise. @throws SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl index 277d39d7b70f..f184b96f986d 100644 --- a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl +++ b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl @@ -47,15 +47,15 @@ com::sun::star::sdbc::SQLException . After calling one of the getXXX() methods, - one can check whether that value is <NULL/> + one can check whether that value is `NULL` with the method com::sun::star::sdbc::XRow::wasNull(). - In the text only "(may be <NULL/>)" is mentioned for this case. + In the text only "(may be `NULL`)" is mentioned for this case. </p> <p>Some of these methods take arguments that are String patterns. These arguments all have names such as fooPattern. Within a pattern String, "%" means match any substring of 0 or more characters, and "_" means match any one character. Only metadata entries matching the search pattern - are returned. If a search pattern argument is set to <VOID/>, + are returned. If a search pattern argument is set to `VOID`, that argument's criteria will be dropped from the search. </p> <p> @@ -73,10 +73,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface current user? @return - <TRUE/> + `TRUE` if the user is allowed to call all procedures returned by getProcedures otherwise - <FALSE/> + `FALSE` . @throws SQLException if a database access error occurs. @@ -86,7 +86,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can all the tables returned by getTable be SELECTed by the current user? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -102,7 +102,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** checks if the database in read-only mode. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -110,7 +110,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Are NULL values sorted high? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -118,7 +118,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Are NULL values sorted low? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -126,7 +126,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Are NULL values sorted at the start regardless of sort order? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -134,7 +134,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Are NULL values sorted at the end, regardless of sort order? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -166,7 +166,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** use the database local files to save the tables. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -174,7 +174,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** use the database one local file to save for each table. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -182,7 +182,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** use the database "mixed case unquoted SQL identifiers" case sensitive. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -191,7 +191,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -200,7 +200,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -209,7 +209,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -218,7 +218,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Does the database treat mixed case quoted SQL identifiers as case sensitive and as a result store them in mixed case? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -227,7 +227,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -236,7 +236,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -245,7 +245,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -254,7 +254,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** What's the string used to quote SQL identifiers? This returns a space " " if identifier quoting is not supported. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -263,7 +263,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** gets a comma-separated list of all a database's SQL keywords that are NOT also SQL92 keywords. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -273,7 +273,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface X/Open CLI math function names used in the SDBC function escape clause. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -283,7 +283,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface X/Open CLI string function names used in the SDBC function escape clause. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -293,7 +293,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface X/Open CLI system function names used in the SDBC function escape clause. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -301,7 +301,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** gets a comma-separated list of time and date functions. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -320,7 +320,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface more characters. </p> @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -329,7 +329,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** gets all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _). @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -337,7 +337,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** support the Database "ALTER TABLE" with add column? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -345,7 +345,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** support the Database "ALTER TABLE" with drop column? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -359,7 +359,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface computed columns or to provide alias names for columns as required. </p> @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -367,31 +367,31 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** are concatenations between NULL and non-NULL values NULL? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ boolean nullPlusNonNullIsNull() raises (SQLException); - /** <TRUE/> + /** `TRUE` , if the Database supports the CONVERT function between SQL types, otherwise - <FALSE/> + `FALSE` . @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ boolean supportsTypeConversion() raises (SQLException); - /** <TRUE/> + /** `TRUE` , if the Database supports the CONVERT between the given SQL types otherwise - <FALSE/> + `FALSE` . @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -400,7 +400,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Are table correlation names supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -409,7 +409,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** If table correlation names are supported, are they restricted to be different from the names of the tables? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -418,7 +418,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Are expressions in "ORDER BY" lists supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -426,7 +426,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can an "ORDER BY" clause use columns not in the SELECT statement? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -434,7 +434,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Is some form of "GROUP BY" clause supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -442,7 +442,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can a "GROUP BY" clause use columns not in the SELECT? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -451,7 +451,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -459,7 +459,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Is the escape character in "LIKE" clauses supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -467,7 +467,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Are multiple XResultSets from a single execute supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -476,7 +476,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can we have multiple transactions open at once (on different connections)? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -484,92 +484,92 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can columns be defined as non-nullable? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ boolean supportsNonNullableColumns() raises (SQLException); - /** <TRUE/>, if the database supports ODBC Minimum SQL grammar, - otherwise <FALSE/>. + /** `TRUE`, if the database supports ODBC Minimum SQL grammar, + otherwise `FALSE`. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ boolean supportsMinimumSQLGrammar() raises (SQLException); - /** <TRUE/>, if the database supports ODBC Core SQL grammar, - otherwise <FALSE/>. + /** `TRUE`, if the database supports ODBC Core SQL grammar, + otherwise `FALSE`. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ boolean supportsCoreSQLGrammar() raises (SQLException); /** - <TRUE/>, if the database supports ODBC Extended SQL grammar, - otherwise <FALSE/>. + `TRUE`, if the database supports ODBC Extended SQL grammar, + otherwise `FALSE`. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ boolean supportsExtendedSQLGrammar() raises (SQLException); /** @returns - <TRUE/>, if the database supports ANSI92 entry level SQL grammar, - otherwise <FALSE/>. + `TRUE`, if the database supports ANSI92 entry level SQL grammar, + otherwise `FALSE`. @throws SQLException if a database access error occurs. */ boolean supportsANSI92EntryLevelSQL() raises (SQLException); /** @returns - <TRUE/>, if the database supports ANSI92 intermediate SQL grammar, - otherwise <FALSE/>. + `TRUE`, if the database supports ANSI92 intermediate SQL grammar, + otherwise `FALSE`. @throws SQLException if a database access error occurs. */ boolean supportsANSI92IntermediateSQL() raises (SQLException); /** @returns - <TRUE/>, if the database supports ANSI92 full SQL grammar, - otherwise <FALSE/>. + `TRUE`, if the database supports ANSI92 full SQL grammar, + otherwise `FALSE`. @throws SQLException if a database access error occurs. */ boolean supportsANSI92FullSQL() raises (SQLException); /** returns - <TRUE/>, if the Database supports SQL Integrity Enhancement Facility, - otherwise <FALSE/>. + `TRUE`, if the Database supports SQL Integrity Enhancement Facility, + otherwise `FALSE`. @throws SQLException if a database access error occurs. */ boolean supportsIntegrityEnhancementFacility() raises (SQLException); /** @returns - <TRUE/>, if some form of outer join is supported, - otherwise <FALSE/>. + `TRUE`, if some form of outer join is supported, + otherwise `FALSE`. @throws SQLException if a database access error occurs. */ boolean supportsOuterJoins() raises (SQLException); /** @returns - <TRUE/>, if full nested outer joins are supported, - otherwise <FALSE/>. + `TRUE`, if full nested outer joins are supported, + otherwise `FALSE`. @throws SQLException if a database access error occurs. */ boolean supportsFullOuterJoins() raises (SQLException); /** @returns - <TRUE/>, if there is limited support for outer joins. - (This will be <TRUE/> if supportFullOuterJoins is <TRUE/>.) - <FALSE/> is returned otherwise. + `TRUE`, if there is limited support for outer joins. + (This will be `TRUE` if supportFullOuterJoins is `TRUE`.) + `FALSE` is returned otherwise. @throws SQLException if a database access error occurs. */ @@ -577,7 +577,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the database vendor's preferred term for "schema" @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -585,7 +585,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the database vendor's preferred term for "procedure" @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -593,7 +593,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the database vendor's preferred term for "catalog" @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -602,7 +602,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Does a catalog appear at the start of a qualified table name? (Otherwise it appears at the end) @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -610,7 +610,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the separator between catalog and table name @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -618,7 +618,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can a schema name be used in a data manipulation statement? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -626,7 +626,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can a schema name be used in a procedure call statement? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -634,7 +634,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can a schema name be used in a table definition statement? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -642,7 +642,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can a schema name be used in an index definition statement? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -650,7 +650,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can a schema name be used in a privilege definition statement? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -659,7 +659,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can a catalog name be used in a data manipulation statement? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -667,7 +667,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can a catalog name be used in a procedure call statement? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -675,7 +675,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can a catalog name be used in a table definition statement? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -683,7 +683,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can a catalog name be used in an index definition statement? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -691,7 +691,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can a catalog name be used in a privilege definition statement? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -700,7 +700,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Is positioned DELETE supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -708,7 +708,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Is positioned UPDATE supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -716,7 +716,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Is SELECT for UPDATE supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -725,7 +725,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Are stored procedure calls using the stored procedure escape syntax supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -733,7 +733,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Are subqueries in comparison expressions supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -741,7 +741,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Are subqueries in "exists" expressions supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -749,7 +749,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Are subqueries in "in" statements supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -757,7 +757,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Are subqueries in quantified expressions supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -765,7 +765,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Are correlated subqueries supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -773,7 +773,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Is SQL UNION supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -781,7 +781,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Is SQL UNION ALL supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -789,7 +789,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can cursors remain open across commits? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -797,7 +797,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can cursors remain open across rollbacks? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -805,7 +805,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can statements remain open across commits? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -813,7 +813,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can statements remain open across rollbacks? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -822,7 +822,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximal number of hex characters in an inline binary literal @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -830,7 +830,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the max length for a character literal @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -838,7 +838,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the limit on column name length @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -846,7 +846,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum number of columns in a "GROUP BY" clause @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -854,7 +854,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum number of columns allowed in an index @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -862,7 +862,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum number of columns in an "ORDER BY" clause @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -870,7 +870,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum number of columns in a "SELECT" list @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -878,7 +878,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum number of columns in a table @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -886,7 +886,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the number of active connections at a time to this database. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -894,7 +894,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum cursor name length @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -902,7 +902,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum length of an index (in bytes) @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -910,7 +910,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum length allowed for a schema name @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -918,7 +918,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum length of a procedure name @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -926,7 +926,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum length of a catalog name @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -934,7 +934,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum length of a single row. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -943,7 +943,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -951,7 +951,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum length of a SQL statement @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -959,7 +959,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximal number of open active statements at one time to this database @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -967,7 +967,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum length of a table name @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -975,7 +975,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum number of tables in a SELECT statement @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -983,7 +983,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** return the maximum length of a user name @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -993,7 +993,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface The values are defined in com::sun::star::sdbc::TransactionIsolation. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. @see com::sun::star::sdbc::XConnection @@ -1006,7 +1006,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface is a noop and the isolation level is TransactionIsolation_NONE. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -1014,7 +1014,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Does this database support the given transaction isolation level? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. @see com::sun::star::sdbc::Connection @@ -1025,7 +1025,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** support the Database both data definition and data manipulation statements within a transaction? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. <!-- JRH: Unclear on the intent of these many support questions. @@ -1042,7 +1042,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** are only data manipulation statements within a transaction supported? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -1052,7 +1052,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** does a data definition statement within a transaction force the transaction to commit? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -1061,7 +1061,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** is a data definition statement within a transaction ignored? @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -1082,10 +1082,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>PROCEDURE_CAT</b> string => procedure catalog (may be <NULL/>) + <b>PROCEDURE_CAT</b> string => procedure catalog (may be `NULL`) </li> <li> - <b>PROCEDURE_SCHEM</b> string => procedure schema (may be <NULL/>) + <b>PROCEDURE_SCHEM</b> string => procedure schema (may be `NULL`) </li> <li> <b>PROCEDURE_NAME</b> string => procedure name @@ -1112,7 +1112,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> </ol> @param catalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param schemaPattern a schema name pattern; "" retrieves those without a schema @param procedureNamePattern @@ -1141,10 +1141,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>PROCEDURE_CAT</b> string => procedure catalog (may be <NULL/>) + <b>PROCEDURE_CAT</b> string => procedure catalog (may be `NULL`) </li> <li> - <b>PROCEDURE_SCHEM</b> string => procedure schema (may be <NULL/>) + <b>PROCEDURE_SCHEM</b> string => procedure schema (may be `NULL`) </li> <li> <b>PROCEDURE_NAME</b> string => procedure name @@ -1209,7 +1209,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface REMARKS can be defined by the database. </p> @param catalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param schemaPattern a schema name pattern; "" retrieves those without a schema @param procedureNamePattern @@ -1237,10 +1237,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_CAT</b> string => table catalog (may be <NULL/>) + <b>TABLE_CAT</b> string => table catalog (may be `NULL`) </li> <li> - <b>TABLE_SCHEM</b> string => table schema (may be <NULL/>) + <b>TABLE_SCHEM</b> string => table schema (may be `NULL`) </li> <li> <b>TABLE_NAME</b> string => table name @@ -1259,7 +1259,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface all tables. </p> @param catalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param schemaPattern a schema name pattern; "" retrieves those without a schema @param tableNamePattern @@ -1343,10 +1343,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_CAT</b> string => table catalog (may be <NULL/>) + <b>TABLE_CAT</b> string => table catalog (may be `NULL`) </li> <li> - <b>TABLE_SCHEM</b> string => table schema (may be <NULL/>) + <b>TABLE_SCHEM</b> string => table schema (may be `NULL`) </li> <li> <b>TABLE_NAME</b> string => table name @@ -1387,10 +1387,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>REMARKS</b> string => comment describing column (may be <NULL/>) + <b>REMARKS</b> string => comment describing column (may be `NULL`) </li> <li> - <b>COLUMN_DEF</b> string => default value (may be <NULL/>) + <b>COLUMN_DEF</b> string => default value (may be `NULL`) </li> <li> <b>SQL_DATA_TYPE</b> long => unused @@ -1413,7 +1413,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> </ol> @param catalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param schemaPattern a schema name pattern; "" retrieves those without a schema @param tableNamePattern @@ -1440,10 +1440,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_CAT</b> string => table catalog (may be <NULL/>) + <b>TABLE_CAT</b> string => table catalog (may be `NULL`) </li> <li> - <b>TABLE_SCHEM</b> string => table schema (may be <NULL/>) + <b>TABLE_SCHEM</b> string => table schema (may be `NULL`) </li> <li> <b>TABLE_NAME</b> string => table name @@ -1452,7 +1452,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>COLUMN_NAME</b> string => column name </li> <li> - <b>GRANTOR</b> => granter of access (may be <NULL/>) + <b>GRANTOR</b> => granter of access (may be `NULL`) </li> <li> <b>GRANTEE</b> string => grantee of access @@ -1463,11 +1463,11 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>IS_GRANTABLE</b> string => "YES" if grantee is permitted - to grant to others; "NO" if not; <NULL/> if unknown + to grant to others; "NO" if not; `NULL` if unknown </li> </ol> @param catalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param schema a schema name ; "" retrieves those without a schema @param table @@ -1485,8 +1485,8 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** gets a description of the access rights for each table available in a catalog. Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that - this privilege applies to all columns (this may be <TRUE/> for - some systems but is not <TRUE/> for all.) + this privilege applies to all columns (this may be `TRUE` for + some systems but is not `TRUE` for all.) <p>Only privileges matching the schema and table name @@ -1497,16 +1497,16 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_CAT</b> string => table catalog (may be <NULL/>) + <b>TABLE_CAT</b> string => table catalog (may be `NULL`) </li> <li> - <b>TABLE_SCHEM</b> string => table schema (may be <NULL/>) + <b>TABLE_SCHEM</b> string => table schema (may be `NULL`) </li> <li> <b>TABLE_NAME</b> string => table name </li> <li> - <b>GRANTOR</b> => granter of access (may be <NULL/>) + <b>GRANTOR</b> => granter of access (may be `NULL`) </li> <li> <b>GRANTEE</b> string => grantee of access @@ -1517,11 +1517,11 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>IS_GRANTABLE</b> string => "YES" if grantee is permitted - to grant to others; "NO" if not; <NULL/> if unknown + to grant to others; "NO" if not; `NULL` if unknown </li> </ol> @param catalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param schemaPattern a schema name pattern; "" retrieves those without a schema @param tableNamePattern @@ -1585,7 +1585,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> </ol> @param catalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param schema a schema name; "" retrieves those without a schema @param table @@ -1646,7 +1646,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> </ol> @param catalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param schema a schema name; "" retrieves those without a schema @param table @@ -1667,10 +1667,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_CAT</b> string => table catalog (may be <NULL/>) + <b>TABLE_CAT</b> string => table catalog (may be `NULL`) </li> <li> - <b>TABLE_SCHEM</b> string => table schema (may be <NULL/>) + <b>TABLE_SCHEM</b> string => table schema (may be `NULL`) </li> <li> <b>TABLE_NAME</b> string => table name @@ -1682,11 +1682,11 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>KEY_SEQ</b> short => sequence number within primary key </li> <li> - <b>PK_NAME</b> string => primary key name (may be <NULL/>) + <b>PK_NAME</b> string => primary key name (may be `NULL`) </li> </ol> @param catalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param schema a schema name; "" retrieves those without a schema @param table @@ -1710,11 +1710,11 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface <ol> <li> <b>PKTABLE_CAT</b> string => primary key table catalog - being imported (may be <NULL/>) + being imported (may be `NULL`) </li> <li> <b>PKTABLE_SCHEM</b> string => primary key table schema - being imported (may be <NULL/>) + being imported (may be `NULL`) </li> <li> <b>PKTABLE_NAME</b> string => primary key table name @@ -1725,10 +1725,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface being imported </li> <li> - <b>FKTABLE_CAT</b> string => foreign key table catalog (may be <NULL/>) + <b>FKTABLE_CAT</b> string => foreign key table catalog (may be `NULL`) </li> <li> - <b>FKTABLE_SCHEM</b> string => foreign key table schema (may be <NULL/>) + <b>FKTABLE_SCHEM</b> string => foreign key table schema (may be `NULL`) </li> <li> <b>FKTABLE_NAME</b> string => foreign key table name @@ -1781,10 +1781,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>FK_NAME</b> string => foreign key name (may be <NULL/>) + <b>FK_NAME</b> string => foreign key name (may be `NULL`) </li> <li> - <b>PK_NAME</b> string => primary key name (may be <NULL/>) + <b>PK_NAME</b> string => primary key name (may be `NULL`) </li> <li> <b>DEFERRABILITY</b> short => can the evaluation of foreign key @@ -1800,7 +1800,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> </ol> @param catalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param schema a schema name; "" retrieves those without a schema @param table @@ -1823,10 +1823,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>PKTABLE_CAT</b> string => primary key table catalog (may be <NULL/>) + <b>PKTABLE_CAT</b> string => primary key table catalog (may be `NULL`) </li> <li> - <b>PKTABLE_SCHEM</b> string => primary key table schema (may be <NULL/>) + <b>PKTABLE_SCHEM</b> string => primary key table schema (may be `NULL`) </li> <li> <b>PKTABLE_NAME</b> string => primary key table name @@ -1835,12 +1835,12 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>PKCOLUMN_NAME</b> string => primary key column name </li> <li> - <b>FKTABLE_CAT</b> string => foreign key table catalog (may be <NULL/>) - being exported (may be <NULL/>) + <b>FKTABLE_CAT</b> string => foreign key table catalog (may be `NULL`) + being exported (may be `NULL`) </li> <li> - <b>FKTABLE_SCHEM</b> string => foreign key table schema (may be <NULL/>) - being exported (may be <NULL/>) + <b>FKTABLE_SCHEM</b> string => foreign key table schema (may be `NULL`) + being exported (may be `NULL`) </li> <li> <b>FKTABLE_NAME</b> string => foreign key table name @@ -1895,10 +1895,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>FK_NAME</b> string => foreign key name (may be <NULL/>) + <b>FK_NAME</b> string => foreign key name (may be `NULL`) </li> <li> - <b>PK_NAME</b> string => primary key name (may be <NULL/>) + <b>PK_NAME</b> string => primary key name (may be `NULL`) </li> <li> <b>DEFERRABILITY</b> short => can the evaluation of foreign key @@ -1914,7 +1914,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> </ol> @param catalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param schema a schema name; "" retrieves those without a schema @param table @@ -1940,10 +1940,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>PKTABLE_CAT</b> string => primary key table catalog (may be <NULL/>) + <b>PKTABLE_CAT</b> string => primary key table catalog (may be `NULL`) </li> <li> - <b>PKTABLE_SCHEM</b> string => primary key table schema (may be <NULL/>) + <b>PKTABLE_SCHEM</b> string => primary key table schema (may be `NULL`) </li> <li> <b>PKTABLE_NAME</b> string => primary key table name @@ -1952,12 +1952,12 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>PKCOLUMN_NAME</b> string => primary key column name </li> <li> - <b>FKTABLE_CAT</b> string => foreign key table catalog (may be <NULL/>) - being exported (may be <NULL/>) + <b>FKTABLE_CAT</b> string => foreign key table catalog (may be `NULL`) + being exported (may be `NULL`) </li> <li> - <b>FKTABLE_SCHEM</b> string => foreign key table schema (may be <NULL/>) - being exported (may be <NULL/>) + <b>FKTABLE_SCHEM</b> string => foreign key table schema (may be `NULL`) + being exported (may be `NULL`) </li> <li> <b>FKTABLE_NAME</b> string => foreign key table name @@ -2012,10 +2012,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>FK_NAME</b> string => foreign key name (may be <NULL/>) + <b>FK_NAME</b> string => foreign key name (may be `NULL`) </li> <li> - <b>PK_NAME</b> string => primary key name (may be <NULL/>) + <b>PK_NAME</b> string => primary key name (may be `NULL`) </li> <li> <b>DEFERRABILITY</b> short => can the evaluation of foreign key @@ -2031,13 +2031,13 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> </ol> @param primaryCatalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param primarySchema a schema name; "" retrieves those without a schema @param primaryTable the table name that exports the key @param foreignCatalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param foreignSchema a schema name; "" retrieves those without a schema @param foreignTable @@ -2073,15 +2073,15 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>LITERAL_PREFIX</b> string => prefix used to quote a literal - (may be <NULL/>) + (may be `NULL`) </li> <li> <b>LITERAL_SUFFIX</b> string => suffix used to quote a literal - (may be <NULL/>) + (may be `NULL`) </li> <li> <b>CREATE_PARAMS</b> string => parameters used in creating - the type (may be <NULL/>) + the type (may be `NULL`) </li> <li> <b>NULLABLE</b> short => can you use NULL for this type? @@ -2122,7 +2122,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>LOCAL_TYPE_NAME</b> string => localized version of type name - (may be <NULL/>) + (may be `NULL`) </li> <li> <b>MINIMUM_SCALE</b> short => minimum scale supported @@ -2155,24 +2155,24 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_CAT</b> string => table catalog (may be <NULL/>) + <b>TABLE_CAT</b> string => table catalog (may be `NULL`) </li> <li> - <b>TABLE_SCHEM</b> string => table schema (may be <NULL/>) + <b>TABLE_SCHEM</b> string => table schema (may be `NULL`) </li> <li> <b>TABLE_NAME</b> string => table name </li> <li> <b>NON_UNIQUE</b> boolean => Can index values be non-unique? - <FALSE/> when TYPE is tableIndexStatistic + `FALSE` when TYPE is tableIndexStatistic </li> <li> - <b>INDEX_QUALIFIER</b> string => index catalog (may be <NULL/>); - <NULL/> when TYPE is tableIndexStatistic + <b>INDEX_QUALIFIER</b> string => index catalog (may be `NULL`); + `NULL` when TYPE is tableIndexStatistic </li> <li> - <b>INDEX_NAME</b> string => index name; <NULL/> when TYPE is + <b>INDEX_NAME</b> string => index name; `NULL` when TYPE is tableIndexStatistic </li> <li> @@ -2194,13 +2194,13 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface within index; zero when TYPE is tableIndexStatistic </li> <li> - <b>COLUMN_NAME</b> string => column name; <NULL/> when TYPE is + <b>COLUMN_NAME</b> string => column name; `NULL` when TYPE is tableIndexStatistic </li> <li> <b>ASC_OR_DESC</b> string => column sort sequence, "A" => ascending, - "D" => descending, may be <NULL/> if sort sequence is not supported; - <NULL/> when TYPE is tableIndexStatistic + "D" => descending, may be `NULL` if sort sequence is not supported; + `NULL` when TYPE is tableIndexStatistic </li> <li> <b>CARDINALITY</b> long => When TYPE is tableIndexStatistic, then @@ -2214,19 +2214,19 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>FILTER_CONDITION</b> string => Filter condition, if any. - (may be <NULL/>) + (may be `NULL`) </li> </ol> @param catalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param schema a schema name; "" retrieves those without a schema @param table the table name that exports the key @param unique - when <TRUE/>, return only indices for unique values; when <FALSE/>, return indices regardless of whether unique or not + when `TRUE`, return only indices for unique values; when `FALSE`, return indices regardless of whether unique or not @param approximate - when <TRUE/>, result is allowed to reflect approximate or out of data values; when <FALSE/>, results are requested to be accurate + when `TRUE`, result is allowed to reflect approximate or out of data values; when `FALSE`, results are requested to be accurate @returns each row is an index column description @throws SQLException @@ -2241,7 +2241,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface defined in com::sun::star::sdbc::ResultSetType @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -2256,7 +2256,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface defined in com::sun::star::sdbc::ResultSetConcurrency @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -2269,7 +2269,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface defined in com::sun::star::sdbc::ResultSetType @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -2280,7 +2280,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface defined in com::sun::star::sdbc::ResultSetType @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -2291,7 +2291,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface defined in com::sun::star::sdbc::ResultSetType @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -2302,7 +2302,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface defined in com::sun::star::sdbc::ResultSetType @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -2313,7 +2313,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface defined in com::sun::star::sdbc::ResultSetType @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -2324,7 +2324,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface defined in com::sun::star::sdbc::ResultSetType @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -2337,7 +2337,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface defined in com::sun::star::sdbc::ResultSetType @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -2347,12 +2347,12 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface calling com::sun::star::sdbc::XResultSet::rowDeleted() . If deletesAreDetected() - returns <FALSE/>, then deleted rows are removed from the result set. + returns `FALSE`, then deleted rows are removed from the result set. @param setType defined in com::sun::star::sdbc::ResultSetType @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -2365,7 +2365,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface defined in com::sun::star::sdbc::ResultSetType @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -2373,7 +2373,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface /** indicates whether the driver supports batch updates. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -2394,10 +2394,10 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TYPE_CAT</b> string => the type's catalog (may be <NULL/>) + <b>TYPE_CAT</b> string => the type's catalog (may be `NULL`) </li> <li> - <b>TYPE_SCHEM</b> string => type's schema (may be <NULL/>) + <b>TYPE_SCHEM</b> string => type's schema (may be `NULL`) </li> <li> <b>TYPE_NAME</b> string => type name @@ -2418,7 +2418,7 @@ published interface XDatabaseMetaData: com::sun::star::uno::XInterface result set is returned. </p> @param catalog - a catalog name; "" retrieves those without a catalog; <VOID/> means drop catalog name from the selection criteria + a catalog name; "" retrieves those without a catalog; `VOID` means drop catalog name from the selection criteria @param schemaPattern a schema name pattern; "" retrieves those without a schema @param typeNamePattern diff --git a/offapi/com/sun/star/sdbc/XDriver.idl b/offapi/com/sun/star/sdbc/XDriver.idl index 9b645598d53d..ee45d105b5d6 100644 --- a/offapi/com/sun/star/sdbc/XDriver.idl +++ b/offapi/com/sun/star/sdbc/XDriver.idl @@ -61,7 +61,7 @@ published interface XDriver: com::sun::star::uno::XInterface /** attempts to make a database connection to the given URL. The driver should return - <NULL/> + `NULL` if it realizes it is the wrong kind of driver to connect to the given URL. This will be common, as when the driver manager is asked to connect to a given URL it passes @@ -105,15 +105,15 @@ published interface XDriver: com::sun::star::uno::XInterface [in]sequence<com::sun::star::beans::PropertyValue> info) raises (SQLException); - /** returns <TRUE/> if the driver thinks that it can open a connection - to the given URL. Typically drivers will return <TRUE/> if they - understand the subprotocol specified in the URL and <FALSE/> if + /** returns `TRUE` if the driver thinks that it can open a connection + to the given URL. Typically drivers will return `TRUE` if they + understand the subprotocol specified in the URL and `FALSE` if they do not. @param url is the URL of the database to which to connect. @returns - <TRUE/> if this driver can connect to the given URL. + `TRUE` if this driver can connect to the given URL. @throws SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/sdbc/XMultipleResults.idl b/offapi/com/sun/star/sdbc/XMultipleResults.idl index c06569efcaa7..d496243f1386 100644 --- a/offapi/com/sun/star/sdbc/XMultipleResults.idl +++ b/offapi/com/sun/star/sdbc/XMultipleResults.idl @@ -77,7 +77,7 @@ published interface XMultipleResults: com::sun::star::uno::XInterface */ long getUpdateCount() raises (SQLException); - /** moves to a Statement's next result. It returns <TRUE/> if + /** moves to a Statement's next result. It returns `TRUE` if this result is a ResultSet. This method also implicitly closes any current ResultSet obtained with getResultSet. @@ -87,7 +87,7 @@ published interface XMultipleResults: com::sun::star::uno::XInterface </p> @returns - <TRUE/> if there exists more ResultSet objects + `TRUE` if there exists more ResultSet objects @throws SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/sdbc/XParameters.idl b/offapi/com/sun/star/sdbc/XParameters.idl index 46e87d1c4348..6347f511e4a0 100644 --- a/offapi/com/sun/star/sdbc/XParameters.idl +++ b/offapi/com/sun/star/sdbc/XParameters.idl @@ -101,7 +101,7 @@ published interface XParameters: com::sun::star::uno::XInterface @param parameterIndex the first parameter is 1, the second is 2, ... @param sqlType - the type of the column to set to <NULL/> + the type of the column to set to `NULL` @param typeName the name of the type @throws SQLException diff --git a/offapi/com/sun/star/sdbc/XPreparedStatement.idl b/offapi/com/sun/star/sdbc/XPreparedStatement.idl index fade1626839b..485a686037b2 100644 --- a/offapi/com/sun/star/sdbc/XPreparedStatement.idl +++ b/offapi/com/sun/star/sdbc/XPreparedStatement.idl @@ -73,7 +73,7 @@ published interface XPreparedStatement: com::sun::star::uno::XInterface form of statements handled by executeQuery and executeUpdate. </p> @returns - <TRUE/> if successful + `TRUE` if successful @throws SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/sdbc/XResultSet.idl b/offapi/com/sun/star/sdbc/XResultSet.idl index 30545b32161f..c2f9d627d9fb 100644 --- a/offapi/com/sun/star/sdbc/XResultSet.idl +++ b/offapi/com/sun/star/sdbc/XResultSet.idl @@ -59,7 +59,7 @@ published interface XResultSet: com::sun::star::uno::XInterface The ResultSet's warning chain is cleared when a new row is read. </p> @returns - <TRUE/> if successful + `TRUE` if successful @throws SQLException if a database access error occurs. */ @@ -68,7 +68,7 @@ published interface XResultSet: com::sun::star::uno::XInterface /** indicates whether the cursor is before the first row in the result set. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -77,7 +77,7 @@ published interface XResultSet: com::sun::star::uno::XInterface /** indicates whether the cursor is after the last row in the result set. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -85,7 +85,7 @@ published interface XResultSet: com::sun::star::uno::XInterface /** indicates whether the cursor is on the first row of the result set. @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -104,7 +104,7 @@ published interface XResultSet: com::sun::star::uno::XInterface to determine whether the current row is the last row in the result set. </p> @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -126,7 +126,7 @@ published interface XResultSet: com::sun::star::uno::XInterface /** moves the cursor to the first row in the result set. @returns - <TRUE/> if successful + `TRUE` if successful @throws SQLException if a database access error occurs. */ @@ -134,7 +134,7 @@ published interface XResultSet: com::sun::star::uno::XInterface /** moves the cursor to the last row in the result set. @returns - <TRUE/> if successful + `TRUE` if successful @throws SQLException if a database access error occurs. */ @@ -209,7 +209,7 @@ published interface XResultSet: com::sun::star::uno::XInterface @param rows how many rows should be moved relative to the current row @returns - <TRUE/> if successful + `TRUE` if successful @throws SQLException if a database access error occurs. */ @@ -228,7 +228,7 @@ published interface XResultSet: com::sun::star::uno::XInterface when there is no current row. </p> @returns - <TRUE/> if successful + `TRUE` if successful @throws SQLException if a database access error occurs. */ @@ -265,7 +265,7 @@ published interface XResultSet: com::sun::star::uno::XInterface /** indicates whether the current row has been updated. The value returned depends on whether or not the result set can detect updates. @returns - <TRUE/> if successful + `TRUE` if successful @throws SQLException if a database access error occurs. */ @@ -274,7 +274,7 @@ published interface XResultSet: com::sun::star::uno::XInterface /** indicates whether the current row has had an insertion. The value returned depends on whether or not the result set can detect visible inserts. @returns - <TRUE/> if successful + `TRUE` if successful @throws SQLException if a database access error occurs. */ @@ -285,7 +285,7 @@ published interface XResultSet: com::sun::star::uno::XInterface detect holes in a result set. The value returned depends on whether or not the result set can detect deletions. @returns - <TRUE/> if successful + `TRUE` if successful @throws SQLException if a database access error occurs. */ @@ -296,7 +296,7 @@ published interface XResultSet: com::sun::star::uno::XInterface object. If the result set was generated some other way, such as by an com::sun::star::sdbc::XDatabaseMetaData method, this method returns - <NULL/> + `NULL` . @returns the statement object diff --git a/offapi/com/sun/star/sdbc/XResultSetMetaData.idl b/offapi/com/sun/star/sdbc/XResultSetMetaData.idl index 9210835d11c1..77bf257d7b6b 100644 --- a/offapi/com/sun/star/sdbc/XResultSetMetaData.idl +++ b/offapi/com/sun/star/sdbc/XResultSetMetaData.idl @@ -44,7 +44,7 @@ published interface XResultSetMetaData: com::sun::star::uno::XInterface @param column the first column is 1, the second is 2, @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -54,7 +54,7 @@ published interface XResultSetMetaData: com::sun::star::uno::XInterface @param column the first column is 1, the second is 2, @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -64,7 +64,7 @@ published interface XResultSetMetaData: com::sun::star::uno::XInterface @param column the first column is 1, the second is 2, @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -74,7 +74,7 @@ published interface XResultSetMetaData: com::sun::star::uno::XInterface @param column the first column is 1, the second is 2, @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -84,7 +84,7 @@ published interface XResultSetMetaData: com::sun::star::uno::XInterface @param column the first column is 1, the second is 2, @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -94,7 +94,7 @@ published interface XResultSetMetaData: com::sun::star::uno::XInterface @param column the first column is 1, the second is 2, @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -205,7 +205,7 @@ published interface XResultSetMetaData: com::sun::star::uno::XInterface @param column the first column is 1, the second is 2, @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -215,7 +215,7 @@ published interface XResultSetMetaData: com::sun::star::uno::XInterface @param column the first column is 1, the second is 2, @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ @@ -225,7 +225,7 @@ published interface XResultSetMetaData: com::sun::star::uno::XInterface @param column the first column is 1, the second is 2, @returns - <TRUE/> if so + `TRUE` if so @throws SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/sdbc/XRow.idl b/offapi/com/sun/star/sdbc/XRow.idl index ae20e20af876..9a2912dc4560 100644 --- a/offapi/com/sun/star/sdbc/XRow.idl +++ b/offapi/com/sun/star/sdbc/XRow.idl @@ -59,7 +59,7 @@ published interface XRow: com::sun::star::uno::XInterface SQL NULL. @returns - <TRUE/> if last column read was SQL NULL and <FALSE/> otherwise + `TRUE` if last column read was SQL NULL and `FALSE` otherwise @throws SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/sdbc/XSQLInput.idl b/offapi/com/sun/star/sdbc/XSQLInput.idl index bc504e8142d0..9b3171382af2 100644 --- a/offapi/com/sun/star/sdbc/XSQLInput.idl +++ b/offapi/com/sun/star/sdbc/XSQLInput.idl @@ -247,7 +247,7 @@ published interface XSQLInput: com::sun::star::uno::XInterface /** determines whether the last value read was null. @returns - <TRUE/> if the most recently gotten SQL value was null; otherwise, <FALSE/> + `TRUE` if the most recently gotten SQL value was null; otherwise, `FALSE` @throws SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/sdbc/XSQLOutput.idl b/offapi/com/sun/star/sdbc/XSQLOutput.idl index 27faae2cae8c..c454ecaee47f 100644 --- a/offapi/com/sun/star/sdbc/XSQLOutput.idl +++ b/offapi/com/sun/star/sdbc/XSQLOutput.idl @@ -197,7 +197,7 @@ published interface XSQLOutput: com::sun::star::uno::XInterface >When the <code>XSQLData</code> object is - <NULL/> + `NULL` , this method writes an SQL NULL to the stream. Otherwise, it calls the com::sun::star::sdbc::XSQLData::writeSQL() diff --git a/offapi/com/sun/star/sdbc/XStatement.idl b/offapi/com/sun/star/sdbc/XStatement.idl index 81a7d6fb7f62..ec0ae6641038 100644 --- a/offapi/com/sun/star/sdbc/XStatement.idl +++ b/offapi/com/sun/star/sdbc/XStatement.idl @@ -51,7 +51,7 @@ published interface XStatement: com::sun::star::uno::XInterface @param sql the SQL statement which should be executed @returns - a ResultSet that contains the data produced by the query; never <NULL/> + a ResultSet that contains the data produced by the query; never `NULL` @throws SQLException if a database access error occurs. */ @@ -97,7 +97,7 @@ published interface XStatement: com::sun::star::uno::XInterface @param sql any SQL statement @returns - <TRUE/> if the next result is a ResultSet; <FALSE/> if it is an update count or there are no more results + `TRUE` if the next result is a ResultSet; `FALSE` if it is an update count or there are no more results @throws SQLException if a database access error occurs. */ diff --git a/offapi/com/sun/star/sdbc/XStruct.idl b/offapi/com/sun/star/sdbc/XStruct.idl index c9a77b6a40bf..7b512d5ea7b9 100644 --- a/offapi/com/sun/star/sdbc/XStruct.idl +++ b/offapi/com/sun/star/sdbc/XStruct.idl @@ -67,7 +67,7 @@ published interface XStruct: com::sun::star::uno::XInterface This method uses the given type map for customizations of the type mappings. If there is no entry in the given type map that matches or the given type map is - <NULL/> + `NULL` , the structured type that this <code>Struct</code> object represents, the driver uses @@ -76,7 +76,7 @@ published interface XStruct: com::sun::star::uno::XInterface is a map object that contains mappings of SQL type names to services. If the <code>typeMap</code>is - <NULL/> + `NULL` , the type-map associated with the connection for customizations of the type-mappings is used. diff --git a/offapi/com/sun/star/sdbcx/PreparedStatement.idl b/offapi/com/sun/star/sdbcx/PreparedStatement.idl index 3fe7b639bf01..12edbb062eed 100644 --- a/offapi/com/sun/star/sdbcx/PreparedStatement.idl +++ b/offapi/com/sun/star/sdbcx/PreparedStatement.idl @@ -36,7 +36,7 @@ published service PreparedStatement /** returns if a result set should allow the navigation with bookmarks or not. The default is - <FALSE/> + `FALSE` . */ [property] boolean UseBookmarks; diff --git a/offapi/com/sun/star/sdbcx/Statement.idl b/offapi/com/sun/star/sdbcx/Statement.idl index e626438b6dbc..9a045f839892 100644 --- a/offapi/com/sun/star/sdbcx/Statement.idl +++ b/offapi/com/sun/star/sdbcx/Statement.idl @@ -36,10 +36,10 @@ published service Statement /** returns - <TRUE/> + `TRUE` if a result set should allow navigation with bookmarks or not. The default is - <FALSE/> + `FALSE` . */ [property] boolean UseBookmarks; diff --git a/offapi/com/sun/star/sdbcx/XRowLocate.idl b/offapi/com/sun/star/sdbcx/XRowLocate.idl index 05c5bde0d9df..2fc16bc7bf24 100644 --- a/offapi/com/sun/star/sdbcx/XRowLocate.idl +++ b/offapi/com/sun/star/sdbcx/XRowLocate.idl @@ -59,7 +59,7 @@ published interface XRowLocate: com::sun::star::uno::XInterface @param bookmark the bookmark where to move @returns - <TRUE/> if successful + `TRUE` if successful @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ @@ -81,7 +81,7 @@ published interface XRowLocate: com::sun::star::uno::XInterface @param rows count of rows move relative to the bookmark @returns - <TRUE/> if successful + `TRUE` if successful @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ @@ -114,7 +114,7 @@ published interface XRowLocate: com::sun::star::uno::XInterface /** determines whether the bookmarks of a result set are ordered or not. @returns - <TRUE/> if so + `TRUE` if so @throws com::sun::star::sdbc::SQLException if a database access error occurs. @see com::sun::star::sdbcx::CompareBookmark diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl index 7f0ac23fc0ee..6ed967dd3527 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl @@ -36,9 +36,9 @@ published struct DataPilotFieldGroupInfo automatically from the minimum of the item values. <p><ul> - <li>If <FALSE/> is set, the value from #Start will be + <li>If `FALSE` is set, the value from #Start will be used as start value for the grouping.</li> - <li>If <TRUE/> is set, the start value for the grouping will be + <li>If `TRUE` is set, the start value for the grouping will be calculated automatically from the minimum of all member values of the DataPilot field.</li> </ul></p> @@ -50,9 +50,9 @@ published struct DataPilotFieldGroupInfo automatically from the maximum of the item values. <p><ul> - <li>If <FALSE/> is set, the value from #End will be + <li>If `FALSE` is set, the value from #End will be used as end value for the grouping.</li> - <li>If <TRUE/> is set, the end value for the grouping will be + <li>If `TRUE` is set, the end value for the grouping will be calculated automatically from the maximum of all member values of the DataPilot field.</li> </ul></p> @@ -63,12 +63,12 @@ published struct DataPilotFieldGroupInfo /** specifies whether date values are grouped by ranges of days. <p><ul> - <li>If <FALSE/> is set, and #GroupBy contains zero, + <li>If `FALSE` is set, and #GroupBy contains zero, grouping is performed inplace on the item values.</li> - <li>If <FALSE/> is set, and #GroupBy contains one or + <li>If `FALSE` is set, and #GroupBy contains one or more flags from DataPilotFieldGroupBy, grouping is performed on date or time.</li> - <li>If <TRUE/> is set, #Step contains a value greater + <li>If `TRUE` is set, #Step contains a value greater than or equal to 1, and #GroupBy set to <const> DataPilotFieldGroupBy::DAYS</const>, grouping is performed on ranges of days (see descriptions for <member> @@ -80,20 +80,20 @@ published struct DataPilotFieldGroupInfo /** specifies the start value for the grouping if <member>HasAutoStart - </member> is set to <FALSE/>. + </member> is set to `FALSE`. */ double Start; /** specifies the end value for the grouping if <member>HasAutoEnd - </member> is set to <FALSE/>. + </member> is set to `FALSE`. */ double End; /** specifies the size of the ranges for numeric or day grouping. - <p>Example: With #HasAutoStart set to <FALSE/>, + <p>Example: With #HasAutoStart set to `FALSE`, #Start set to 2, and #Step set to 3, the first group will contain all values greater than or equal to 2 and less than 5. The second group will contain all values greater than or @@ -110,7 +110,7 @@ published struct DataPilotFieldGroupInfo /** contains the source DataPilot field grouping is based on. Will be - <NULL/> if this field is not grouped or contains numeric grouping. + `NULL` if this field is not grouped or contains numeric grouping. @see DataPilotField */ diff --git a/offapi/com/sun/star/sheet/DataPilotFieldLayoutInfo.idl b/offapi/com/sun/star/sheet/DataPilotFieldLayoutInfo.idl index 3ddc67df6a5b..5e84303d4f46 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldLayoutInfo.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldLayoutInfo.idl @@ -38,7 +38,7 @@ published struct DataPilotFieldLayoutInfo long LayoutMode; - /** If <TRUE/>, an empty row is inserted in the DataPilotTable + /** If `TRUE`, an empty row is inserted in the DataPilotTable result table after the data (including the subtotals) for each item of the field. */ diff --git a/offapi/com/sun/star/sheet/DataPilotFieldSortInfo.idl b/offapi/com/sun/star/sheet/DataPilotFieldSortInfo.idl index a277bec75fc2..70fc9443aef9 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldSortInfo.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldSortInfo.idl @@ -35,8 +35,8 @@ published struct DataPilotFieldSortInfo string Field; - /** <TRUE/> if data are sorted in ascending order, - <FALSE/> if in descending order. + /** `TRUE` if data are sorted in ascending order, + `FALSE` if in descending order. */ boolean IsAscending; diff --git a/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl b/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl index f26c4219cea8..2309d172e9ef 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl @@ -78,12 +78,12 @@ service DataPilotSourceDimension /** returns the name of the dimension from which this dimension was - cloned, or <NULL/> if it was not cloned. + cloned, or `NULL` if it was not cloned. */ [readonly, property] com::sun::star::container::XNamed Original; - /** contains <TRUE/> if this is the dimension used to layout the + /** contains `TRUE` if this is the dimension used to layout the different data dimensions. */ [readonly, property] boolean IsDataLayoutDimension; diff --git a/offapi/com/sun/star/sheet/DatabaseRange.idl b/offapi/com/sun/star/sheet/DatabaseRange.idl index fd1716a28bb3..77fc61fe6f5b 100644 --- a/offapi/com/sun/star/sheet/DatabaseRange.idl +++ b/offapi/com/sun/star/sheet/DatabaseRange.idl @@ -78,7 +78,7 @@ published service DatabaseRange /** specifies the range where the filter can find the filter criteria. - <p>This is only used if SheetFilterDescriptor::UseFilterCriteriaSource is <TRUE/>.</p> + <p>This is only used if SheetFilterDescriptor::UseFilterCriteriaSource is `TRUE`.</p> @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/sheet/FunctionAccess.idl b/offapi/com/sun/star/sheet/FunctionAccess.idl index 0b039f5e2a19..9b26c286ef59 100644 --- a/offapi/com/sun/star/sheet/FunctionAccess.idl +++ b/offapi/com/sun/star/sheet/FunctionAccess.idl @@ -46,7 +46,7 @@ published service FunctionAccess /** specifies whether the function call is performed as array function call. - <p>If set to <TRUE/>, the result of the function call will be + <p>If set to `TRUE`, the result of the function call will be calculated similar to array formulas in a spreadsheet document. The return value of the function call will usually be a sequence of sequences containing the values of the resulting array. Example: If the @@ -54,14 +54,14 @@ published service FunctionAccess array containing the absolute values of the numbers contained in the specified cell range.</p> - <p>If set to <FALSE/>, the result of the function call will be + <p>If set to `FALSE`, the result of the function call will be calculated similar to simple cell formulas in a spreadsheet document. The return value of the function call will usually be a single value. Of course, some functions always return an array, for example the MUNIT function.</p> <p>For compatibility with older versions, the default value of this - property is <TRUE/>.</p> + property is `TRUE`.</p> @since OOo 3.3 */ diff --git a/offapi/com/sun/star/sheet/RangeSelectionArguments.idl b/offapi/com/sun/star/sheet/RangeSelectionArguments.idl index 49292205cbe0..92fd5e513303 100644 --- a/offapi/com/sun/star/sheet/RangeSelectionArguments.idl +++ b/offapi/com/sun/star/sheet/RangeSelectionArguments.idl @@ -45,9 +45,9 @@ published service RangeSelectionArguments /** specifies if the range selection is limited to a single cell only. - <p>If <TRUE/>, the selection is restricted to a - single cell. If <FALSE/>, multiple adjoining cells can be - selected. The default value is <FALSE/>.</p> + <p>If `TRUE`, the selection is restricted to a + single cell. If `FALSE`, multiple adjoining cells can be + selected. The default value is `FALSE`.</p> @since OOo 2.0.3 */ diff --git a/offapi/com/sun/star/sheet/SheetCell.idl b/offapi/com/sun/star/sheet/SheetCell.idl index e010ac715f92..17c5c917fbbf 100644 --- a/offapi/com/sun/star/sheet/SheetCell.idl +++ b/offapi/com/sun/star/sheet/SheetCell.idl @@ -114,7 +114,7 @@ published service SheetCell <p>The property com::sun::star::util::SearchDescriptor::SearchWords - has a different meaning in spreadsheets: If set to <TRUE/>, the + has a different meaning in spreadsheets: If set to `TRUE`, the spreadsheet searches for cells containing the search text only.</p> */ interface com::sun::star::util::XReplaceable; diff --git a/offapi/com/sun/star/sheet/SheetCellRange.idl b/offapi/com/sun/star/sheet/SheetCellRange.idl index d1d2ed1adc8d..0361a1af4ef1 100644 --- a/offapi/com/sun/star/sheet/SheetCellRange.idl +++ b/offapi/com/sun/star/sheet/SheetCellRange.idl @@ -105,7 +105,7 @@ published service SheetCellRange <p>The property com::sun::star::util::SearchDescriptor::SearchWords - has a different meaning in spreadsheets: If set to <TRUE/>, the + has a different meaning in spreadsheets: If set to `TRUE`, the spreadsheet searches for cells containing the search text only.</p> */ interface com::sun::star::util::XReplaceable; diff --git a/offapi/com/sun/star/sheet/SheetCellRanges.idl b/offapi/com/sun/star/sheet/SheetCellRanges.idl index 87bdf08a65c5..a0f98cdd5aa0 100644 --- a/offapi/com/sun/star/sheet/SheetCellRanges.idl +++ b/offapi/com/sun/star/sheet/SheetCellRanges.idl @@ -86,7 +86,7 @@ published service SheetCellRanges <p>The property com::sun::star::util::SearchDescriptor::SearchWords - has a different meaning in spreadsheets: If set to <TRUE/>, the + has a different meaning in spreadsheets: If set to `TRUE`, the spreadsheet searches for cells containing the search text only.</p> */ interface com::sun::star::util::XReplaceable; diff --git a/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl b/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl index ea27bbc8de8b..5fc6cbcfd948 100644 --- a/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl +++ b/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl @@ -82,7 +82,7 @@ published service SheetFilterDescriptor position is saved for future calls. <p>This is only used if - SheetFilterDescriptor::CopyOutputData is <TRUE/>.</p> + SheetFilterDescriptor::CopyOutputData is `TRUE`.</p> */ [property] boolean SaveOutputPosition; @@ -107,7 +107,7 @@ published service SheetFilterDescriptor /** specifies the position where filtered data are to be copied. <p>This is only used if - SheetFilterDescriptor::CopyOutputData is <TRUE/>.</p> + SheetFilterDescriptor::CopyOutputData is `TRUE`.</p> */ [property] com::sun::star::table::CellAddress OutputPosition; diff --git a/offapi/com/sun/star/sheet/SheetSortDescriptor.idl b/offapi/com/sun/star/sheet/SheetSortDescriptor.idl index 44f0e49f7a09..1a3a7955bd50 100644 --- a/offapi/com/sun/star/sheet/SheetSortDescriptor.idl +++ b/offapi/com/sun/star/sheet/SheetSortDescriptor.idl @@ -53,7 +53,7 @@ published service SheetSortDescriptor /** specifies which user defined sorting list is used. <p>This property is only used, if - SheetSortDescriptor::IsUserListEnabled is <TRUE/>.</p> + SheetSortDescriptor::IsUserListEnabled is `TRUE`.</p> */ [property] long UserListIndex; @@ -67,7 +67,7 @@ published service SheetSortDescriptor /** specifies the position where sorted data are to be copied. <p>This property is only used, if - SheetSortDescriptor::CopyOutputData is <TRUE/>.</p> + SheetSortDescriptor::CopyOutputData is `TRUE`.</p> */ [property] com::sun::star::table::CellAddress OutputPosition; diff --git a/offapi/com/sun/star/sheet/SheetSortDescriptor2.idl b/offapi/com/sun/star/sheet/SheetSortDescriptor2.idl index 589deb989314..5f1e25f69879 100644 --- a/offapi/com/sun/star/sheet/SheetSortDescriptor2.idl +++ b/offapi/com/sun/star/sheet/SheetSortDescriptor2.idl @@ -60,7 +60,7 @@ published service SheetSortDescriptor2 /** specifies which user defined sorting list is used. <p>This property is only used, if - SheetSortDescriptor::IsUserListEnabled is <TRUE/>.</p> + SheetSortDescriptor::IsUserListEnabled is `TRUE`.</p> */ [property] long UserListIndex; @@ -74,7 +74,7 @@ published service SheetSortDescriptor2 /** specifies the position where sorted data are to be copied. <p>This property is only used, if - SheetSortDescriptor::CopyOutputData is <TRUE/>.</p> + SheetSortDescriptor::CopyOutputData is `TRUE`.</p> */ [property] com::sun::star::table::CellAddress OutputPosition; diff --git a/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl b/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl index 8267d684bc12..8b0d301987e0 100644 --- a/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl +++ b/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl @@ -95,8 +95,8 @@ published service SpreadsheetDocumentSettings /** specifies whether calculations are performed with the rounded - values displayed in cells (set to <TRUE/>) instead of the - internal values (set to <FALSE/>). + values displayed in cells (set to `TRUE`) instead of the + internal values (set to `FALSE`). */ [property] boolean CalcAsShown; @@ -115,7 +115,7 @@ published service SpreadsheetDocumentSettings anywhere on the sheet. <p>Explicitly defined label ranges are used even if this property - is set to <FALSE/>.</p> + is set to `FALSE`.</p> @see com::sun::star::sheet::LabelRanges */ diff --git a/offapi/com/sun/star/sheet/SubTotalDescriptor.idl b/offapi/com/sun/star/sheet/SubTotalDescriptor.idl index 4bb1d6cd19fd..1811a6f04789 100644 --- a/offapi/com/sun/star/sheet/SubTotalDescriptor.idl +++ b/offapi/com/sun/star/sheet/SubTotalDescriptor.idl @@ -79,7 +79,7 @@ published service SubTotalDescriptor <p>This property is only used if SubTotalDescriptor::EnableUserSortList - is <TRUE/>.</p> + is `TRUE`.</p> */ [property] long UserSortListIndex; @@ -96,7 +96,7 @@ published service SubTotalDescriptor /** specifies the sorting order if - SubTotalDescriptor::EnableSort is set to <TRUE/>. + SubTotalDescriptor::EnableSort is set to `TRUE`. */ [property] boolean SortAscending; diff --git a/offapi/com/sun/star/sheet/TableAutoFormatField.idl b/offapi/com/sun/star/sheet/TableAutoFormatField.idl index 29fcd9c22135..f93c9abfd5d0 100644 --- a/offapi/com/sun/star/sheet/TableAutoFormatField.idl +++ b/offapi/com/sun/star/sheet/TableAutoFormatField.idl @@ -156,17 +156,17 @@ published service TableAutoFormatField [property] short CharUnderline; - /** is <TRUE/> if the characters are crossed out. + /** is `TRUE` if the characters are crossed out. */ [property] boolean CharCrossedOut; - /** is <TRUE/> if the characters are contoured. + /** is `TRUE` if the characters are contoured. */ [property] boolean CharContoured; - /** is <TRUE/> if the characters are shadowed. + /** is `TRUE` if the characters are shadowed. */ [property] boolean CharShadowed; @@ -181,7 +181,7 @@ published service TableAutoFormatField [property] com::sun::star::util::Color CellBackColor; - /** is <TRUE/> if the cell background is transparent. + /** is `TRUE` if the cell background is transparent. <p>In this case the TableAutoFormatField::CellBackColor value is not used.</p> @@ -208,7 +208,7 @@ published service TableAutoFormatField [optional, property] long VertJustify; - /** is <TRUE/> if text breaks automatically at cell borders. + /** is `TRUE` if text breaks automatically at cell borders. */ [optional, property] boolean IsTextWrapped; diff --git a/offapi/com/sun/star/sheet/TablePageBreakData.idl b/offapi/com/sun/star/sheet/TablePageBreakData.idl index 85cdaee66ae0..cd0ae3bfe11f 100644 --- a/offapi/com/sun/star/sheet/TablePageBreakData.idl +++ b/offapi/com/sun/star/sheet/TablePageBreakData.idl @@ -36,7 +36,7 @@ published struct TablePageBreakData long Position; - /** is <TRUE/> for a manual page break, <FALSE/> for an automatic one. + /** is `TRUE` for a manual page break, `FALSE` for an automatic one. */ boolean ManualBreak; diff --git a/offapi/com/sun/star/sheet/TablePageStyle.idl b/offapi/com/sun/star/sheet/TablePageStyle.idl index da1b940fd967..a4ecc9bdbba9 100644 --- a/offapi/com/sun/star/sheet/TablePageStyle.idl +++ b/offapi/com/sun/star/sheet/TablePageStyle.idl @@ -93,9 +93,9 @@ published service TablePageStyle /** specifies the print order for the pages within each sheet. - <p>If <TRUE/>, the order for printing pages begins with + <p>If `TRUE`, the order for printing pages begins with top-to-bottom, then continues with the next set of cell columns - to the right. If <FALSE/>, the order for printing pages begins + to the right. If `FALSE`, the order for printing pages begins with left-to-right, then continues with the next set of cell rows to the bottom.</p> */ diff --git a/offapi/com/sun/star/sheet/TableValidation.idl b/offapi/com/sun/star/sheet/TableValidation.idl index 4e3c1b9a4066..6a2943f32e39 100644 --- a/offapi/com/sun/star/sheet/TableValidation.idl +++ b/offapi/com/sun/star/sheet/TableValidation.idl @@ -53,7 +53,7 @@ published service TableValidation /** specifies the title of the window showing the input message. <p>This is only used if TableValidation::ShowInputMessage - is set to <TRUE/>.</p> + is set to `TRUE`.</p> */ [property] string InputTitle; @@ -61,7 +61,7 @@ published service TableValidation /** specifies the text of the input message. <p>This is only used if TableValidation::ShowInputMessage - is set to <TRUE/>.</p> + is set to `TRUE`.</p> */ [property] string InputMessage; @@ -75,7 +75,7 @@ published service TableValidation /** specifies the title of the window showing the error message. <p>This is only used if TableValidation::ShowErrorMessage - is set to <TRUE/>.</p> + is set to `TRUE`.</p> */ [property] string ErrorTitle; @@ -83,7 +83,7 @@ published service TableValidation /** specifies the text of the error message. <p>This is only used if TableValidation::ShowErrorMessage - is set to <TRUE/>.</p> + is set to `TRUE`.</p> */ [property] string ErrorMessage; @@ -96,7 +96,7 @@ published service TableValidation /** specifies the style of the error message. <p>This is used only if TableValidation::ShowErrorMessage - is set to <TRUE/>.</p> + is set to `TRUE`.</p> */ [property] com::sun::star::sheet::ValidationAlertStyle ErrorAlertStyle; diff --git a/offapi/com/sun/star/sheet/XCalculatable.idl b/offapi/com/sun/star/sheet/XCalculatable.idl index 47fe689e5d74..6fc192ae9c47 100644 --- a/offapi/com/sun/star/sheet/XCalculatable.idl +++ b/offapi/com/sun/star/sheet/XCalculatable.idl @@ -52,7 +52,7 @@ published interface XCalculatable: com::sun::star::uno::XInterface calculation.</p> @returns - <TRUE/>, if automatic calculation is enabled. + `TRUE`, if automatic calculation is enabled. */ boolean isAutomaticCalculationEnabled(); @@ -65,7 +65,7 @@ published interface XCalculatable: com::sun::star::uno::XInterface calculation.</p> @param bEnabled - <TRUE/> to enable automatic calculation, <FALSE/> to disable. + `TRUE` to enable automatic calculation, `FALSE` to disable. */ void enableAutomaticCalculation( [in] boolean bEnabled ); diff --git a/offapi/com/sun/star/sheet/XCompatibilityNames.idl b/offapi/com/sun/star/sheet/XCompatibilityNames.idl index 281e2145730b..cf8e37388e4e 100644 --- a/offapi/com/sun/star/sheet/XCompatibilityNames.idl +++ b/offapi/com/sun/star/sheet/XCompatibilityNames.idl @@ -53,7 +53,7 @@ published interface XCompatibilityNames: com::sun::star::uno::XInterface <p>If a locale is not present in the sequence of compatibility names, the first entry of the sequence is used. So the method should return a sequence which contains first the entry representing the current - locale.<TRUE/></p> + locale.`TRUE`</p> @param aProgrammaticName is the exact name of a method within its interface. diff --git a/offapi/com/sun/star/sheet/XConsolidatable.idl b/offapi/com/sun/star/sheet/XConsolidatable.idl index f2fda21e06e5..493ddffbd1cb 100644 --- a/offapi/com/sun/star/sheet/XConsolidatable.idl +++ b/offapi/com/sun/star/sheet/XConsolidatable.idl @@ -40,7 +40,7 @@ published interface XConsolidatable: com::sun::star::uno::XInterface /** creates a consolidation descriptor. @param bEmpty - <TRUE/> leaves the descriptor empty, <FALSE/> fills it with + `TRUE` leaves the descriptor empty, `FALSE` fills it with the settings from the last consolidation action. @see com::sun::star::sheet::ConsolidationDescriptor diff --git a/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl b/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl index e76a61f1403b..b8d03f90e4b3 100644 --- a/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl +++ b/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl @@ -56,7 +56,7 @@ published interface XDataPilotFieldGrouping: com::sun::star::uno::XInterface @returns the new created field if there is one created on the first call of - this method. <NULL/> is returned on subsequent calls. + this method. `NULL` is returned on subsequent calls. @see DataPilotField @see DataPilotFieldGroupInfo @@ -80,29 +80,29 @@ published interface XDataPilotFieldGrouping: com::sun::star::uno::XInterface <ul> <li>If the member <member>DataPilotFieldGroupInfo::HasAutoStart - </member> is set to <FALSE/>, then the value of <member> + </member> is set to `FALSE`, then the value of <member> DataPilotFieldGroupInfo::Start</member> must be a floating-point value representing a valid date/time value (if <member> - DataPilotFieldGroupInfo::HasAutoStart</member> is set to <TRUE/>, + DataPilotFieldGroupInfo::HasAutoStart</member> is set to `TRUE`, the value of DataPilotFieldGroupInfo::Start will be ignored).</li> <li>If the member <member>DataPilotFieldGroupInfo::HasAutoEnd - </member> is set to <FALSE/>, then the value of <member> + </member> is set to `FALSE`, then the value of <member> DataPilotFieldGroupInfo::End</member> must be a floating-point value representing a valid date/time value( if <member> - DataPilotFieldGroupInfo::HasAutoEnd</member> is set to <TRUE/>, + DataPilotFieldGroupInfo::HasAutoEnd</member> is set to `TRUE`, the value of DataPilotFieldGroupInfo::End will be ignored).</li> <li>If the members <member>DataPilotFieldGroupInfo::HasAutoStart </member> and DataPilotFieldGroupInfo::HasAutoEnd - are set to <FALSE/> both, then the value of <member> + are set to `FALSE` both, then the value of <member> DataPilotFieldGroupInfo::Start</member> must be less than or equal to the value of DataPilotFieldGroupInfo::End.</li> <li>The member DataPilotFieldGroupInfo::HasDateValues - must be set to <TRUE/>.</li> + must be set to `TRUE`.</li> <li>The member DataPilotFieldGroupInfo::Step must be zero, unless ranges of days have to be grouped (see the @@ -131,7 +131,7 @@ published interface XDataPilotFieldGrouping: com::sun::star::uno::XInterface </ul> @returns - the new created field if there is one created. <NULL/> is returned, + the new created field if there is one created. `NULL` is returned, if date grouping is performed inside this field (i.e. this field was not grouped by dates before). diff --git a/offapi/com/sun/star/sheet/XFormulaQuery.idl b/offapi/com/sun/star/sheet/XFormulaQuery.idl index c15b699065ae..0101ce1016ea 100644 --- a/offapi/com/sun/star/sheet/XFormulaQuery.idl +++ b/offapi/com/sun/star/sheet/XFormulaQuery.idl @@ -44,8 +44,8 @@ published interface XFormulaQuery: com::sun::star::uno::XInterface the original cell.</p> @param bRecursive - <FALSE/> = queries cells dependent from the original range(s), - <TRUE/> = repeats query with all found cells + `FALSE` = queries cells dependent from the original range(s), + `TRUE` = repeats query with all found cells (finds dependents of dependents, and so on). @return @@ -62,8 +62,8 @@ published interface XFormulaQuery: com::sun::star::uno::XInterface cell.</p> @param bRecursive - <FALSE/> = queries precedent cells of the original range(s), - <TRUE/> = repeats query with all found cells + `FALSE` = queries precedent cells of the original range(s), + `TRUE` = repeats query with all found cells (finds precedents of precedents, and so on). @return diff --git a/offapi/com/sun/star/sheet/XPrintAreas.idl b/offapi/com/sun/star/sheet/XPrintAreas.idl index 26306ddc4704..814462c62f3e 100644 --- a/offapi/com/sun/star/sheet/XPrintAreas.idl +++ b/offapi/com/sun/star/sheet/XPrintAreas.idl @@ -59,7 +59,7 @@ published interface XPrintAreas: com::sun::star::uno::XInterface print pages to the right. @param bPrintTitleColumns - if <TRUE/>, title columns are repeated on each page. + if `TRUE`, title columns are repeated on each page. */ void setPrintTitleColumns( [in] boolean bPrintTitleColumns ); @@ -100,7 +100,7 @@ published interface XPrintAreas: com::sun::star::uno::XInterface print pages to the bottom. @param bPrintTitleRows - if <TRUE/>, title rows are repeated on each page. + if `TRUE`, title rows are repeated on each page. */ void setPrintTitleRows( [in] boolean bPrintTitleRows ); diff --git a/offapi/com/sun/star/sheet/XScenario.idl b/offapi/com/sun/star/sheet/XScenario.idl index b0c30b718239..9a02c9cb700b 100644 --- a/offapi/com/sun/star/sheet/XScenario.idl +++ b/offapi/com/sun/star/sheet/XScenario.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module sheet { published interface XScenario: com::sun::star::uno::XInterface { - /** returns <TRUE/> if the current object is a scenario. + /** returns `TRUE` if the current object is a scenario. */ boolean getIsScenario(); diff --git a/offapi/com/sun/star/sheet/XSheetFilterable.idl b/offapi/com/sun/star/sheet/XSheetFilterable.idl index 124c7b1b8410..94e1d5f7995e 100644 --- a/offapi/com/sun/star/sheet/XSheetFilterable.idl +++ b/offapi/com/sun/star/sheet/XSheetFilterable.idl @@ -37,8 +37,8 @@ published interface XSheetFilterable: com::sun::star::uno::XInterface /** creates a filter descriptor. @param bEmpty - if set to <TRUE/>, creates an empty filter descriptor. If set to - <FALSE/>, fills the filter descriptor with previous settings of + if set to `TRUE`, creates an empty filter descriptor. If set to + `FALSE`, fills the filter descriptor with previous settings of the current object (i.e. a database range). */ com::sun::star::sheet::XSheetFilterDescriptor diff --git a/offapi/com/sun/star/sheet/XSolver.idl b/offapi/com/sun/star/sheet/XSolver.idl index cab98844a59d..29b9ba011077 100644 --- a/offapi/com/sun/star/sheet/XSolver.idl +++ b/offapi/com/sun/star/sheet/XSolver.idl @@ -49,7 +49,7 @@ interface XSolver: com::sun::star::uno::XInterface /// executes the calculation and tries to find a solution. void solve(); - /// contains <TRUE/> if a solution was found. + /// contains `TRUE` if a solution was found. [attribute, readonly] boolean Success; /// contains the objective value for the solution, if a solution was found. diff --git a/offapi/com/sun/star/sheet/XSubTotalCalculatable.idl b/offapi/com/sun/star/sheet/XSubTotalCalculatable.idl index 9002bf119546..02ff9a52f72b 100644 --- a/offapi/com/sun/star/sheet/XSubTotalCalculatable.idl +++ b/offapi/com/sun/star/sheet/XSubTotalCalculatable.idl @@ -41,8 +41,8 @@ published interface XSubTotalCalculatable: com::sun::star::uno::XInterface /** creates a subtotal descriptor. @param bEmpty - if set to <TRUE/>, creates an empty descriptor. If set to - <FALSE/>, fills the descriptor with previous settings of the + if set to `TRUE`, creates an empty descriptor. If set to + `FALSE`, fills the descriptor with previous settings of the current object (i.e. a database range). */ com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor( @@ -56,7 +56,7 @@ published interface XSubTotalCalculatable: com::sun::star::uno::XInterface operation. @param bReplace - if set to <TRUE/>, replaces previous subtotal results. + if set to `TRUE`, replaces previous subtotal results. */ void applySubTotals( [in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor, diff --git a/offapi/com/sun/star/sheet/XUsedAreaCursor.idl b/offapi/com/sun/star/sheet/XUsedAreaCursor.idl index 0a87fb139310..9038db4c402b 100644 --- a/offapi/com/sun/star/sheet/XUsedAreaCursor.idl +++ b/offapi/com/sun/star/sheet/XUsedAreaCursor.idl @@ -40,8 +40,8 @@ published interface XUsedAreaCursor: com::sun::star::uno::XInterface /** points the cursor to the start of the used area. @param bExpand - <TRUE/> = expands the current cursor range, - <FALSE/> = sets size of the cursor to a single cell. + `TRUE` = expands the current cursor range, + `FALSE` = sets size of the cursor to a single cell. */ void gotoStartOfUsedArea( [in] boolean bExpand ); @@ -49,8 +49,8 @@ published interface XUsedAreaCursor: com::sun::star::uno::XInterface /** points the cursor to the end of the used area. @param bExpand - <TRUE/> = expands the current cursor range, - <FALSE/> = sets size of the cursor to a single cell. + `TRUE` = expands the current cursor range, + `FALSE` = sets size of the cursor to a single cell. */ void gotoEndOfUsedArea( [in] boolean bExpand ); diff --git a/offapi/com/sun/star/sheet/XViewFreezable.idl b/offapi/com/sun/star/sheet/XViewFreezable.idl index 897ae915a46c..2815d028d0c4 100644 --- a/offapi/com/sun/star/sheet/XViewFreezable.idl +++ b/offapi/com/sun/star/sheet/XViewFreezable.idl @@ -32,12 +32,12 @@ published interface XViewFreezable: com::sun::star::uno::XInterface { - /** returns <TRUE/> if the view has frozen panes. + /** returns `TRUE` if the view has frozen panes. <p>Only one of XViewSplitable::getIsWindowSplit() and XViewFreezable::hasFrozenPanes() - can be <TRUE/>.</p> + can be `TRUE`.</p> */ boolean hasFrozenPanes(); diff --git a/offapi/com/sun/star/sheet/XViewSplitable.idl b/offapi/com/sun/star/sheet/XViewSplitable.idl index bc833c015bc6..7fe0b799a682 100644 --- a/offapi/com/sun/star/sheet/XViewSplitable.idl +++ b/offapi/com/sun/star/sheet/XViewSplitable.idl @@ -33,13 +33,13 @@ published interface XViewSplitable: com::sun::star::uno::XInterface { - /** returns <TRUE/> if the view is split + /** returns `TRUE` if the view is split into individual panes. <p>Only one of XViewSplitable::getIsWindowSplit() and XViewFreezable::hasFrozenPanes() - can be <TRUE/>.</p> + can be `TRUE`.</p> */ boolean getIsWindowSplit(); diff --git a/offapi/com/sun/star/style/CharacterProperties.idl b/offapi/com/sun/star/style/CharacterProperties.idl index 925703756b08..067a42c4bddc 100644 --- a/offapi/com/sun/star/style/CharacterProperties.idl +++ b/offapi/com/sun/star/style/CharacterProperties.idl @@ -132,12 +132,12 @@ published service CharacterProperties [optional, property] short CharCaseMap; - /** This property is <TRUE/> if the characters are crossed out. + /** This property is `TRUE` if the characters are crossed out. */ [optional, property] boolean CharCrossedOut; - /** If this optional property is <TRUE/>, then the characters are flashing. + /** If this optional property is `TRUE`, then the characters are flashing. */ [optional, property] boolean CharFlash; @@ -148,7 +148,7 @@ published service CharacterProperties [optional, property] short CharStrikeout; - /** If this property is <TRUE/>, the underline and strike-through + /** If this property is `TRUE`, the underline and strike-through properties are not applied to white spaces. */ [optional, property] boolean CharWordMode; @@ -355,7 +355,7 @@ published service CharacterProperties [optional, property] sequence<string> CharStyleNames; - /** If this optional property is <TRUE/>, then the characters are invisible. + /** If this optional property is `TRUE`, then the characters are invisible. @since OOo 2.0 */ diff --git a/offapi/com/sun/star/style/PageProperties.idl b/offapi/com/sun/star/style/PageProperties.idl index 8847d3ca54a4..8d79407f73e8 100644 --- a/offapi/com/sun/star/style/PageProperties.idl +++ b/offapi/com/sun/star/style/PageProperties.idl @@ -55,7 +55,7 @@ published service PageProperties [property] com::sun::star::style::GraphicLocation BackGraphicLocation; /** determines if the background color is transparent. - <p>If this property is set to <TRUE/>, + <p>If this property is set to `TRUE`, PageStyle::BackColor will not be used.</p> */ [property] boolean BackTransparent; @@ -159,7 +159,7 @@ published service PageProperties [property, maybevoid] long HeaderRightMargin; /** determines if the background color of the header is transparent. - <p>If this property is set to <TRUE/>, + <p>If this property is set to `TRUE`, PageStyle::HeaderBackColor will not be used.</p> */ [property, maybevoid] boolean HeaderBackTransparent; diff --git a/offapi/com/sun/star/style/ParagraphProperties.idl b/offapi/com/sun/star/style/ParagraphProperties.idl index 6e1257e87230..43e77529a020 100644 --- a/offapi/com/sun/star/style/ParagraphProperties.idl +++ b/offapi/com/sun/star/style/ParagraphProperties.idl @@ -55,7 +55,7 @@ published service ParagraphProperties [optional, property] com::sun::star::util::Color ParaBackColor; - /** This value is <TRUE/> if the paragraph background color + /** This value is `TRUE` if the paragraph background color is set to transparent. */ [optional, property] boolean ParaBackTransparent; @@ -201,7 +201,7 @@ published service ParagraphProperties [optional, property] boolean DropCapWholeWord; - /** Setting this property to <TRUE/> prevents page or column + /** Setting this property to `TRUE` prevents page or column breaks between this and the following paragraph. @@ -211,7 +211,7 @@ published service ParagraphProperties [optional, property] boolean ParaKeepTogether; - /** Setting this property to <FALSE/> prevents the paragraph from + /** Setting this property to `FALSE` prevents the paragraph from getting split into two pages or columns. */ [optional, property] boolean ParaSplit; @@ -341,7 +341,7 @@ published service ParagraphProperties */ [optional, property] com::sun::star::container::XNameContainer ParaUserDefinedAttributes; - /** returns <FALSE/> if the paragraph is part of a numbering, but has no + /** returns `FALSE` if the paragraph is part of a numbering, but has no numbering label. <p>A paragraph is part of a numbering, if a style for a numbering is diff --git a/offapi/com/sun/star/style/XStyle.idl b/offapi/com/sun/star/style/XStyle.idl index 8ceb036bbc80..5da5d2d85fe3 100644 --- a/offapi/com/sun/star/style/XStyle.idl +++ b/offapi/com/sun/star/style/XStyle.idl @@ -39,7 +39,7 @@ published interface XStyle: com::sun::star::container::XNamed /** @returns - <TRUE/> if this type is used in the document. + `TRUE` if this type is used in the document. */ boolean isInUse(); diff --git a/offapi/com/sun/star/style/XStyleLoader.idl b/offapi/com/sun/star/style/XStyleLoader.idl index 77d67ec4cc6c..52aab674df5b 100644 --- a/offapi/com/sun/star/style/XStyleLoader.idl +++ b/offapi/com/sun/star/style/XStyleLoader.idl @@ -33,7 +33,7 @@ published interface XStyleLoader: com::sun::star::uno::XInterface { /** loads styles from a document at the given URL. <p> - If <var>OverwriteStyles</var> is <TRUE/>, then all styles + If <var>OverwriteStyles</var> is `TRUE`, then all styles will be loaded. Otherwise, only styles which are not already defined in this document are loaded.</p> @param string URL: diff --git a/offapi/com/sun/star/table/CellProperties.idl b/offapi/com/sun/star/table/CellProperties.idl index 7e579354f5ad..e132507d82e7 100644 --- a/offapi/com/sun/star/table/CellProperties.idl +++ b/offapi/com/sun/star/table/CellProperties.idl @@ -61,7 +61,7 @@ published service CellProperties [property] com::sun::star::util::Color CellBackColor; - /** is <TRUE/>, if the cell background is transparent. + /** is `TRUE`, if the cell background is transparent. <p>In this case the CellProperties::CellBackColor value is not used.</p> @@ -83,7 +83,7 @@ published service CellProperties [property] long VertJustify; - /** is <TRUE/>, if text in the cells will be wrapped automatically + /** is `TRUE`, if text in the cells will be wrapped automatically at the right border. */ [property] boolean IsTextWrapped; @@ -197,7 +197,7 @@ published service CellProperties [optional, property] com::sun::star::table::BorderLine DiagonalBLTR; - /** is <TRUE/>, if the cell content will be shrunk to fit in the cell. + /** is `TRUE`, if the cell content will be shrunk to fit in the cell. */ [optional, property] boolean ShrinkToFit; diff --git a/offapi/com/sun/star/table/ShadowFormat.idl b/offapi/com/sun/star/table/ShadowFormat.idl index 7effc6eff0ec..9db765643b09 100644 --- a/offapi/com/sun/star/table/ShadowFormat.idl +++ b/offapi/com/sun/star/table/ShadowFormat.idl @@ -42,7 +42,7 @@ published struct ShadowFormat short ShadowWidth; - /** is <TRUE/>, if shadow is transparent. + /** is `TRUE`, if shadow is transparent. */ boolean IsTransparent; diff --git a/offapi/com/sun/star/table/TableColumn.idl b/offapi/com/sun/star/table/TableColumn.idl index a6d2d23a7067..e5e4b8f0c62a 100644 --- a/offapi/com/sun/star/table/TableColumn.idl +++ b/offapi/com/sun/star/table/TableColumn.idl @@ -62,17 +62,17 @@ published service TableColumn [property] long Width; - /** is <TRUE/>, if the column always keeps its optimal width. + /** is `TRUE`, if the column always keeps its optimal width. */ [property] boolean OptimalWidth; - /** is <TRUE/>, if the column is visible. + /** is `TRUE`, if the column is visible. */ [property] boolean IsVisible; - /** is <TRUE/>, if there is a manual horizontal page break attached + /** is `TRUE`, if there is a manual horizontal page break attached to the column. */ [property] boolean IsStartOfNewPage; diff --git a/offapi/com/sun/star/table/TableRow.idl b/offapi/com/sun/star/table/TableRow.idl index 5cc0dae9cb44..d3bec00f54ef 100644 --- a/offapi/com/sun/star/table/TableRow.idl +++ b/offapi/com/sun/star/table/TableRow.idl @@ -54,17 +54,17 @@ published service TableRow [property] long Height; - /** is <TRUE/>, if the row always keeps its optimal height. + /** is `TRUE`, if the row always keeps its optimal height. */ [property] boolean OptimalHeight; - /** is <TRUE/>, if the row is visible. + /** is `TRUE`, if the row is visible. */ [property] boolean IsVisible; - /** is <TRUE/>, if there is a manual vertical page break attached + /** is `TRUE`, if there is a manual vertical page break attached to the row. */ [property] boolean IsStartOfNewPage; diff --git a/offapi/com/sun/star/table/TableSortDescriptor2.idl b/offapi/com/sun/star/table/TableSortDescriptor2.idl index fff675b3118b..7dbedb6e407c 100644 --- a/offapi/com/sun/star/table/TableSortDescriptor2.idl +++ b/offapi/com/sun/star/table/TableSortDescriptor2.idl @@ -51,9 +51,9 @@ published service TableSortDescriptor2 /** specifies if the columns or rows are to be sorted. <dl> - <dt><TRUE/></dt> + <dt>`TRUE`</dt> <dd>The columns are to be sorted.</dd> - <dt><FALSE/></dt> + <dt>`FALSE`</dt> <dd>The rows are to be sorted.</dd> </dl> */ diff --git a/offapi/com/sun/star/table/TableSortField.idl b/offapi/com/sun/star/table/TableSortField.idl index e67ce5e435ea..bf94533d5733 100644 --- a/offapi/com/sun/star/table/TableSortField.idl +++ b/offapi/com/sun/star/table/TableSortField.idl @@ -39,8 +39,8 @@ published struct TableSortField */ long Field; - /** <TRUE/> if data are sorted in ascending order, - <FALSE/> if in descending order. + /** `TRUE` if data are sorted in ascending order, + `FALSE` if in descending order. */ boolean IsAscending; diff --git a/offapi/com/sun/star/table/XMergeableCell.idl b/offapi/com/sun/star/table/XMergeableCell.idl index b9bae73eac46..2218883175ec 100644 --- a/offapi/com/sun/star/table/XMergeableCell.idl +++ b/offapi/com/sun/star/table/XMergeableCell.idl @@ -45,7 +45,7 @@ interface XMergeableCell: com::sun::star::table::XCell long getColumnSpan(); - /** returns <TRUE/> if this cell is merged with another cell. + /** returns `TRUE` if this cell is merged with another cell. */ boolean isMerged(); }; diff --git a/offapi/com/sun/star/table/XMergeableCellRange.idl b/offapi/com/sun/star/table/XMergeableCellRange.idl index 8ee835ac2cd6..368c89026963 100644 --- a/offapi/com/sun/star/table/XMergeableCellRange.idl +++ b/offapi/com/sun/star/table/XMergeableCellRange.idl @@ -64,8 +64,8 @@ interface XMergeableCellRange : com::sun::star::uno::XInterface /** @returns - <TRUE/> if all cells from this range can be merged to one - or <FALSE/> otherwise. + `TRUE` if all cells from this range can be merged to one + or `FALSE` otherwise. */ boolean isMergeable(); }; diff --git a/offapi/com/sun/star/table/XTableCharts.idl b/offapi/com/sun/star/table/XTableCharts.idl index e38171fa372b..8129a2b0f60e 100644 --- a/offapi/com/sun/star/table/XTableCharts.idl +++ b/offapi/com/sun/star/table/XTableCharts.idl @@ -50,11 +50,11 @@ published interface XTableCharts: com::sun::star::container::XNameAccess all cell ranges containing the source data of the chart. @param bColumnHeaders - if set to <TRUE/>, the topmost row of the source data will be + if set to `TRUE`, the topmost row of the source data will be used to set labels for the category axis or the legend. @param bRowHeaders - if set to <TRUE/>, the leftmost column of the source data will + if set to `TRUE`, the leftmost column of the source data will be used to set labels for the category axis or the legend. */ void addNewByName( diff --git a/offapi/com/sun/star/task/XAsyncJob.idl b/offapi/com/sun/star/task/XAsyncJob.idl index cd5a16ea8d24..9b868ae1c105 100644 --- a/offapi/com/sun/star/task/XAsyncJob.idl +++ b/offapi/com/sun/star/task/XAsyncJob.idl @@ -55,7 +55,7 @@ published interface XAsyncJob : com::sun::star::uno::XInterface function XJobListener::jobFinished(). @param Listener - specifies a listener which should be notified on events. May be <NULL/>. + specifies a listener which should be notified on events. May be `NULL`. @throws com::sun::star::lang::IllegalArgumentException if some of given arguments doesn't fill out the service specification or diff --git a/offapi/com/sun/star/task/XRestartManager.idl b/offapi/com/sun/star/task/XRestartManager.idl index b3e42b2fec3a..662909529053 100644 --- a/offapi/com/sun/star/task/XRestartManager.idl +++ b/offapi/com/sun/star/task/XRestartManager.idl @@ -51,19 +51,19 @@ published interface XRestartManager : com::sun::star::uno::XInterface <p> The office has to call this method just before the main loop has been - started, with the <TRUE/> as argument, so that the implementation - knows that the office is initialized. If the method returns <TRUE/>, + started, with the `TRUE` as argument, so that the implementation + knows that the office is initialized. If the method returns `TRUE`, the office should restart without starting the main loop. </p> @param bInitialized specifies whether the office process is initialized already, if the caller does not have this information, he should provide - <FALSE/>. + `FALSE`. @returns - <TRUE/> if the office restart has been requested, - <FALSE/> otherwise + `TRUE` if the office restart has been requested, + `FALSE` otherwise @throws com::sun::star::uno::Exception to notify the caller about possible failures diff --git a/offapi/com/sun/star/text/BaseFrameProperties.idl b/offapi/com/sun/star/text/BaseFrameProperties.idl index 59f89b15584b..b04d9d9ac544 100644 --- a/offapi/com/sun/star/text/BaseFrameProperties.idl +++ b/offapi/com/sun/star/text/BaseFrameProperties.idl @@ -262,7 +262,7 @@ published service BaseFrameProperties <p>The value of this property is only evaluated for the positioning of the shape, if the text document setting ConsiderTextWrapOnObjPos - is <TRUE/>. Valid values are given by #WrapInfluenceOnPosition</p> + is `TRUE`. Valid values are given by #WrapInfluenceOnPosition</p> @since OOo 2.0 */ diff --git a/offapi/com/sun/star/text/BaseIndex.idl b/offapi/com/sun/star/text/BaseIndex.idl index 8478275f37e9..9e75ee555216 100644 --- a/offapi/com/sun/star/text/BaseIndex.idl +++ b/offapi/com/sun/star/text/BaseIndex.idl @@ -89,7 +89,7 @@ published service BaseIndex */ [property] com::sun::star::util::Color BackColor; - /** If <TRUE/>, the background color value in "BackColor" is not visible. + /** If `TRUE`, the background color value in "BackColor" is not visible. */ [property] boolean BackTransparent; diff --git a/offapi/com/sun/star/text/ContentIndex.idl b/offapi/com/sun/star/text/ContentIndex.idl index 99ef0f51b3ad..5f0eac8e1865 100644 --- a/offapi/com/sun/star/text/ContentIndex.idl +++ b/offapi/com/sun/star/text/ContentIndex.idl @@ -48,7 +48,7 @@ published service ContentIndex */ [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles; - /** contains <TRUE/> if the document index marks are included in this index. + /** contains `TRUE` if the document index marks are included in this index. */ [optional, property] boolean CreateFromMarks; diff --git a/offapi/com/sun/star/text/DocumentSettings.idl b/offapi/com/sun/star/text/DocumentSettings.idl index 5eadbd26c2b5..a1a741a8b4e0 100644 --- a/offapi/com/sun/star/text/DocumentSettings.idl +++ b/offapi/com/sun/star/text/DocumentSettings.idl @@ -42,7 +42,7 @@ published service DocumentSettings /** specifies if charts in text documents are updated automatically. - This has no effect if "FieldAutoUpdate" is <FALSE/>. + This has no effect if "FieldAutoUpdate" is `FALSE`. */ [optional, property] boolean ChartAutoUpdate; @@ -53,14 +53,14 @@ published service DocumentSettings table, you have defined spacing above and below each object, usually only the larger one of the two spaces is used. If the spacing between the objects are to be added this property has - to be <TRUE/>.</p> + to be `TRUE`.</p> */ [optional, property] boolean AddParaTableSpacing; /** specifies if top paragraph spacing is applied to paragraphs on the first page of text documents. - <p>If <TRUE/>, the paragraph or table spacing to the top will + <p>If `TRUE`, the paragraph or table spacing to the top will also be effective at the beginning of a page or column if the paragraph or table is positioned on the first page of the document. The same applies for a page break.</p> @@ -69,9 +69,9 @@ published service DocumentSettings /** specifies the alignment of tab stops in text documents. - <p>If <TRUE/> centered and right-aligned paragraphs containing + <p>If `TRUE` centered and right-aligned paragraphs containing tabs are formatted as a whole in the center or aligned to the - right. If <FALSE/>, only the text to the right of the last + right. If `FALSE`, only the text to the right of the last tab, for example, is aligned to the right, while the text to the left remains where it is.</p> */ @@ -100,13 +100,13 @@ published service DocumentSettings <p>This property controls how a set line spacing at a paragraph influences the formatting of the text lines and the spacing between paragraphs. - If <TRUE/>, the formatting till OpenOffice.org 1.1 is + If `TRUE`, the formatting till OpenOffice.org 1.1 is applied. This means, that a proportional line spacing is applied above and below a text line and that the maximum of the line spacing value between two paragraph is added respectively reckoned up with the paragraph spacing (adding or reckoning up is controlled by document option AddParaTableSpacing). - If <FALSE/> (default for documents since OpenOffice.org 2.0), + If `FALSE` (default for documents since OpenOffice.org 2.0), a proportional line spacing is only applied below a text line and it's always added to the paragraph spacing between two paragraphs.</p> @@ -119,10 +119,10 @@ published service DocumentSettings <p>This property controls, if the spacing of the last paragraph respectively table of a table cell is added at the bottom of this table cells - If <TRUE/> (default for documents since OpenOffice.org 2.0), + If `TRUE` (default for documents since OpenOffice.org 2.0), the spacing of the last paragraph respectively table of a table cell is added at the bottom of this table cell. - If <FALSE/> (typically for documents till OpenOffice.org 1.1), + If `FALSE` (typically for documents till OpenOffice.org 1.1), the spacing of the last paragraph respectively table of a table cell isn't added at the bottom of this table cell.</p> @@ -134,11 +134,11 @@ published service DocumentSettings <p>This property controls how floating screen objects (Writer fly frames and drawing objects are positioned. - If <TRUE/>, the object positioning till OpenOffice.org 1.1 is + If `TRUE`, the object positioning till OpenOffice.org 1.1 is applied. This means, that the top of a paragraph, at which a floating screen object orients its vertical position, includes the lower spacing and the line spacing of the previous paragraph. - If <FALSE/> (default for documents since OpenOffice.org 2.0), + If `FALSE` (default for documents since OpenOffice.org 2.0), the top of a paragraph, at which a floating screen object orients its vertical position, doesn't include the lower spacing and the line spacing of the previous paragraph.</p> @@ -152,11 +152,11 @@ published service DocumentSettings <p>This property controls how floating screen objects (Writer fly frames and drawing objects) are positioned. - If <TRUE/>, the object positioning algorithm will consider + If `TRUE`, the object positioning algorithm will consider the text wrap style, set at the floating screen object. The attribute BaseFrameProperties::WrapInfluenceOnPosition specifies how the text wrap is considered. - If <FALSE/> (default value), the former object positioning + If `FALSE` (default value), the former object positioning algorithm (known from OpenOffice.org 1.1) is applied.</p> @since OOo 2.0 diff --git a/offapi/com/sun/star/text/FootnoteSettings.idl b/offapi/com/sun/star/text/FootnoteSettings.idl index 1659050e9bb5..6a7c03ad0a65 100644 --- a/offapi/com/sun/star/text/FootnoteSettings.idl +++ b/offapi/com/sun/star/text/FootnoteSettings.idl @@ -94,7 +94,7 @@ published service FootnoteSettings [optional, property] short FootnoteCounting; - /** If <TRUE/>, the footnote text is shown at the end of the document. + /** If `TRUE`, the footnote text is shown at the end of the document. <p>For footnotes only.</p> */ diff --git a/offapi/com/sun/star/text/LineNumberingProperties.idl b/offapi/com/sun/star/text/LineNumberingProperties.idl index 6c0f3cc47609..fe15d0c7c446 100644 --- a/offapi/com/sun/star/text/LineNumberingProperties.idl +++ b/offapi/com/sun/star/text/LineNumberingProperties.idl @@ -29,7 +29,7 @@ published service LineNumberingProperties { - /** If <TRUE/>, line numbering is used. + /** If `TRUE`, line numbering is used. */ [property] boolean IsOn; @@ -39,11 +39,11 @@ published service LineNumberingProperties [property] string CharStyleName; - /** If <TRUE/>, empty lines are counted. + /** If `TRUE`, empty lines are counted. */ [property] boolean CountEmptyLines; - /** If <TRUE/>, lines in frames are included in counting. + /** If `TRUE`, lines in frames are included in counting. */ [property] boolean CountLinesInFrames; @@ -76,7 +76,7 @@ published service LineNumberingProperties /** specifies if the line numbering should start from the beginning at each page. - <p>If set to <FALSE/> the line numbering will be continuous.</p> + <p>If set to `FALSE` the line numbering will be continuous.</p> @since OOo 2.0 */ diff --git a/offapi/com/sun/star/text/PrintSettings.idl b/offapi/com/sun/star/text/PrintSettings.idl index 4d9076fa368f..9e6bbd1b1ffe 100644 --- a/offapi/com/sun/star/text/PrintSettings.idl +++ b/offapi/com/sun/star/text/PrintSettings.idl @@ -62,7 +62,7 @@ published service PrintSettings - <p>If com::sun::star::view::PrintSettings::PaperFromSetup is <FALSE/>, + <p>If com::sun::star::view::PrintSettings::PaperFromSetup is `FALSE`, then the paper tray selection of the page styles is used.</p> */ [property] boolean PrintPaperFromSetup; diff --git a/offapi/com/sun/star/text/Shape.idl b/offapi/com/sun/star/text/Shape.idl index 69143d4ca52c..9315b01751de 100644 --- a/offapi/com/sun/star/text/Shape.idl +++ b/offapi/com/sun/star/text/Shape.idl @@ -140,7 +140,7 @@ published service Shape <p>The value of this property is only evaluated for the positioning of the shape, if the text document setting ConsiderTextWrapOnObjPos - is <TRUE/>. Valid values are given by #WrapInfluenceOnPosition</p> + is `TRUE`. Valid values are given by #WrapInfluenceOnPosition</p> @since OOo 2.0 */ diff --git a/offapi/com/sun/star/text/TextSection.idl b/offapi/com/sun/star/text/TextSection.idl index 18967c9facf3..5394f7229930 100644 --- a/offapi/com/sun/star/text/TextSection.idl +++ b/offapi/com/sun/star/text/TextSection.idl @@ -61,11 +61,11 @@ published service TextSection */ [property] string Condition; - /** If this property is <FALSE/>, the text section is hidden. + /** If this property is `FALSE`, the text section is hidden. */ [property] boolean IsVisible; - /** If this property is <TRUE/>, the text section is protected + /** If this property is `TRUE`, the text section is protected and cannot be modified from the user interface. */ [property] boolean IsProtected; diff --git a/offapi/com/sun/star/text/TextTableRow.idl b/offapi/com/sun/star/text/TextTableRow.idl index e6fc4c6cbf0c..8bd2f9731991 100644 --- a/offapi/com/sun/star/text/TextTableRow.idl +++ b/offapi/com/sun/star/text/TextTableRow.idl @@ -43,7 +43,7 @@ published service TextTableRow [property] com::sun::star::util::Color BackColor; - /** If <TRUE/>, the background color value in "BackColor" is not visible. + /** If `TRUE`, the background color value in "BackColor" is not visible. */ [property] boolean BackTransparent; @@ -73,13 +73,13 @@ published service TextTableRow [property] long Height; - /** If the value of this property is <TRUE/>, the height of the table row + /** If the value of this property is `TRUE`, the height of the table row depends on the content of the table cells. */ [property] boolean IsAutoHeight; - /** If <TRUE/>, the row is allowed to be split at page or column breaks. + /** If `TRUE`, the row is allowed to be split at page or column breaks. @since OOo 2.0 */ diff --git a/offapi/com/sun/star/text/ViewSettings.idl b/offapi/com/sun/star/text/ViewSettings.idl index e5dd2f62cc71..e2f5db497c09 100644 --- a/offapi/com/sun/star/text/ViewSettings.idl +++ b/offapi/com/sun/star/text/ViewSettings.idl @@ -32,36 +32,36 @@ published service ViewSettings { interface com::sun::star::beans::XPropertySet; - /** If this property is <TRUE/>, annotations (notes) are visible. + /** If this property is `TRUE`, annotations (notes) are visible. */ [property] boolean ShowAnnotations; - /** If this property is <TRUE/>, paragraph line breaks are visible. + /** If this property is `TRUE`, paragraph line breaks are visible. */ [property] boolean ShowBreaks; - /** If this property is <TRUE/>, shapes are visible. + /** If this property is `TRUE`, shapes are visible. */ [property] boolean ShowDrawings; - /** If this property is <TRUE/>, text fields are shown with their commands; otherwise + /** If this property is `TRUE`, text fields are shown with their commands; otherwise the content is visible. */ [property] boolean ShowFieldCommands; - /** If this property is <TRUE/>, footnotes symbols are displayed with gray background. + /** If this property is `TRUE`, footnotes symbols are displayed with gray background. */ [property] boolean ShowFootnoteBackground; - /** If this property is <TRUE/>, graphic objects are visible. + /** If this property is `TRUE`, graphic objects are visible. */ [property] boolean ShowGraphics; - /** If this property is <TRUE/>, hidden paragraphs are displayed. + /** If this property is `TRUE`, hidden paragraphs are displayed. */ [property] boolean ShowHiddenParagraphs; - /** If this property is <TRUE/>, hidden text is displayed. + /** If this property is `TRUE`, hidden text is displayed. */ [property] boolean ShowHiddenText; @@ -71,76 +71,76 @@ published service ViewSettings [property] boolean ShowRulers; - /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>, + /** If this property is `TRUE` and the property ShowRulers is `TRUE`, the horizontal ruler is displayed. */ [property] boolean ShowHoriRuler; - /** If this property is <TRUE/> and the property ShowRulers is <TRUE/>, + /** If this property is `TRUE` and the property ShowRulers is `TRUE`, the horizontal scroll bar is displayed. */ [property] boolean ShowHoriScrollBar; - /** If this property is <TRUE/>, index marks are displayed with gray background. + /** If this property is `TRUE`, index marks are displayed with gray background. */ [property] boolean ShowIndexMarkBackground; - /** If this property is <TRUE/>, paragraph breaks are visible. + /** If this property is `TRUE`, paragraph breaks are visible. */ [property] boolean ShowParaBreaks; - /** If this property is <TRUE/>, protected spaces (hard spaces) are displayed with gray + /** If this property is `TRUE`, protected spaces (hard spaces) are displayed with gray background. */ [property] boolean ShowProtectedSpaces; - /** If this property is <TRUE/>, soft hyphens are displayed with gray background. + /** If this property is `TRUE`, soft hyphens are displayed with gray background. */ [property] boolean ShowSoftHyphens; - /** If this property is <TRUE/>, spaces are displayed with dots. + /** If this property is `TRUE`, spaces are displayed with dots. */ [property] boolean ShowSpaces; - /** If this property is <TRUE/>, table boundaries are displayed. + /** If this property is `TRUE`, table boundaries are displayed. */ [property] boolean ShowTableBoundaries; - /** If this property is <TRUE/>, tables are visible. + /** If this property is `TRUE`, tables are visible. */ [property] boolean ShowTables; - /** If this property is <TRUE/>, tab stops are visible. + /** If this property is `TRUE`, tab stops are visible. */ [property] boolean ShowTabstops; - /** If this property is <TRUE/>, text boundaries are displayed. + /** If this property is `TRUE`, text boundaries are displayed. */ [property] boolean ShowTextBoundaries; - /** If this property is <TRUE/>, text fields are displayed with gray background. + /** If this property is `TRUE`, text fields are displayed with gray background. */ [property] boolean ShowTextFieldBackground; - /** If this property is <TRUE/>, the vertical ruler is displayed. + /** If this property is `TRUE`, the vertical ruler is displayed. */ [property] boolean ShowVertRuler; - /** If this property is <TRUE/>, the vertical scroll bar is displayed. + /** If this property is `TRUE`, the vertical scroll bar is displayed. */ [property] boolean ShowVertScrollBar; - /** If this property is <TRUE/>, smooth scrolling is active. + /** If this property is `TRUE`, smooth scrolling is active. */ [property] boolean SmoothScrolling; - /** If this property is <TRUE/>, the vertical ruler is aligned to the right side + /** If this property is `TRUE`, the vertical ruler is aligned to the right side of the view and the vertical scrollbar is on the left. */ [property] boolean IsVertRulerRightAligned; - /** If this property is <TRUE/> the document will be displayed as if it + /** If this property is `TRUE` the document will be displayed as if it were a HTML document. */ [property] boolean ShowOnlineLayout; @@ -156,7 +156,7 @@ published service ViewSettings com::sun::star::view::DocumentZoomType::BY_VALUE. */ [property] short ZoomValue; - /** If this property is <TRUE/> hyperlinks in the document are executed (loaded) on + /** If this property is `TRUE` hyperlinks in the document are executed (loaded) on mouse click. Otherwise they are handled like normal text. */ [optional, property] boolean IsExecuteHyperlinks; @@ -220,12 +220,12 @@ published service ViewSettings */ [optional, property] long RasterResolutionY; - /** If this property is <TRUE/>, hidden characters are displayed + /** If this property is `TRUE`, hidden characters are displayed @since OOo 3.0 */ [optional, property] boolean ShowHiddenCharacters; - /** If this property is <TRUE/>, the settings of non-printing characters are applied. + /** If this property is `TRUE`, the settings of non-printing characters are applied. <p>This option controls the use of the settings ShowHiddenCharacters, ShowTabstops, ShowSpaces, ShowBreaks and ShowParaBreaks </p> diff --git a/offapi/com/sun/star/text/XFlatParagraph.idl b/offapi/com/sun/star/text/XFlatParagraph.idl index a758cd964586..acb0f256c506 100644 --- a/offapi/com/sun/star/text/XFlatParagraph.idl +++ b/offapi/com/sun/star/text/XFlatParagraph.idl @@ -48,8 +48,8 @@ interface XFlatParagraph: com::sun::star::text::XTextMarkup /** check whether the content has been modified @returns - <TRUE/> if the content has been modified, - <FALSE/> otherwise. + `TRUE` if the content has been modified, + `FALSE` otherwise. */ boolean isModified(); @@ -60,8 +60,8 @@ interface XFlatParagraph: com::sun::star::text::XTextMarkup type, see TextMarkupType. @param bVal - <TRUE/> the respective text node has been processed - <FALSE/> the respective text node needs to be processed again + `TRUE` the respective text node has been processed + `FALSE` the respective text node needs to be processed again later */ void setChecked( [in] long nType, [in] boolean bVal ); @@ -72,8 +72,8 @@ interface XFlatParagraph: com::sun::star::text::XTextMarkup type, see TextMarkupType. @returns - <TRUE/> if the respective text node has been checked - <FALSE/> otherwise. + `TRUE` if the respective text node has been checked + `FALSE` otherwise. */ boolean isChecked( [in] long nType ); diff --git a/offapi/com/sun/star/text/XSimpleText.idl b/offapi/com/sun/star/text/XSimpleText.idl index ba3b5cd05417..aaeb618594b6 100644 --- a/offapi/com/sun/star/text/XSimpleText.idl +++ b/offapi/com/sun/star/text/XSimpleText.idl @@ -82,7 +82,7 @@ published interface XSimpleText: com::sun::star::text::XTextRange <method>XSimpleText::createTextCursor</member> can be used to get an XTextRange for this argument. - <p>If the parameter bAbsorb() was <TRUE/> + <p>If the parameter bAbsorb() was `TRUE` the text range will contain the new inserted string, otherwise the range (and it's text) will remain unchanged. @@ -91,7 +91,7 @@ published interface XSimpleText: com::sun::star::text::XTextRange @param bAbsorb specifies whether the text spanned by <var>xRange</var> will be - replaced. If <TRUE/> then the content of <var>xRange</var> will + replaced. If `TRUE` then the content of <var>xRange</var> will be replaced by <var>aString</var>, otherwise <var>aString</var> will be inserted at the beginning of <var>xRange</var>. diff --git a/offapi/com/sun/star/text/XText.idl b/offapi/com/sun/star/text/XText.idl index 05b8a90063dd..8a865690989b 100644 --- a/offapi/com/sun/star/text/XText.idl +++ b/offapi/com/sun/star/text/XText.idl @@ -57,7 +57,7 @@ published interface XText: com::sun::star::text::XSimpleText @param bAbsorb specifies whether the text spanned by <var>xRange</var> will be - replaced. If <TRUE/> then the content of <var>xRange</var> will + replaced. If `TRUE` then the content of <var>xRange</var> will be replaced by <var>xContent</var>, otherwise <var>xContent</var> will be inserted at the end of <var>xRange</var>. */ diff --git a/offapi/com/sun/star/text/XTextCursor.idl b/offapi/com/sun/star/text/XTextCursor.idl index e30229e8d42c..42f8465fd078 100644 --- a/offapi/com/sun/star/text/XTextCursor.idl +++ b/offapi/com/sun/star/text/XTextCursor.idl @@ -56,12 +56,12 @@ published interface XTextCursor: com::sun::star::text::XTextRange be expanded or not. @returns - <TRUE/> if the command was successfully completed. - <FALSE/> otherwise. + `TRUE` if the command was successfully completed. + `FALSE` otherwise. <p>Note: Even if the command was not completed successfully it may be completed partially. E.g. if it was required to move - 5 characters but it is only possible to move 3 <FALSE/> will + 5 characters but it is only possible to move 3 `FALSE` will be returned and the cursor moves only those 3 characters.<p> */ boolean goLeft( [in] short nCount, @@ -78,12 +78,12 @@ published interface XTextCursor: com::sun::star::text::XTextRange be expanded or not. @returns - <TRUE/> if the command was successfully completed. - <FALSE/> otherwise. + `TRUE` if the command was successfully completed. + `FALSE` otherwise. <p>Note: Even if the command was not completed successfully it may be completed partially. E.g. if it was required to move - 5 characters but it is only possible to move 3 <FALSE/> will + 5 characters but it is only possible to move 3 `FALSE` will be returned and the cursor moves only those 3 characters.<p> */ boolean goRight( [in] short nCount, diff --git a/offapi/com/sun/star/text/XTextField.idl b/offapi/com/sun/star/text/XTextField.idl index 176a85d09121..fdcd6889960a 100644 --- a/offapi/com/sun/star/text/XTextField.idl +++ b/offapi/com/sun/star/text/XTextField.idl @@ -39,7 +39,7 @@ published interface XTextField: com::sun::star::text::XTextContent /** @returns the display string of the text field either as the command of the field or as the output string. @param bShowCommand - if <TRUE/> the command of the field will be returned + if `TRUE` the command of the field will be returned */ string getPresentation( [in] boolean bShowCommand ); diff --git a/offapi/com/sun/star/text/XTextViewCursor.idl b/offapi/com/sun/star/text/XTextViewCursor.idl index 1e3b03623a76..637d7872b814 100644 --- a/offapi/com/sun/star/text/XTextViewCursor.idl +++ b/offapi/com/sun/star/text/XTextViewCursor.idl @@ -32,7 +32,7 @@ published interface XTextViewCursor: com::sun::star::text::XTextCursor { /** @returns - <TRUE/> if this cursor is visible for the user. + `TRUE` if this cursor is visible for the user. */ boolean isVisible(); diff --git a/offapi/com/sun/star/text/fieldmaster/Bibliography.idl b/offapi/com/sun/star/text/fieldmaster/Bibliography.idl index bde65946302a..f2412dd3261a 100644 --- a/offapi/com/sun/star/text/fieldmaster/Bibliography.idl +++ b/offapi/com/sun/star/text/fieldmaster/Bibliography.idl @@ -34,12 +34,12 @@ published service Bibliography { service com::sun::star::text::TextFieldMaster; - /** determines whether the bibliography text fields are numbered. If <FALSE/> the + /** determines whether the bibliography text fields are numbered. If `FALSE` the short name of the bibliography entry is displayed instead. */ [property] boolean IsNumberEntries; /** determines whether the bibliography entries in a bibliography index are sorted - by the document position. If <FALSE/> the SortKey property determines the + by the document position. If `FALSE` the SortKey property determines the sorting of the entries. */ [property] boolean IsSortByPosition; diff --git a/offapi/com/sun/star/text/textfield/ConditionalText.idl b/offapi/com/sun/star/text/textfield/ConditionalText.idl index 9dd5a82b992e..c51ab839bae2 100644 --- a/offapi/com/sun/star/text/textfield/ConditionalText.idl +++ b/offapi/com/sun/star/text/textfield/ConditionalText.idl @@ -32,10 +32,10 @@ published service ConditionalText { service com::sun::star::text::TextField; - /** contains the text that is displayed if the condition evaluates to <TRUE/>. + /** contains the text that is displayed if the condition evaluates to `TRUE`. */ [property] string TrueContent; - /** contains the text that is displayed if the condition evaluates to <FALSE/>. + /** contains the text that is displayed if the condition evaluates to `FALSE`. */ [property] string FalseContent; /** contains the condition. diff --git a/offapi/com/sun/star/text/textfield/DateTime.idl b/offapi/com/sun/star/text/textfield/DateTime.idl index 48c068b5b63a..2f7950735e89 100644 --- a/offapi/com/sun/star/text/textfield/DateTime.idl +++ b/offapi/com/sun/star/text/textfield/DateTime.idl @@ -33,15 +33,15 @@ published service DateTime { service com::sun::star::text::TextField; - /** If this flag is set to <FALSE/> the date or time + /** If this flag is set to `FALSE` the date or time is always displayed as the current date or time. @since OOo 1.1.2 */ [optional, property] boolean IsFixed; - /** If this flag is set to <TRUE/> this field represents - a date with an optional time. If it is set to <FALSE/> + /** If this flag is set to `TRUE` this field represents + a date with an optional time. If it is set to `FALSE` only the time is used here. */ [property] boolean IsDate; diff --git a/offapi/com/sun/star/text/textfield/ExtendedUser.idl b/offapi/com/sun/star/text/textfield/ExtendedUser.idl index 96a2f9dc4d27..75e559402740 100644 --- a/offapi/com/sun/star/text/textfield/ExtendedUser.idl +++ b/offapi/com/sun/star/text/textfield/ExtendedUser.idl @@ -39,7 +39,7 @@ published service ExtendedUser <p> This property is especially useful for import/export purposes. </p> */ [property]string CurrentPresentation; - /** If this flag is set to <FALSE/> the content is regularly updated. + /** If this flag is set to `FALSE` the content is regularly updated. */ [property]boolean IsFixed; /** specifies which part of the user data is displayed as described in diff --git a/offapi/com/sun/star/text/textfield/FileName.idl b/offapi/com/sun/star/text/textfield/FileName.idl index 9ae5a36d85d2..4a5ab163d56b 100644 --- a/offapi/com/sun/star/text/textfield/FileName.idl +++ b/offapi/com/sun/star/text/textfield/FileName.idl @@ -40,7 +40,7 @@ published service FileName com::sun::star::text::FilenameDisplayFormat. */ [property]short FileFormat; - /** If this flag is set to <FALSE/> the content is regularly updated. + /** If this flag is set to `FALSE` the content is regularly updated. */ [property]boolean IsFixed; }; diff --git a/offapi/com/sun/star/text/textfield/HiddenText.idl b/offapi/com/sun/star/text/textfield/HiddenText.idl index a48afcde7c49..fcbdeff4f433 100644 --- a/offapi/com/sun/star/text/textfield/HiddenText.idl +++ b/offapi/com/sun/star/text/textfield/HiddenText.idl @@ -33,7 +33,7 @@ published service HiddenText service com::sun::star::text::TextField; /** contains the text content of the hidden text field. - <p> The content is displayed if the condition evaluates to <FALSE/>.</p> + <p> The content is displayed if the condition evaluates to `FALSE`.</p> */ [property] string Content; /** contains the condition. diff --git a/offapi/com/sun/star/text/textfield/docinfo/ChangeDateTime.idl b/offapi/com/sun/star/text/textfield/docinfo/ChangeDateTime.idl index 9d0f2eedf597..3d0023d4c29e 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/ChangeDateTime.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/ChangeDateTime.idl @@ -41,14 +41,14 @@ published service ChangeDateTime will be overridden by the current author each time the document is saved. */ - /** If this flag is set to <FALSE/> the date or time + /** If this flag is set to `FALSE` the date or time is always displayed as the current date or time. @since OOo 1.1.2 */ [optional, property] boolean IsFixed; - /** If this flag is set to <TRUE/> this field represents, - a date with an optional time. If it is set to <FALSE/> + /** If this flag is set to `TRUE` this field represents, + a date with an optional time. If it is set to `FALSE` only the time is used here. */ [property]boolean IsDate; diff --git a/offapi/com/sun/star/text/textfield/docinfo/CreateDateTime.idl b/offapi/com/sun/star/text/textfield/docinfo/CreateDateTime.idl index 438c4d9ba033..277d726ab542 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/CreateDateTime.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/CreateDateTime.idl @@ -41,14 +41,14 @@ published service CreateDateTime will be overridden by the current author each time the document is saved. */ - /** If this flag is set to <FALSE/> the date or time + /** If this flag is set to `FALSE` the date or time is always displayed as the current date or time. @since OOo 1.1.2 */ [optional, property] boolean IsFixed; - /** If this flag is set to <TRUE/> this field represents, - a date with an optional time. If it is set to <FALSE/> + /** If this flag is set to `TRUE` this field represents, + a date with an optional time. If it is set to `FALSE` only the time is used here. */ [property]boolean IsDate; diff --git a/offapi/com/sun/star/text/textfield/docinfo/Custom.idl b/offapi/com/sun/star/text/textfield/docinfo/Custom.idl index 4bad6568a526..4903b1ddb52b 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Custom.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Custom.idl @@ -46,7 +46,7 @@ published service Custom */ [property] string CurrentPresentation; - /** If this flag is set to <FALSE/>, the content is updated when + /** If this flag is set to `FALSE`, the content is updated when the document information changes. */ [property] boolean IsFixed; diff --git a/offapi/com/sun/star/text/textfield/docinfo/Description.idl b/offapi/com/sun/star/text/textfield/docinfo/Description.idl index 4c1108310f79..a6a9ff6bc473 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Description.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Description.idl @@ -41,7 +41,7 @@ published service Description <p> This property is especially useful for import/export purposes. </p> */ [property]string CurrentPresentation; - /** If this flag is set to <FALSE/> the content updated everytime the document + /** If this flag is set to `FALSE` the content updated everytime the document information is changed. */ [property]boolean IsFixed; diff --git a/offapi/com/sun/star/text/textfield/docinfo/EditTime.idl b/offapi/com/sun/star/text/textfield/docinfo/EditTime.idl index d73eda30c14c..d133bfcae636 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/EditTime.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/EditTime.idl @@ -41,7 +41,7 @@ published service EditTime will be overridden by the current author each time the document is saved. */ - /** If this flag is set to <FALSE/> the date or time + /** If this flag is set to `FALSE` the date or time is always displayed as the current date or time. @since OOo 1.1.2 diff --git a/offapi/com/sun/star/text/textfield/docinfo/Keywords.idl b/offapi/com/sun/star/text/textfield/docinfo/Keywords.idl index 3c03bdbc8554..2c516a74079d 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Keywords.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Keywords.idl @@ -41,7 +41,7 @@ published service Keywords <p> This property is especially useful for import/export purposes. </p> */ [property]string CurrentPresentation; - /** If this flag is set to <FALSE/> the content updated everytime the document + /** If this flag is set to `FALSE` the content updated everytime the document information is changed. */ [property]boolean IsFixed; diff --git a/offapi/com/sun/star/text/textfield/docinfo/PrintDateTime.idl b/offapi/com/sun/star/text/textfield/docinfo/PrintDateTime.idl index dfc15eaa5493..86b0445d5c87 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/PrintDateTime.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/PrintDateTime.idl @@ -41,14 +41,14 @@ published service PrintDateTime will be overridden by the current author each time the document is saved. */ - /** If this flag is set to <FALSE/> the date or time + /** If this flag is set to `FALSE` the date or time is always displayed as the current date or time. @since OOo 1.1.2 */ [optional, property] boolean IsFixed; - /** If this flag is set to <TRUE/> this field represents, - a date with an optional time. If it is set to <FALSE/> + /** If this flag is set to `TRUE` this field represents, + a date with an optional time. If it is set to `FALSE` only the time is used here. */ [property]boolean IsDate; diff --git a/offapi/com/sun/star/text/textfield/docinfo/Revision.idl b/offapi/com/sun/star/text/textfield/docinfo/Revision.idl index 1ba636604cc0..8153e5ff4693 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Revision.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Revision.idl @@ -41,7 +41,7 @@ published service Revision <p> This property is especially useful for import/export purposes. </p> */ [property]string CurrentPresentation; - /** If this flag is set to <FALSE/> the content updated everytime the document + /** If this flag is set to `FALSE` the content updated everytime the document information is changed. */ [property]boolean IsFixed; diff --git a/offapi/com/sun/star/text/textfield/docinfo/Subject.idl b/offapi/com/sun/star/text/textfield/docinfo/Subject.idl index 51db92f59be0..4cd075636b74 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Subject.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Subject.idl @@ -41,7 +41,7 @@ published service Subject <p> This property is especially useful for import/export purposes. </p> */ [property]string CurrentPresentation; - /** If this flag is set to <FALSE/> the content updated everytime the document + /** If this flag is set to `FALSE` the content updated everytime the document information is changed. */ [property]boolean IsFixed; diff --git a/offapi/com/sun/star/text/textfield/docinfo/Title.idl b/offapi/com/sun/star/text/textfield/docinfo/Title.idl index 2fbd12455f27..797ce641e4c3 100644 --- a/offapi/com/sun/star/text/textfield/docinfo/Title.idl +++ b/offapi/com/sun/star/text/textfield/docinfo/Title.idl @@ -41,7 +41,7 @@ published service Title <p> This property is especially useful for import/export purposes. </p> */ [property]string CurrentPresentation; - /** If this flag is set to <FALSE/> the content updated everytime the document + /** If this flag is set to `FALSE` the content updated everytime the document information is changed. */ [property]boolean IsFixed; diff --git a/offapi/com/sun/star/ucb/FetchResult.idl b/offapi/com/sun/star/ucb/FetchResult.idl index b82cf8cc7a09..c4aee33a02f9 100644 --- a/offapi/com/sun/star/ucb/FetchResult.idl +++ b/offapi/com/sun/star/ucb/FetchResult.idl @@ -51,7 +51,7 @@ published struct FetchResult /** indicates the orientation in which the rows are fetched and set into the sequence FetchResult::Rows. - <p>When FetchResult::Orientation equals <TRUE/>, the + <p>When FetchResult::Orientation equals `TRUE`, the rows in FetchResult::Rows are ordered in the same way as in the original result set. */ diff --git a/offapi/com/sun/star/ucb/RuleOperator.idl b/offapi/com/sun/star/ucb/RuleOperator.idl index 5eeae547b7b0..442adda69ecd 100644 --- a/offapi/com/sun/star/ucb/RuleOperator.idl +++ b/offapi/com/sun/star/ucb/RuleOperator.idl @@ -57,11 +57,11 @@ published constants RuleOperator */ const short NOTEQUAL = 6; - /** "True" - Object has the value <TRUE/>. + /** "True" - Object has the value `TRUE`. */ const short VALUE_TRUE = 7; - /** "False" - Object has the value <FALSE/>. + /** "False" - Object has the value `FALSE`. */ const short VALUE_FALSE = 8; diff --git a/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl b/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl index 0e7ac88e3e71..b29629a58ba9 100644 --- a/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl @@ -40,7 +40,7 @@ published interface XCachedContentResultSetFactory: com::sun::star::uno::XInterf @param xMapping can be used for optimization of remote access via the interface XContentAccess of the CachedContentResultSet. - This parameter can be <NULL/>. + This parameter can be `NULL`. @returns an instance of service CachedContentResultSet. diff --git a/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl b/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl index f6205e30422d..23be7fcc8343 100644 --- a/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl @@ -42,7 +42,7 @@ published interface XCachedDynamicResultSetFactory: com::sun::star::uno::XInterf @param SourceStub must be an instance of service CachedDynamicResultSetStub. - It can be <NULL/>. In this case you can use the interface + It can be `NULL`. In this case you can use the interface XSourceInitialization of the returned CachedDynamicResultSet to set the stub later. diff --git a/offapi/com/sun/star/ucb/XCommandInfo.idl b/offapi/com/sun/star/ucb/XCommandInfo.idl index 10bec49456ab..9b727cf393cc 100644 --- a/offapi/com/sun/star/ucb/XCommandInfo.idl +++ b/offapi/com/sun/star/ucb/XCommandInfo.idl @@ -72,8 +72,8 @@ published interface XCommandInfo: com::sun::star::uno::XInterface /** checks whether a command specific is supported. @returns - <TRUE/> if a command with the specified name is supported; - otherwise <FALSE/> is returned. + `TRUE` if a command with the specified name is supported; + otherwise `FALSE` is returned. @param Name specifies the name of the requested command. @@ -83,8 +83,8 @@ published interface XCommandInfo: com::sun::star::uno::XInterface /** checks whether a specific command is supported. @returns - <TRUE/> if a command with the specified handle is supported; - otherwise <FALSE/> is returned. + `TRUE` if a command with the specified handle is supported; + otherwise `FALSE` is returned. @param Name specifies the handle of the requested command. diff --git a/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl b/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl index bb96a8475da6..3bf1dd3df3f5 100644 --- a/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl +++ b/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl @@ -94,7 +94,7 @@ published interface XContentIdentifierMapping: com::sun::star::uno::XInterface (assuming that in most cases most elements in the input sequence will be returned unmodified). - @returns <TRUE/> if any of the columns contain data that (potentially) + @returns `TRUE` if any of the columns contain data that (potentially) needs mapping (though maybe no mapping occurred for the concrete input data of this call). This information can be useful to decide whether, for another row, a call to this function is at all necessary. diff --git a/offapi/com/sun/star/ucb/XContentProviderManager.idl b/offapi/com/sun/star/ucb/XContentProviderManager.idl index 36627b5570d4..9720834f3290 100644 --- a/offapi/com/sun/star/ucb/XContentProviderManager.idl +++ b/offapi/com/sun/star/ucb/XContentProviderManager.idl @@ -43,16 +43,16 @@ published interface XContentProviderManager: com::sun::star::uno::XInterface @param Provider the content provider to register. - <p>This may be <NULL/>, in which case a later + <p>This may be `NULL`, in which case a later XContentProvider::queryContent() with an XContentIdentifier that matches the <var>Scheme</var> - will simply return <NULL/>. These "dummy" content providers are useful + will simply return `NULL`. These "dummy" content providers are useful in combination with other content providers that are registered on a wildcard URL template: For example, imagine that you want to route all http URLs to a HTTP content provider, but want to block all URLs for the server <code>www.dont.go</code>. One solution would be to register the HTTP content provider on the <var>Scheme</var> <code>http</code>, - and to register a "dummy" (i.e., <NULL/>) content provider on the + and to register a "dummy" (i.e., `NULL`) content provider on the <var>Scheme</var> <code>"http://www.dont.go"([/?#].*)?</code>. @param Scheme @@ -101,11 +101,11 @@ published interface XContentProviderManager: com::sun::star::uno::XInterface as their <code><simple>:</code> counterparts. @param ReplaceExisting - <TRUE/>: replace the provider possibly registered for the given URL + `TRUE`: replace the provider possibly registered for the given URL template. The replaced provider will not be deregistered automatically! If the superseding provider gets deregistered, the superseded one will become active again. - <p><FALSE/>: do not register, if another provider is already registered + <p>`FALSE`: do not register, if another provider is already registered for the given URL template. @returns diff --git a/offapi/com/sun/star/ucb/XFetchProvider.idl b/offapi/com/sun/star/ucb/XFetchProvider.idl index 416b094aeb3c..2d0a28d99758 100644 --- a/offapi/com/sun/star/ucb/XFetchProvider.idl +++ b/offapi/com/sun/star/ucb/XFetchProvider.idl @@ -44,9 +44,9 @@ published interface XFetchProvider: com::sun::star::uno::XInterface the count of rows @param bDirection - <TRUE/>, if you want the rows to be read in the same order, as they - are contained in the result set ( <TRUE/> <-> forward step; - <FALSE/> <-> backward step ) + `TRUE`, if you want the rows to be read in the same order, as they + are contained in the result set ( `TRUE` <-> forward step; + `FALSE` <-> backward step ) */ com::sun::star::ucb::FetchResult fetch( [in] long nRowStartPosition , [in] long nRowCount diff --git a/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl b/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl index 1e8e8c184188..e2bd215b2aea 100644 --- a/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl +++ b/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl @@ -45,9 +45,9 @@ published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterf the count of rows @param bDirection - <TRUE/>, if you want the rows to be read in the same order, as they - are contained in the result set ( <TRUE/> <-> forward step; - <FALSE/> <-> backward step ) + `TRUE`, if you want the rows to be read in the same order, as they + are contained in the result set ( `TRUE` <-> forward step; + `FALSE` <-> backward step ) */ com::sun::star::ucb::FetchResult fetchContentIdentifierStrings( [in] long nRowStartPosition @@ -68,9 +68,9 @@ published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterf the count of rows @param bDirection - <TRUE/>, if you want the rows to be read in the same order, as they - are contained in the result set ( <TRUE/> <-> forward step; - <FALSE/> <-> backward step ) + `TRUE`, if you want the rows to be read in the same order, as they + are contained in the result set ( `TRUE` <-> forward step; + `FALSE` <-> backward step ) */ com::sun::star::ucb::FetchResult fetchContentIdentifiers( [in] long nRowStartPosition @@ -90,9 +90,9 @@ published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterf the count of rows @param bDirection - <TRUE/>, if you want the rows to be read in the same order, as they - are contained in the result set ( <TRUE/> <-> forward step; - <FALSE/> <-> backward step ) + `TRUE`, if you want the rows to be read in the same order, as they + are contained in the result set ( `TRUE` <-> forward step; + `FALSE` <-> backward step ) */ com::sun::star::ucb::FetchResult fetchContents( [in] long nRowStartPosition diff --git a/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl b/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl index 49bafbe6b8f6..db3386a94494 100644 --- a/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl +++ b/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl @@ -38,9 +38,9 @@ published interface XInteractionHandlerSupplier: com::sun::star::uno::XInterface supplied. @returns - <TRUE/>, if an + `TRUE`, if an com::sun::star::task::XInteractionHandler can be - supplied, <FALSE/> otherwise. + supplied, `FALSE` otherwise. */ boolean hasInteractionHandler(); }; diff --git a/offapi/com/sun/star/ucb/XPropertyMatcher.idl b/offapi/com/sun/star/ucb/XPropertyMatcher.idl index a74fa5c4454c..de77c7f74111 100644 --- a/offapi/com/sun/star/ucb/XPropertyMatcher.idl +++ b/offapi/com/sun/star/ucb/XPropertyMatcher.idl @@ -42,7 +42,7 @@ published interface XPropertyMatcher : com::sun::star::uno::XInterface Command Processor. It may be null. @returns - <TRUE/> if the properties match, <FALSE/> otherwise. + `TRUE` if the properties match, `FALSE` otherwise. */ boolean matches([in] com::sun::star::ucb::XCommandProcessor Properties, [in] com::sun::star::ucb::XCommandEnvironment Environment); diff --git a/offapi/com/sun/star/ui/ConfigurableUIElement.idl b/offapi/com/sun/star/ui/ConfigurableUIElement.idl index c5c02ccccb7b..12a9a42d9c5e 100644 --- a/offapi/com/sun/star/ui/ConfigurableUIElement.idl +++ b/offapi/com/sun/star/ui/ConfigurableUIElement.idl @@ -83,7 +83,7 @@ service ConfigurableUIElement /** specifies the configuration source of this user interface element. <p> - If the property #Persistent is <TRUE/> changes on the structure of + If the property #Persistent is `TRUE` changes on the structure of the user interface element are written back to configuration source. When this property is changed, afterwards XUIElementSettings::updateSettings() must be called so the user interface element tries to retrieve its settings from the new user interface diff --git a/offapi/com/sun/star/ui/XImageManager.idl b/offapi/com/sun/star/ui/XImageManager.idl index 5930fa0b270c..38d5a8c35b07 100644 --- a/offapi/com/sun/star/ui/XImageManager.idl +++ b/offapi/com/sun/star/ui/XImageManager.idl @@ -71,7 +71,7 @@ interface XImageManager a command URL that should be checked for an associated image. @return - <TRUE/> if an image is associated, otherwise <FALSE/>. + `TRUE` if an image is associated, otherwise `FALSE`. */ boolean hasImage( [in] short nImageType, [in] string aCommandURL ) raises ( com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/ui/XModuleUIConfigurationManager.idl b/offapi/com/sun/star/ui/XModuleUIConfigurationManager.idl index 5ab0d0d9f84c..d2833718425c 100644 --- a/offapi/com/sun/star/ui/XModuleUIConfigurationManager.idl +++ b/offapi/com/sun/star/ui/XModuleUIConfigurationManager.idl @@ -62,8 +62,8 @@ interface XModuleUIConfigurationManager : ::com::sun::star::uno::XInterface characters for type and name. @return - <TRUE/> if settings have been found in the default layer, - otherwise <FALSE/>. + `TRUE` if settings have been found in the default layer, + otherwise `FALSE`. */ boolean isDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::lang::IllegalArgumentException ); @@ -77,8 +77,8 @@ interface XModuleUIConfigurationManager : ::com::sun::star::uno::XInterface characters for type and name. @return - <TRUE/> if default settings have been found in the default layer, - otherwise <FALSE/>. + `TRUE` if default settings have been found in the default layer, + otherwise `FALSE`. */ ::com::sun::star::container::XIndexAccess getDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/ui/XToolPanel.idl b/offapi/com/sun/star/ui/XToolPanel.idl index 6a2e2881a6ca..64242f232e9b 100644 --- a/offapi/com/sun/star/ui/XToolPanel.idl +++ b/offapi/com/sun/star/ui/XToolPanel.idl @@ -33,7 +33,7 @@ interface XToolPanel { /** provides access to the tool panel's main window. - <p>It is allowed for an implementation to return <NULL/> here, but in this case some functionality, for instance + <p>It is allowed for an implementation to return `NULL` here, but in this case some functionality, for instance automatic positioning of the tool panel, might not be available, and must be implemented by the tool panel itself.</p> */ [attribute, readonly] ::com::sun::star::awt::XWindow Window; diff --git a/offapi/com/sun/star/ui/XUIConfigurationManager.idl b/offapi/com/sun/star/ui/XUIConfigurationManager.idl index 074f0f3fd59c..6002f81dc9a8 100644 --- a/offapi/com/sun/star/ui/XUIConfigurationManager.idl +++ b/offapi/com/sun/star/ui/XUIConfigurationManager.idl @@ -102,7 +102,7 @@ interface XUIConfigurationManager : ::com::sun::star::uno::XInterface characters for type and name. @return - <TRUE/> if settings have been found, otherwise <FALSE/>. + `TRUE` if settings have been found, otherwise `FALSE`. */ boolean hasSettings( [in] string ResourceURL ) raises ( com::sun::star::lang::IllegalArgumentException ); @@ -115,8 +115,8 @@ interface XUIConfigurationManager : ::com::sun::star::uno::XInterface characters for type and name. @param bWriteable - must be <TRUE/> if the retrieved settings should be a writable. - Otherwise <FALSE/> should be provided to get a shareable reference + must be `TRUE` if the retrieved settings should be a writable. + Otherwise `FALSE` should be provided to get a shareable reference to the settings data. @return diff --git a/offapi/com/sun/star/ui/XUIConfigurationPersistence.idl b/offapi/com/sun/star/ui/XUIConfigurationPersistence.idl index 8e81daacdb6b..5bf247683b4f 100644 --- a/offapi/com/sun/star/ui/XUIConfigurationPersistence.idl +++ b/offapi/com/sun/star/ui/XUIConfigurationPersistence.idl @@ -70,8 +70,8 @@ interface XUIConfigurationPersistence : ::com::sun::star::uno::XInterface instance. @return - <TRUE/> if the configuration manager has changed since the - last store() call. <FALSE/> if the configuration + `TRUE` if the configuration manager has changed since the + last store() call. `FALSE` if the configuration manager has not been changed. */ boolean isModified(); @@ -82,8 +82,8 @@ interface XUIConfigurationPersistence : ::com::sun::star::uno::XInterface not support any changes to its configuration settings. @return - <TRUE/> if the configuration manager storage is read-only otherwise - <FALSE/>. + `TRUE` if the configuration manager storage is read-only otherwise + `FALSE`. */ boolean isReadOnly(); }; diff --git a/offapi/com/sun/star/ui/XUIConfigurationStorage.idl b/offapi/com/sun/star/ui/XUIConfigurationStorage.idl index 247687e4af4e..0c641ef2b6b5 100644 --- a/offapi/com/sun/star/ui/XUIConfigurationStorage.idl +++ b/offapi/com/sun/star/ui/XUIConfigurationStorage.idl @@ -62,7 +62,7 @@ interface XUIConfigurationStorage : ::com::sun::star::uno::XInterface /** checks if an instance has already a storage to load/store its data. @return - <TRUE/> if the instance has a storage otherwise <FALSE/>. + `TRUE` if the instance has a storage otherwise `FALSE`. */ boolean hasStorage(); }; diff --git a/offapi/com/sun/star/ui/XUIElementFactory.idl b/offapi/com/sun/star/ui/XUIElementFactory.idl index 5e19afcbfaaa..e976024e80f5 100644 --- a/offapi/com/sun/star/ui/XUIElementFactory.idl +++ b/offapi/com/sun/star/ui/XUIElementFactory.idl @@ -83,7 +83,7 @@ interface XUIElementFactory : ::com::sun::star::uno::XInterface </li> <li><b>Persistent</b><br>specifies if changes to a configurable user interface element should be persistent. This is an - optional argument. The default value is <TRUE/>.</li> + optional argument. The default value is `TRUE`.</li> </ul> <p> diff --git a/offapi/com/sun/star/ui/XUIElementSettings.idl b/offapi/com/sun/star/ui/XUIElementSettings.idl index 6a57777a343d..9731a7376384 100644 --- a/offapi/com/sun/star/ui/XUIElementSettings.idl +++ b/offapi/com/sun/star/ui/XUIElementSettings.idl @@ -52,8 +52,8 @@ interface XUIElementSettings : com::sun::star::uno::XInterface type supports it. @param bWriteable - must be <TRUE/> if the retrieved settings should be a writable. - Otherwise <FALSE/> should be provided to get a shareable reference + must be `TRUE` if the retrieved settings should be a writable. + Otherwise `FALSE` should be provided to get a shareable reference to the settings data. @return diff --git a/offapi/com/sun/star/ui/dialogs/XControlInformation.idl b/offapi/com/sun/star/ui/dialogs/XControlInformation.idl index 823447d9c68c..3fbe3f2aa61d 100644 --- a/offapi/com/sun/star/ui/dialogs/XControlInformation.idl +++ b/offapi/com/sun/star/ui/dialogs/XControlInformation.idl @@ -47,8 +47,8 @@ sequence<string> getSupportedControls( ); instance "OkButton" or "CancelButton". @returns - <TRUE/> if the specified control is supported. - <FALSE/> if the specified control is not supported. + `TRUE` if the specified control is supported. + `FALSE` if the specified control is not supported. */ boolean isControlSupported( [in] string aControlName ); @@ -77,8 +77,8 @@ sequence<string> getSupportedControlProperties( [in] string aControlName ) The control property to query for. @returns - <TRUE/> if the specified control action is supported. - <FALSE/> if the specified control action is not supported. + `TRUE` if the specified control action is supported. + `FALSE` if the specified control action is not supported. @throws com::sun::star::lang::IllegalArgumentException when the specified control is not supported. diff --git a/offapi/com/sun/star/ui/dialogs/XFilePicker.idl b/offapi/com/sun/star/ui/dialogs/XFilePicker.idl index b8164ba4f457..a273f87bc95f 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePicker.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePicker.idl @@ -38,8 +38,8 @@ published interface XFilePicker: com::sun::star::ui::dialogs::XExecutableDialog may be selected by the user else only one file selection at a time is possible</p> @param bMode - <p>A value of <TRUE/> enables the multi-selection mode.</p> - <p>A value of <FALSE/> disables the multi-selection mode, this is the default.</p> + <p>A value of `TRUE` enables the multi-selection mode.</p> + <p>A value of `FALSE` disables the multi-selection mode, this is the default.</p> */ void setMultiSelectionMode( [in] boolean bMode ); diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl index ab27f579bc78..c2baf8dd823b 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl @@ -51,7 +51,7 @@ published interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFile @param aValue The value to set. For checkboxes aValue should be a boolean value that - should be <TRUE/> if the checkbox should be checked and <FALSE/> otherwise. + should be `TRUE` if the checkbox should be checked and `FALSE` otherwise. @see com::sun::star::ui::dialogs::CommonFilePickerElementIds @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds @@ -71,8 +71,8 @@ void setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue @returns The value of the specified element. If the specified control - is a checkbox the returned value is a boolean that is <TRUE/> - if the checkbox is checked <FALSE/> otherwise. + is a checkbox the returned value is a boolean that is `TRUE` + if the checkbox is checked `FALSE` otherwise. If the specified element doesn't exist or the specified element doesn't support the specified control action an empty any will be returned. @@ -118,8 +118,8 @@ string getLabel( [in] short aControlId ); Identifies the control. @param bEnable - <p>If <TRUE/> the specified control will be enabled.</p> - <p>If <FALSE/> the specified control will be disabled.</p> + <p>If `TRUE` the specified control will be enabled.</p> + <p>If `FALSE` the specified control will be disabled.</p> @see com::sun::star::ui::dialogs::CommonFilePickerElementIds @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds diff --git a/offapi/com/sun/star/ui/dialogs/XFilePreview.idl b/offapi/com/sun/star/ui/dialogs/XFilePreview.idl index c6d749b63085..63e653a287c0 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePreview.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePreview.idl @@ -92,12 +92,12 @@ published interface XFilePreview: com::sun::star::uno::XInterface that the preview implementation doesn't support hiding the preview. @param bShowState - A value of <TRUE/> shows the preview window. - <p>A value of <FALSE/> hides the preview window.</p> + A value of `TRUE` shows the preview window. + <p>A value of `FALSE` hides the preview window.</p> @returns - A value of <TRUE/> on success. - <p>A value of <FALSE/> if the operation fails for any reason or the preview + A value of `TRUE` on success. + <p>A value of `FALSE` if the operation fails for any reason or the preview implementation doesn't support hiding the preview.</p> */ boolean setShowState( [in] boolean bShowState ); @@ -105,8 +105,8 @@ published interface XFilePreview: com::sun::star::uno::XInterface /** Returns the current show state of the preview. @returns - A value of <TRUE/> if the preview window is visible. - <p>A value of <FALSE/> if the preview window is invisible.</p> + A value of `TRUE` if the preview window is visible. + <p>A value of `FALSE` if the preview window is invisible.</p> */ boolean getShowState( ); }; diff --git a/offapi/com/sun/star/ui/dialogs/XWizard.idl b/offapi/com/sun/star/ui/dialogs/XWizard.idl index 6774bb10f34b..453cc3b68087 100644 --- a/offapi/com/sun/star/ui/dialogs/XWizard.idl +++ b/offapi/com/sun/star/ui/dialogs/XWizard.idl @@ -96,7 +96,7 @@ interface XWizard denotes the button to enable or disable, as one of the WizardButton constants. Must not be WizardButton::NONE. @param Enable - specifies whether the button should be enabled (<TRUE/>) or disabled (<FALSE/>) + specifies whether the button should be enabled (`TRUE`) or disabled (`FALSE`) */ void enableButton( [in] short WizardButton, [in] boolean Enable ); @@ -146,7 +146,7 @@ interface XWizard /** updates the wizard elements which are related to traveling. <p>For instance, the <em>Next</em> button is disabled if the current page's XWizardPage::canAdvance() - method returns <FALSE/>.</p> + method returns `FALSE`.</p> <p>You usually call this method from within a wizard page whose state changed in a way that it affects the user's ability to reach other pages.</p> @@ -187,10 +187,10 @@ interface XWizard @param PathIndex the index of the path, as used in the Wizard::createMultiplePathsWizard() constructor. @param Final - <p>If <TRUE/>, the path will be completely activated, even if it is a conflicting path (i.e. there is another + <p>If `TRUE`, the path will be completely activated, even if it is a conflicting path (i.e. there is another path which shares the first <code>k</code> states with the to-be-activated path.)</p> - <p>If <FALSE/>, then the new path is checked for conflicts with other paths. If such conflicts exists, the path + <p>If `FALSE`, then the new path is checked for conflicts with other paths. If such conflicts exists, the path is not completely activated, but only up to the point where it does <em>not</em> conflict.</p> <p>In this latter case, you need another activatePath method (usually triggered by the user doing some decisions diff --git a/offapi/com/sun/star/ui/dialogs/XWizardPage.idl b/offapi/com/sun/star/ui/dialogs/XWizardPage.idl index 66d10d32c9e0..6cfdbe489041 100644 --- a/offapi/com/sun/star/ui/dialogs/XWizardPage.idl +++ b/offapi/com/sun/star/ui/dialogs/XWizardPage.idl @@ -46,7 +46,7 @@ interface XWizardPage : ::com::sun::star::lang::XComponent /** is called when the page is about to be left - <p>An implementation can veto the leave by returning <FALSE/> here. Usually, the decision about this + <p>An implementation can veto the leave by returning `FALSE` here. Usually, the decision about this depends on the current state of the page.</p> @param Reason @@ -58,7 +58,7 @@ interface XWizardPage : ::com::sun::star::lang::XComponent /** determines whether it is allowed to travel to a later page in the wizard <p>You should base this decision on the state of the page only, not on a global state of the wizard. Usually, - you return <FALSE/> here if and only if not all necessary input on the page has been provided by the user, + you return `FALSE` here if and only if not all necessary input on the page has been provided by the user, or the provided input is not valid.</p> <p>If checked for validity is expensive, or if you prefer giving your user more detailed feedback on validity diff --git a/offapi/com/sun/star/util/SearchDescriptor.idl b/offapi/com/sun/star/util/SearchDescriptor.idl index 7de3def9f563..40574209a1f5 100644 --- a/offapi/com/sun/star/util/SearchDescriptor.idl +++ b/offapi/com/sun/star/util/SearchDescriptor.idl @@ -36,28 +36,28 @@ published service SearchDescriptor interface com::sun::star::beans::XPropertySet; - /** If <TRUE/>, the search is done backwards in the document. + /** If `TRUE`, the search is done backwards in the document. */ [property] boolean SearchBackwards; - /** If <TRUE/>, the case of the letters is important for the match. + /** If `TRUE`, the case of the letters is important for the match. */ [property] boolean SearchCaseSensitive; - /** If <TRUE/>, only complete words will be found. + /** If `TRUE`, only complete words will be found. */ [property] boolean SearchWords; - /** If <TRUE/>, the search string is evaluated as a regular expression. + /** If `TRUE`, the search string is evaluated as a regular expression. */ [property] boolean SearchRegularExpression; - /** If <TRUE/>, it is searched for positions where the paragraph style with + /** If `TRUE`, it is searched for positions where the paragraph style with the name of the search pattern is applied. */ [property] boolean SearchStyles; - /** If <TRUE/>, a "similarity search" is performed. + /** If `TRUE`, a "similarity search" is performed. <p>In the case of a similarity search, the following properties specify the kind of similarity: @@ -75,7 +75,7 @@ published service SearchDescriptor */ [property] boolean SearchSimilarity; - /** If <TRUE/>, all similarity rules are applied together. + /** If `TRUE`, all similarity rules are applied together. <p>In the case of a relaxed similarity search, the following properties are applied together: diff --git a/offapi/com/sun/star/util/SortDescriptor.idl b/offapi/com/sun/star/util/SortDescriptor.idl index da2527fc9398..7f7f38f34341 100644 --- a/offapi/com/sun/star/util/SortDescriptor.idl +++ b/offapi/com/sun/star/util/SortDescriptor.idl @@ -55,13 +55,13 @@ published service SortDescriptor <dl> <dt> - <TRUE/> + `TRUE` </dt> <dd>The columns are sorted. </dd> <dt> - <FALSE/> + `FALSE` </dt> <dd>The rows are sorted. </dd> diff --git a/offapi/com/sun/star/util/SortField.idl b/offapi/com/sun/star/util/SortField.idl index 4209603149b1..9efc514f6431 100644 --- a/offapi/com/sun/star/util/SortField.idl +++ b/offapi/com/sun/star/util/SortField.idl @@ -35,8 +35,8 @@ published struct SortField */ long Field; - /** <TRUE/> if data are sorted in ascending order, - <FALSE/> if in descending order. + /** `TRUE` if data are sorted in ascending order, + `FALSE` if in descending order. */ boolean SortAscending; diff --git a/offapi/com/sun/star/util/TriState.idl b/offapi/com/sun/star/util/TriState.idl index 2db8ff259e9f..e2b9138b5c0e 100644 --- a/offapi/com/sun/star/util/TriState.idl +++ b/offapi/com/sun/star/util/TriState.idl @@ -26,17 +26,17 @@ module com { module sun { module star { module util { /** This enumeration represents a tristate value.<p> - This enumeration defines three values, <TRUE/>, <FALSE/> and a don't know + This enumeration defines three values, `TRUE`, `FALSE` and a don't know value.<p> */ enum TriState { - /** The value is equivalent to <FALSE/>. + /** The value is equivalent to `FALSE`. */ NO, - /** The value is equivalent to <TRUE/>. + /** The value is equivalent to `TRUE`. */ YES, diff --git a/offapi/com/sun/star/util/URL.idl b/offapi/com/sun/star/util/URL.idl index e599cc99c7f4..51d25bac771d 100644 --- a/offapi/com/sun/star/util/URL.idl +++ b/offapi/com/sun/star/util/URL.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module util { <p> If the structure represents a valid URL or not depends on prior usage of the functions of XURLTransformer. Only after one of the functions - returned <TRUE/> this can be assumed.</br> + returned `TRUE` this can be assumed.</br> It is not necessary to set all of the fields; either URL::Complete or (some of) the others are set. Additionally, most of the other fields, like URL::Host, URL::Port, diff --git a/offapi/com/sun/star/util/XCloseListener.idl b/offapi/com/sun/star/util/XCloseListener.idl index 942605baf2a0..58c1e2c5e7ba 100644 --- a/offapi/com/sun/star/util/XCloseListener.idl +++ b/offapi/com/sun/star/util/XCloseListener.idl @@ -62,9 +62,9 @@ published interface XCloseListener: com::sun::star::lang::XEventListener <p> The parameter <var>GetsOwnership</var> regulate who has to try to close the listened object again, if this listener disagree with the request by throwing the exception. - If it's set to <FALSE/> the original caller of XCloseable::close() + If it's set to `FALSE` the original caller of XCloseable::close() will be the owner in every case. It's not allowed to call close() from this listener then. - If it's set to <TRUE/> this listener will be the new owner if he throw the exception, + If it's set to `TRUE` this listener will be the new owner if he throw the exception, otherwise not! If his still running processes will be finished he must call close() on listened object again then. </p> @@ -79,10 +79,10 @@ published interface XCloseListener: com::sun::star::lang::XEventListener describes the source of the event (must be the listened object) @param GetsOwnership - <TRUE/> pass the ownership to this listener, if he throw the veto exception + `TRUE` pass the ownership to this listener, if he throw the veto exception (otherwise this parameter must be ignored!) <br> - <FALSE/> forbids to grab the ownership for the listened close object and call + `FALSE` forbids to grab the ownership for the listened close object and call close() on that any time. @throws CloseVetoException diff --git a/offapi/com/sun/star/util/XCloseable.idl b/offapi/com/sun/star/util/XCloseable.idl index 3424ab9a9a33..fbb7182d3137 100644 --- a/offapi/com/sun/star/util/XCloseable.idl +++ b/offapi/com/sun/star/util/XCloseable.idl @@ -75,13 +75,13 @@ published interface XCloseable: XCloseBroadcaster <p> If somewhere disagree with a CloseVetoException it will not clear who has to close the object again after still running processes was finished. The parameter <var>DeliverOwnership</var> regulate that. - If it is set to <FALSE/> the caller of the method close() will be the owner of this object in every case. + If it is set to `FALSE` the caller of the method close() will be the owner of this object in every case. Then it's not allowed to call close() from any other place (may a registered XCloseListener). - If it is set to <TRUE/> the caller gives up his ownership. If a XCloseListener throw the veto exception + If it is set to `TRUE` the caller gives up his ownership. If a XCloseListener throw the veto exception he will be the new owner of the closing object. This information is passed to the listener by a parameter of his notification method XCloseListener::queryClosing(). After his operations was finished he MUST try to close it again. If the closing object itself disagree by an exception and the parameter - <var>DeliverOwnership</var> was set to <TRUE/> the object will be his own owner with all consequences of that. + <var>DeliverOwnership</var> was set to `TRUE` the object will be his own owner with all consequences of that. <br><strong>Note:</strong><br> There is no way to get the ownership back if it was delivered! </p> @@ -94,10 +94,10 @@ published interface XCloseable: XCloseBroadcaster </p> @param DeliverOwnership - <TRUE/> delegates the ownership of this closing object to any one which throw the CloseVetoException. + `TRUE` delegates the ownership of this closing object to any one which throw the CloseVetoException. This new owner has to close the closing object again if his still running processes will be finished. <br> - <FALSE/> let the ownership at the original one which called the close() method. He must react for possible + `FALSE` let the ownership at the original one which called the close() method. He must react for possible CloseVetoExceptions and try it again at a later time. This can be useful for a generic UI handling. @throws CloseVetoException diff --git a/offapi/com/sun/star/util/XLockable.idl b/offapi/com/sun/star/util/XLockable.idl index ecd160569c2d..07165fd3fe44 100644 --- a/offapi/com/sun/star/util/XLockable.idl +++ b/offapi/com/sun/star/util/XLockable.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module util { <p><code>lock</code> and <code>unlock</code> calls can be nested. However, they must be in pairs. As long as there has been one more call to <code>lock</code> than to <code>unlock</code>, the - component is considered locked, which is reflected by isLocked() returning <TRUE/>.</p> + component is considered locked, which is reflected by isLocked() returning `TRUE`.</p> */ interface XLockable { diff --git a/offapi/com/sun/star/util/XMergeable.idl b/offapi/com/sun/star/util/XMergeable.idl index 6f7c2aac55a2..3a099c445e2e 100644 --- a/offapi/com/sun/star/util/XMergeable.idl +++ b/offapi/com/sun/star/util/XMergeable.idl @@ -35,8 +35,8 @@ published interface XMergeable: com::sun::star::uno::XInterface void merge( [in] boolean bMerge ); /** @returns - <TRUE/> if the area specified by this object is merged, - or <FALSE/> otherwise. + `TRUE` if the area specified by this object is merged, + or `FALSE` otherwise. */ boolean getIsMerged(); diff --git a/offapi/com/sun/star/util/XModifiable.idl b/offapi/com/sun/star/util/XModifiable.idl index d8e74c24634e..372fbf506116 100644 --- a/offapi/com/sun/star/util/XModifiable.idl +++ b/offapi/com/sun/star/util/XModifiable.idl @@ -36,7 +36,7 @@ module com { module sun { module star { module util { published interface XModifiable: com::sun::star::util::XModifyBroadcaster { /** @returns - <TRUE/> if the object is modified. + `TRUE` if the object is modified. <p>The modification is always in relation to a certain state (i.e., the initial, loaded, or last stored version). diff --git a/offapi/com/sun/star/util/XModifiable2.idl b/offapi/com/sun/star/util/XModifiable2.idl index 2b5fa256717a..895c974aeb92 100644 --- a/offapi/com/sun/star/util/XModifiable2.idl +++ b/offapi/com/sun/star/util/XModifiable2.idl @@ -43,8 +43,8 @@ interface XModifiable2: com::sun::star::util::XModifiable @returns the value that says whether the modified state change was enabled before the call - <TRUE/> the changing of the modified state was already disabled - <FALSE/> the changing of the modified state was enabled + `TRUE` the changing of the modified state was already disabled + `FALSE` the changing of the modified state was enabled */ boolean disableSetModified(); @@ -53,8 +53,8 @@ interface XModifiable2: com::sun::star::util::XModifiable @returns the value that says whether the modified state change was enabled before the call - <TRUE/> the changing of the modified state was disabled - <FALSE/> the changing of the modified state was already enabled + `TRUE` the changing of the modified state was disabled + `FALSE` the changing of the modified state was already enabled */ boolean enableSetModified(); diff --git a/offapi/com/sun/star/util/XNumberFormats.idl b/offapi/com/sun/star/util/XNumberFormats.idl index f7adcd35a69e..88d3bd7b60af 100644 --- a/offapi/com/sun/star/util/XNumberFormats.idl +++ b/offapi/com/sun/star/util/XNumberFormats.idl @@ -54,8 +54,8 @@ published interface XNumberFormats: com::sun::star::uno::XInterface the language of number formats to return. @param bCreate - <TRUE/>: create new entries if no formats for the selected language exist<BR> - <FALSE/>: return an empty list if no formats for the selected language exist + `TRUE`: create new entries if no formats for the selected language exist<BR> + `FALSE`: return an empty list if no formats for the selected language exist */ sequence<long> queryKeys( [in] short nType, [in] com::sun::star::lang::Locale nLocale, diff --git a/offapi/com/sun/star/util/XSearchable.idl b/offapi/com/sun/star/util/XSearchable.idl index b8903e44db73..c6322a4d66b0 100644 --- a/offapi/com/sun/star/util/XSearchable.idl +++ b/offapi/com/sun/star/util/XSearchable.idl @@ -40,8 +40,8 @@ module com { module sun { module star { module util { <listing> xSearchDescr = xDocument.createSearchDescriptor() xSearchDescr.SearchString = "search for" - xSearchDescr.SearchCaseSensitive = <TRUE/> - xSearchDescr.SearchWords = <TRUE/> + xSearchDescr.SearchCaseSensitive = `TRUE` + xSearchDescr.SearchWords = `TRUE` xFound = xDocument.findFirst( xSearchDescr ) do while not IsNull(xFound) xFound.CharWeight = com.sun.star.awt.FontWeight.BOLD diff --git a/offapi/com/sun/star/util/XURLTransformer.idl b/offapi/com/sun/star/util/XURLTransformer.idl index a55d6fa0bacd..734fc7754793 100644 --- a/offapi/com/sun/star/util/XURLTransformer.idl +++ b/offapi/com/sun/star/util/XURLTransformer.idl @@ -49,8 +49,8 @@ published interface XURLTransformer: com::sun::star::uno::XInterface can be overwritten if the implementation corrected minor failures. @returns - <TRUE/> if parsing was successfully (means if given URL was syntactically correct) - or <FALSE/> otherwise. + `TRUE` if parsing was successfully (means if given URL was syntactically correct) + or `FALSE` otherwise. */ boolean parseStrict( [inout] com::sun::star::util::URL aURL ); @@ -74,8 +74,8 @@ published interface XURLTransformer: com::sun::star::uno::XInterface protocol which fit best. @returns - <TRUE/> if parsing was successful (means if URL::Complete could - be syntactically correct) or <FALSE/> otherwise. + `TRUE` if parsing was successful (means if URL::Complete could + be syntactically correct) or `FALSE` otherwise. */ boolean parseSmart( [inout] com::sun::star::util::URL aURL, @@ -91,7 +91,7 @@ published interface XURLTransformer: com::sun::star::uno::XInterface is not defined. @returns - <TRUE/> if assembling was successfully or <FALSE/> otherwise. + `TRUE` if assembling was successfully or `FALSE` otherwise. */ boolean assemble( [inout] com::sun::star::util::URL aURL ); diff --git a/offapi/com/sun/star/view/PrintSettings.idl b/offapi/com/sun/star/view/PrintSettings.idl index 881c60753f9b..e7671ea696ae 100644 --- a/offapi/com/sun/star/view/PrintSettings.idl +++ b/offapi/com/sun/star/view/PrintSettings.idl @@ -31,47 +31,47 @@ module com { module sun { module star { module view { */ published service PrintSettings { - /** If <TRUE/>, all characters are printed in black. + /** If `TRUE`, all characters are printed in black. <p>It is useful for printing colored text on a b/w printer.</p> */ [property] boolean PrintBlackFonts; - /** If <TRUE/>, control shapes are included in printing. + /** If `TRUE`, control shapes are included in printing. */ [property] boolean PrintControls; - /** If <TRUE/>, drawing objects (shapes) are included in printing. + /** If `TRUE`, drawing objects (shapes) are included in printing. */ [property] boolean PrintDrawings; - /** If <TRUE/>, graphic objects are included in printing. + /** If `TRUE`, graphic objects are included in printing. */ [property] boolean PrintGraphics; - /** If <TRUE/>, left pages are included in printing. + /** If `TRUE`, left pages are included in printing. */ [property] boolean PrintLeftPages; - /** If <TRUE/>, right pages are included in printing. + /** If `TRUE`, right pages are included in printing. */ [property] boolean PrintRightPages; - /** If <TRUE/>, tables are included in printing. + /** If `TRUE`, tables are included in printing. */ [property] boolean PrintTables; - /** If <TRUE/>, the pages are printed in reverse order. + /** If `TRUE`, the pages are printed in reverse order. <p>The last page is printed first.</p> */ [property] boolean PrintReversed; - /** If <TRUE/>, the pages are printed in the order of prospects. + /** If `TRUE`, the pages are printed in the order of prospects. */ [property] boolean PrintProspect; - /** If <TRUE/>, the background of the page is printed. + /** If `TRUE`, the background of the page is printed. */ [property] boolean PrintPageBackground; diff --git a/offapi/com/sun/star/view/ViewSettings.idl b/offapi/com/sun/star/view/ViewSettings.idl index 4002a7312cce..788a195e3543 100644 --- a/offapi/com/sun/star/view/ViewSettings.idl +++ b/offapi/com/sun/star/view/ViewSettings.idl @@ -31,11 +31,11 @@ published service ViewSettings { interface com::sun::star::beans::XPropertySet; - /** If this property is <TRUE/>, the horizontal ruler is displayed. + /** If this property is `TRUE`, the horizontal ruler is displayed. */ [optional, property] boolean ShowHoriRuler; - /** If this property is <TRUE/>, the horizontal scroll bar is displayed. + /** If this property is `TRUE`, the horizontal scroll bar is displayed. */ [optional, property] boolean ShowHoriScrollBar; @@ -43,11 +43,11 @@ published service ViewSettings */ [optional, property] short ZoomValue; - /** If this property is <TRUE/>, the vertical ruler is displayed. + /** If this property is `TRUE`, the vertical ruler is displayed. */ [optional, property] boolean ShowVertRuler; - /** If this property is <TRUE/>, the vertical scroll bar is displayed. + /** If this property is `TRUE`, the vertical scroll bar is displayed. */ [optional, property] boolean ShowVertScrollBar; }; diff --git a/offapi/com/sun/star/view/XFormLayerAccess.idl b/offapi/com/sun/star/view/XFormLayerAccess.idl index 965014c2ece9..f498f688c795 100644 --- a/offapi/com/sun/star/view/XFormLayerAccess.idl +++ b/offapi/com/sun/star/view/XFormLayerAccess.idl @@ -45,7 +45,7 @@ interface XFormLayerAccess with the form layer, as long as the form is not in design mode.</p> @return - the requested form controller, or <NULL/> if the view's + the requested form controller, or `NULL` if the view's form layer is currently in design mode. Note that the returned instance becomes non-functional as soon as the form layer is switched to design mode. diff --git a/offapi/com/sun/star/view/XLineCursor.idl b/offapi/com/sun/star/view/XLineCursor.idl index 6647aec360bb..fc125f653ea8 100644 --- a/offapi/com/sun/star/view/XLineCursor.idl +++ b/offapi/com/sun/star/view/XLineCursor.idl @@ -45,16 +45,16 @@ published interface XLineCursor: com::sun::star::uno::XInterface /** moves the cursor to the end of the current line. @param bExpand - determines whether the text range of the cursor is expanded (<TRUE/>) - or the cursor will be just at the new position after the move (<FALSE/>). + determines whether the text range of the cursor is expanded (`TRUE`) + or the cursor will be just at the new position after the move (`FALSE`). */ void gotoEndOfLine( [in] boolean bExpand ); /** moves the cursor to the start of the current line. @param bExpand - determines whether the text range of the cursor is expanded (<TRUE/>) - or the cursor will be just at the new position after the move (<FALSE/>). + determines whether the text range of the cursor is expanded (`TRUE`) + or the cursor will be just at the new position after the move (`FALSE`). */ void gotoStartOfLine( [in] boolean bExpand ); diff --git a/offapi/com/sun/star/view/XMultiSelectionSupplier.idl b/offapi/com/sun/star/view/XMultiSelectionSupplier.idl index e1d09bb695a9..d1aab3b07827 100644 --- a/offapi/com/sun/star/view/XMultiSelectionSupplier.idl +++ b/offapi/com/sun/star/view/XMultiSelectionSupplier.idl @@ -46,8 +46,8 @@ interface XMultiSelectionSupplier: XSelectionSupplier either an Object that is selectable or a sequence of objects that are selectable. @returns - <TRUE/>/, if <var>Selection</var> was added to the current selection. - <FALSE/>, if <var>Selection</var> or parts of <var>Selection</var> could not be + `TRUE`/, if <var>Selection</var> was added to the current selection. + `FALSE`, if <var>Selection</var> or parts of <var>Selection</var> could not be added to the current selection. For example, if the selection already contains objects that are forbidden to be selected together with <var>Selection</var> @@ -66,8 +66,8 @@ interface XMultiSelectionSupplier: XSelectionSupplier either an Object that is selectable or a sequence of objects that are selectable. @returns - <TRUE/>/, if <var>Selection</var> was added to the current selection. - <FALSE/>, if <var>Selection</var> or parts of <var>Selection</var> could not be + `TRUE`/, if <var>Selection</var> was added to the current selection. + `FALSE`, if <var>Selection</var> or parts of <var>Selection</var> could not be added to the current selection. For example, if the selection already contains objects that are forbidden to be selected together with <var>Selection</var>. diff --git a/offapi/com/sun/star/view/XViewCursor.idl b/offapi/com/sun/star/view/XViewCursor.idl index 8d62d5812d05..5f20dca37b6c 100644 --- a/offapi/com/sun/star/view/XViewCursor.idl +++ b/offapi/com/sun/star/view/XViewCursor.idl @@ -40,12 +40,12 @@ published interface XViewCursor: com::sun::star::uno::XInterface specifies the number of lines to go down. @param bExpand - determines whether the text range of the cursor is expanded (<TRUE/>) - or the cursor will be just at the new position after the move (<FALSE/>). + determines whether the text range of the cursor is expanded (`TRUE`) + or the cursor will be just at the new position after the move (`FALSE`). @returns - <TRUE/> if the cursor was moved, - or <FALSE/> if it was already in the bottom row. + `TRUE` if the cursor was moved, + or `FALSE` if it was already in the bottom row. */ boolean goDown( [in] short nCount, [in] boolean bExpand ); @@ -55,11 +55,11 @@ published interface XViewCursor: com::sun::star::uno::XInterface specifies the number of lines to go up. @param bExpand - determines whether the text range of the cursor is expanded (<TRUE/>) + determines whether the text range of the cursor is expanded (`TRUE`) @returns - <TRUE/> if the cursor was moved, - or <FALSE/> if it was already in the top row. + `TRUE` if the cursor was moved, + or `FALSE` if it was already in the top row. */ boolean goUp( [in] short nCount, [in] boolean bExpand ); @@ -69,11 +69,11 @@ published interface XViewCursor: com::sun::star::uno::XInterface specifies the number of characters to move. @param bExpand - determines whether the text range of the cursor is expanded (<TRUE/>) + determines whether the text range of the cursor is expanded (`TRUE`) @returns - <TRUE/> if the cursor was moved, - or <FALSE/> if it was already at the leftmost position. + `TRUE` if the cursor was moved, + or `FALSE` if it was already at the leftmost position. */ boolean goLeft( [in] short nCount, [in] boolean bExpand ); @@ -83,11 +83,11 @@ published interface XViewCursor: com::sun::star::uno::XInterface specifies the number of characters to move. @param bExpand - determines whether the text range of the cursor is expanded (<TRUE/>) + determines whether the text range of the cursor is expanded (`TRUE`) @returns - <TRUE/> if the cursor was moved, - or <FALSE/> if it was already at the rightmost position. + `TRUE` if the cursor was moved, + or `FALSE` if it was already at the rightmost position. */ boolean goRight( [in] short nCount, [in] boolean bExpand ); diff --git a/offapi/com/sun/star/xml/XExportFilter.idl b/offapi/com/sun/star/xml/XExportFilter.idl index 6b0c9a24683b..8dab67065caf 100644 --- a/offapi/com/sun/star/xml/XExportFilter.idl +++ b/offapi/com/sun/star/xml/XExportFilter.idl @@ -52,7 +52,7 @@ published interface XExportFilter: com::sun::star::uno::XInterface TypeDetection.xml (???) @returns - <TRUE/> if import process is successful + `TRUE` if import process is successful */ boolean exporter( [in] sequence< com::sun::star::beans::PropertyValue > aSourceData, diff --git a/offapi/com/sun/star/xml/XImportFilter.idl b/offapi/com/sun/star/xml/XImportFilter.idl index b51c9891dedc..973fbcefa852 100644 --- a/offapi/com/sun/star/xml/XImportFilter.idl +++ b/offapi/com/sun/star/xml/XImportFilter.idl @@ -55,7 +55,7 @@ published interface XImportFilter: com::sun::star::uno::XInterface target for the XML document representation @returns - <TRUE/> if import process is successful + `TRUE` if import process is successful */ boolean importer( [in] sequence< com::sun::star::beans::PropertyValue > aSourceData, diff --git a/offapi/com/sun/star/xml/crypto/XCipherContextSupplier.idl b/offapi/com/sun/star/xml/crypto/XCipherContextSupplier.idl index 1fd2d5065c3d..f447e588904e 100644 --- a/offapi/com/sun/star/xml/crypto/XCipherContextSupplier.idl +++ b/offapi/com/sun/star/xml/crypto/XCipherContextSupplier.idl @@ -48,8 +48,8 @@ interface XCipherContextSupplier : com::sun::star::uno::XInterface @param bEncryption whether an encryption or decryption cipher should be created - <TRUE/> - Encryption - <FALSE/> - Decryption + `TRUE` - Encryption + `FALSE` - Decryption @param aParams optional parameters that could be used to initialize the cipher, diff --git a/offapi/com/sun/star/xml/sax/XFastAttributeList.idl b/offapi/com/sun/star/xml/sax/XFastAttributeList.idl index 25ff2f914f6a..6361a6dffa92 100644 --- a/offapi/com/sun/star/xml/sax/XFastAttributeList.idl +++ b/offapi/com/sun/star/xml/sax/XFastAttributeList.idl @@ -52,7 +52,7 @@ interface XFastAttributeList: com::sun::star::uno::XInterface <b>or</b> operation. @returns - <TRUE/>, if the attribute is available + `TRUE`, if the attribute is available */ boolean hasAttribute( [in] long Token ); |