LibreOffice
LibreOffice 6.4 SDK API Reference
Public Member Functions | List of all members
XStringResourceWithLocation Interface Reference

Extends XStringResourcePersistence by methods to handle an associated location. More...

import"XStringResourceWithLocation.idl";

Inheritance diagram for XStringResourceWithLocation:
XStringResourcePersistence XStringResourceManager XStringResourceResolver XModifyBroadcaster XInterface StringResourceWithLocation

Public Member Functions

void storeAsURL ([in] string URL) raises ( com::sun::star::uno::Exception )
 Stores all string table data to a location and associates this location to this instance as if setLocation() was called with this location. More...
 
void setURL ([in] string URL) raises ( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::NoSupportException )
 Associates a location to the StringResourceWithStorage instance which is used on subsequent calls of store(). More...
 
- Public Member Functions inherited from XStringResourcePersistence
void store () raises ( com::sun::star::lang::NoSupportException, com::sun::star::uno::Exception )
 Stores all string table data respectively all data modified since the last call to store() to the location or storage associated with the StringResourceManager. More...
 
boolean isModified ()
 provides the current modify state of the StringResourceManager instance. More...
 
void setComment ([in] string Comment)
 Sets the comment stored first in each locale data file. More...
 
void storeToStorage ([in] ::com::sun::star::embed::XStorage Storage, [in] string BaseName, [in] string Comment) raises ( com::sun::star::uno::Exception )
 Stores all string table data to the provided storage. More...
 
void storeToURL ([in] string URL, [in] string BaseName, [in] string Comment, [in] com::sun::star::task::XInteractionHandler Handler) raises ( com::sun::star::uno::Exception )
 Stores all string table data to the location specified by the passed URL string. More...
 
sequence< byte > exportBinary ()
 Returns a sequence of byte representing the complete string resource in a binary format. More...
 
void importBinary ([in] sequence< byte > Data) raises ( com::sun::star::lang::IllegalArgumentException )
 Initializes the string resource with binary data. More...
 
- Public Member Functions inherited from XStringResourceManager
boolean isReadOnly ()
 Returns the resource's read only state. More...
 
void setCurrentLocale ([in] com::sun::star::lang::Locale Locale, [in] boolean FindClosestMatch) raises ( com::sun::star::lang::IllegalArgumentException )
 Sets the locale to be used. More...
 
void setDefaultLocale ([in] com::sun::star::lang::Locale Locale) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::NoSupportException )
 Sets the default locale to be used. More...
 
void setString ([in] string ResourceID, [in] string Str) raises ( com::sun::star::lang::NoSupportException )
 Associates a String to a Resource ID for the current locale. More...
 
void setStringForLocale ([in] string ResourceID, [in] string Str, [in] com::sun::star::lang::Locale locale) raises ( com::sun::star::lang::NoSupportException )
 Associates a String to a Resource ID for a specific locale. More...
 
void removeId ([in] string ResourceID) raises ( com::sun::star::resource::MissingResourceException, com::sun::star::lang::NoSupportException )
 Removes a Resource ID including the corresponding string for the current locale. More...
 
void removeIdForLocale ([in] string ResourceID, [in] com::sun::star::lang::Locale locale) raises ( com::sun::star::resource::MissingResourceException, com::sun::star::lang::NoSupportException )
 Removes a Resource ID including the corresponding string for s specific locale. More...
 
void newLocale ([in] com::sun::star::lang::Locale locale) raises ( com::sun::star::container::ElementExistException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::NoSupportException )
 Creates a new locale. More...
 
void removeLocale ([in] com::sun::star::lang::Locale locale) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::NoSupportException )
 Removes a locale completely including the corresponding strings for each locale. More...
 
long getUniqueNumericId () raises ( com::sun::star::lang::NoSupportException )
 Provides a numeric id that is unique within all Resource IDs used in the string table. More...
 
- Public Member Functions inherited from XStringResourceResolver
string resolveString ([in] string ResourceID) raises ( com::sun::star::resource::MissingResourceException )
 Resolves the passed ResourceID for the current locale. More...
 
string resolveStringForLocale ([in] string ResourceID, [in] com::sun::star::lang::Locale locale) raises ( com::sun::star::resource::MissingResourceException )
 Resolves the passed ResourceID for a specific locale. More...
 
boolean hasEntryForId ([in] string ResourceID)
 Checks if the resource contains an entry for the given ResourceID and current locale. More...
 
boolean hasEntryForIdAndLocale ([in] string ResourceID, [in] com::sun::star::lang::Locale locale)
 Checks if the resource contains an entry for the given ResourceID and locale. More...
 
sequence< string > getResourceIDs ()
 Returns a sequence of all valid Resource IDs for the current locale. More...
 
sequence< string > getResourceIDsForLocale ([in] com::sun::star::lang::Locale locale)
 Returns a sequence of all valid Resource IDs for a specific locale. More...
 
com::sun::star::lang::Locale getCurrentLocale ()
 Returns the current locale specified in the accessed resource. More...
 
com::sun::star::lang::Locale getDefaultLocale ()
 Returns the default locale of the accessed resource. More...
 
sequence< com::sun::star::lang::LocalegetLocales ()
 Returns a sequence of all supported locales. More...
 
- Public Member Functions inherited from XModifyBroadcaster
void addModifyListener ([in] com::sun::star::util::XModifyListener aListener)
 adds the specified listener to receive events "modified." More...
 
void removeModifyListener ([in] com::sun::star::util::XModifyListener aListener)
 removes the specified listener. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

Extends XStringResourcePersistence by methods to handle an associated location.

See also
XStringResourcePersistence.

Member Function Documentation

◆ setURL()

Associates a location to the StringResourceWithStorage instance which is used on subsequent calls of store().

Parameters
URLthe location to be associated to the StringResourceManager

This call has to be used carefully as it removes the location previously connected to the StringResourceWithStorage. It may force the implementation to reload data from the previous location before releasing it. The StringResourceManager will be modified after calling this method as the data isn't stored to the new location yet. storeAsURL() should be preferred as it directly stores the data to the new location and afterwards this location is in sync with the resource data.

Exceptions
com::sun::star::lang::IllegalArgumentExceptionif an empty string is passed as URL
com::sun::star::lang::NoSupportExceptionif the location is readonly

◆ storeAsURL()

void storeAsURL ( [in] string  URL)
raises (com::sun::star::uno::Exception
)

Stores all string table data to a location and associates this location to this instance as if setLocation() was called with this location.

The modified state will be unmodified after the call.

Parameters
URLthe location the string table data should be stored to.

The documentation for this interface was generated from the following file: