From 928b8640c0d1a9c49249100efbdd70f8c1090b07 Mon Sep 17 00:00:00 2001 From: Michael Stahl Date: Sun, 28 Apr 2013 00:44:31 +0200 Subject: *api: convert sed -i 's,<\(TRUE\|FALSE\|VOID\|NULL\)/>,`\1`,g' Change-Id: Ia4df97ca809b00993530d67203bbe4ba7a072201 --- offapi/com/sun/star/drawing/FillProperties.idl | 28 +++++++++++----------- offapi/com/sun/star/drawing/GluePoint.idl | 2 +- offapi/com/sun/star/drawing/LineProperties.idl | 4 ++-- offapi/com/sun/star/drawing/MeasureProperties.idl | 12 +++++----- offapi/com/sun/star/drawing/OLE2Shape.idl | 2 +- offapi/com/sun/star/drawing/ShadowProperties.idl | 2 +- offapi/com/sun/star/drawing/Shape.idl | 8 +++---- offapi/com/sun/star/drawing/TextProperties.idl | 22 ++++++++--------- offapi/com/sun/star/drawing/XPresenterHelper.idl | 16 ++++++------- offapi/com/sun/star/drawing/XSlideSorterBase.idl | 26 ++++++++++---------- .../sun/star/drawing/framework/XConfiguration.idl | 6 ++--- .../XConfigurationControllerRequestQueue.idl | 4 ++-- .../drawing/framework/XRelocatableResource.idl | 2 +- .../com/sun/star/drawing/framework/XResource.idl | 2 +- .../com/sun/star/drawing/framework/XResourceId.idl | 4 ++-- offapi/com/sun/star/drawing/framework/XTabBar.idl | 2 +- 16 files changed, 71 insertions(+), 71 deletions(-) (limited to 'offapi/com/sun/star/drawing') 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 , 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. -

If this is , the properties #FillBitmapSizeX +

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 , 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 and #FillBitmapTile.

If set to BitmapMode::REPEAT, the property - FillBitmapStretch is set to , and the property FillBitmapTile - is set to .

+ FillBitmapStretch is set to `FALSE`, and the property FillBitmapTile + is set to `TRUE`.

If set to BitmapMode::STRETCH, the property - FillBitmapStretch is set to , and the property FillBitmapTile - is set to .

+ FillBitmapStretch is set to `TRUE`, and the property FillBitmapTile + is set to `FALSE`.

If set to BitmapMode::NO_REPEAT, both properties - FillBitmapStretch and FillBitmapTile are set to .

+ FillBitmapStretch and FillBitmapTile are set to `FALSE`.

*/ [property] BitmapMode FillBitmapMode; @@ -181,11 +181,11 @@ published service FillProperties completeness. The #FillBitmapMode property can be used instead to set all supported bitmap modes.

-

If set to , the value of the FillBitmapMode property changes +

If set to `TRUE`, the value of the FillBitmapMode property changes to BitmapMode::STRETCH. BUT: behavior is undefined, if - the property #FillBitmapTile is too.

+ the property #FillBitmapTile is `TRUE` too.

-

If set to , the value of the FillBitmapMode property +

If set to `FALSE`, the value of the FillBitmapMode property changes to BitmapMode::REPEAT or BitmapMode::NO_REPEAT, depending on the current value of the #FillBitmapTile property.

@@ -198,11 +198,11 @@ published service FillProperties completeness. The #FillBitmapMode property can be used instead to set all supported bitmap modes.

-

If set to , the value of the FillBitmapMode property changes +

If set to `TRUE`, the value of the FillBitmapMode property changes to BitmapMode::REPEAT. BUT: behavior is undefined, if - the property #FillBitmapStretch is too.

+ the property #FillBitmapStretch is `TRUE` too.

-

If set to , the value of the FillBitmapMode property +

If set to `FALSE`, the value of the FillBitmapMode property changes to BitmapMode::STRETCH or BitmapMode::NO_REPEAT, depending on the current value of the #FillBitmapStretch property.

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 , 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 , 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 , 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 , 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 , 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 , 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 , the measure has a fixed angle. + /** If this value is `TRUE`, the measure has a fixed angle. */ [property] boolean MeasureTextIsFixedAngle; - /** If this value is , the text is rotated 90 degrees. + /** If this value is `TRUE`, the text is rotated 90 degrees. */ [property] boolean MeasureTextRotate90; - /** If this value is , 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 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.

The other shadow properties are only applied if this is - set to .

+ set to `TRUE`.

*/ [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 , 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 , 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 , 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 , 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 , 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 , 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 , 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 , 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 , 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.

This is only useful if Text::TextHorizontalAdjust is BLOCK or STRETCH or if - Text::TextFitSize is .

+ Text::TextFitSize is `TRUE`.

*/ [property] long TextLeftDistance; @@ -152,7 +152,7 @@ published service TextProperties

This is only useful if Text::TextHorizontalAdjust is BLOCK or STRETCH - or if Text::TextFitSize is .

+ or if Text::TextFitSize is `TRUE`.

*/ [property] long TextRightDistance; @@ -162,7 +162,7 @@ published service TextProperties

This is only useful if Text::TextVerticalAdjust is BLOCK or if Text::TextFitSize is - .

+ `TRUE`.

*/ [property] long TextUpperDistance; @@ -174,7 +174,7 @@ published service TextProperties

This is only useful if Text::TextVerticalAdjust is BLOCK or if Text::TextFitSize is - .

+ `TRUE`.

*/ [property] long TextLowerDistance; @@ -234,13 +234,13 @@ published service TextProperties [property] com::sun::star::drawing::TextAnimationKind TextAnimationKind; - /** If this value is , 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 , 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 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 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 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 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 + This canvas is used to call updateScreen() on. May be `NULL` @param xUpdateWindow The window that belongs to the update canvas. May also be - (is expected to b 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 + 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 + 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 in order to have the current slide + /** Set this flag to `TRUE` in order to have the current slide highlighted. -

The default value is .

+

The default value is `FALSE`.

*/ [attribute] boolean IsHighlightCurrentSlide; - /** Set this flag to 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). -

The default value is .

+

The default value is `TRUE`.

*/ [attribute] boolean IsShowSelection; - /** Set this flag to 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. -

The default value is .

+

The default value is `TRUE`.

*/ [attribute] boolean IsShowFocus; - /** When this flag has the value 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.

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.

-

The default value is . +

The default value is `FALSE`. */ [attribute] boolean IsCenterSelection; /** This flag controls whether updates of previews are created during - full screen presentations () or not (). The + full screen presentations (`FALSE`) or not (`TRUE`). The suspension of preview creations is an optimization for not slowing down a running presentation. -

The default value is .

+

The default value is `TRUE`.

*/ [attribute] boolean IsSuspendPreviewUpdatesDuringFullScreenPresentation; - /** The orientation of a slide sorter can be either vertical () - or horizontal (). + /** 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. -

The default value is .

+

The default value is `TRUE`.

*/ [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 is + XResourceId object) in which case `FALSE` is returned. @return - Returns when the resource is part of the configuration - and 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 when there is at least one request object in the - queue that has not yet been processed. It returns 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 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 and the typical view will return . + 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 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 . + the given anchor in order to have this function return `TRUE`.

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 when the button exists. + Returns `TRUE` when the button exists. */ boolean hasTabBarButton ([in] TabBarButton aButton); -- cgit