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/ui/ConfigurableUIElement.idl | 2 +- offapi/com/sun/star/ui/XImageManager.idl | 2 +- offapi/com/sun/star/ui/XModuleUIConfigurationManager.idl | 8 ++++---- offapi/com/sun/star/ui/XToolPanel.idl | 2 +- offapi/com/sun/star/ui/XUIConfigurationManager.idl | 6 +++--- offapi/com/sun/star/ui/XUIConfigurationPersistence.idl | 8 ++++---- offapi/com/sun/star/ui/XUIConfigurationStorage.idl | 2 +- offapi/com/sun/star/ui/XUIElementFactory.idl | 2 +- offapi/com/sun/star/ui/XUIElementSettings.idl | 4 ++-- offapi/com/sun/star/ui/dialogs/XControlInformation.idl | 8 ++++---- offapi/com/sun/star/ui/dialogs/XFilePicker.idl | 4 ++-- offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl | 10 +++++----- offapi/com/sun/star/ui/dialogs/XFilePreview.idl | 12 ++++++------ offapi/com/sun/star/ui/dialogs/XWizard.idl | 8 ++++---- offapi/com/sun/star/ui/dialogs/XWizardPage.idl | 4 ++-- 15 files changed, 41 insertions(+), 41 deletions(-) (limited to 'offapi/com/sun/star/ui') 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.

- If the property #Persistent is 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 - if an image is associated, otherwise . + `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 - if settings have been found in the default layer, - otherwise . + `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 - if default settings have been found in the default layer, - otherwise . + `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. -

It is allowed for an implementation to return here, but in this case some functionality, for instance +

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.

*/ [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 - if settings have been found, otherwise . + `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 if the retrieved settings should be a writable. - Otherwise 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 - if the configuration manager has changed since the - last store() call. 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 - if the configuration manager storage is read-only otherwise - . + `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 - if the instance has a storage otherwise . + `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
  • Persistent
    specifies if changes to a configurable user interface element should be persistent. This is an - optional argument. The default value is .
    • + optional argument. The default value is `TRUE`.

    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 if the retrieved settings should be a writable. - Otherwise 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 getSupportedControls( ); instance "OkButton" or "CancelButton". @returns - if the specified control is supported. - 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 getSupportedControlProperties( [in] string aControlName ) The control property to query for. @returns - if the specified control action is supported. - 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

    @param bMode -

    A value of enables the multi-selection mode.

    -

    A value of disables the multi-selection mode, this is the default.

    +

    A value of `TRUE` enables the multi-selection mode.

    +

    A value of `FALSE` disables the multi-selection mode, this is the default.

    */ 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 if the checkbox should be checked and 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 - if the checkbox is checked 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 -

    If the specified control will be enabled.

    -

    If the specified control will be disabled.

    +

    If `TRUE` the specified control will be enabled.

    +

    If `FALSE` the specified control will be disabled.

    @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 shows the preview window. -

    A value of hides the preview window.

    + A value of `TRUE` shows the preview window. +

    A value of `FALSE` hides the preview window.

    @returns - A value of on success. -

    A value of if the operation fails for any reason or the preview + A value of `TRUE` on success. +

    A value of `FALSE` if the operation fails for any reason or the preview implementation doesn't support hiding the preview.

    */ 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 if the preview window is visible. -

    A value of if the preview window is invisible.

    + A value of `TRUE` if the preview window is visible. +

    A value of `FALSE` if the preview window is invisible.

    */ 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 () or disabled () + 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.

    For instance, the Next button is disabled if the current page's XWizardPage::canAdvance() - method returns .

    + method returns `FALSE`.

    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.

    @@ -187,10 +187,10 @@ interface XWizard @param PathIndex the index of the path, as used in the Wizard::createMultiplePathsWizard() constructor. @param Final -

    If , the path will be completely activated, even if it is a conflicting path (i.e. there is another +

    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 k states with the to-be-activated path.)

    -

    If , then the new path is checked for conflicts with other paths. If such conflicts exists, the path +

    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 not conflict.

    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 -

    An implementation can veto the leave by returning here. Usually, the decision about this +

    An implementation can veto the leave by returning `FALSE` here. Usually, the decision about this depends on the current state of the page.

    @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

    You should base this decision on the state of the page only, not on a global state of the wizard. Usually, - you return 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.

    If checked for validity is expensive, or if you prefer giving your user more detailed feedback on validity -- cgit