diff options
Diffstat (limited to 'framework/source/inc/accelerators')
6 files changed, 119 insertions, 119 deletions
diff --git a/framework/source/inc/accelerators/acceleratorcache.hxx b/framework/source/inc/accelerators/acceleratorcache.hxx index 63986d98a41f..341cc85b7230 100644 --- a/framework/source/inc/accelerators/acceleratorcache.hxx +++ b/framework/source/inc/accelerators/acceleratorcache.hxx @@ -28,13 +28,13 @@ #include <comphelper/sequenceasvector.hxx> -//__________________________________________ + // definition namespace framework { -//__________________________________________ + /** @short implements a cache for any accelerator configuration. @@ -46,19 +46,19 @@ namespace framework */ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first base class to guarentee right initialize lock ... { - //______________________________________ + // const, types public: - //--------------------------------------- + /** TODO document me commands -> keys */ typedef ::comphelper::SequenceAsVector< css::awt::KeyEvent > TKeyList; typedef BaseHash< TKeyList > TCommand2Keys; - //--------------------------------------- + /** TODO document me keys -> commands */ @@ -67,40 +67,40 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b KeyEventHashCode , KeyEventEqualsFunc > TKey2Commands; - //______________________________________ + // member private: - //--------------------------------------- + /** map commands to keys in relation 1:n. First key is interpreted as preferred one! */ TCommand2Keys m_lCommand2Keys; - //--------------------------------------- + /** map keys to commands in relation 1:1. */ TKey2Commands m_lKey2Commands; - //______________________________________ + // interface public: - //--------------------------------------- + /** @short creates a new - but empty - cache instance. */ AcceleratorCache(); - //--------------------------------------- + /** @short make a copy of this cache. @descr Used for the copy-on-write feature. */ AcceleratorCache(const AcceleratorCache& rCopy); - //--------------------------------------- + /** @short does nothing real. */ virtual ~AcceleratorCache(); - //--------------------------------------- + /** @short write changes back to the original container. @param rCopy @@ -109,11 +109,11 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b */ virtual void takeOver(const AcceleratorCache& rCopy); - //--------------------------------------- + /** TODO document me */ AcceleratorCache& operator=(const AcceleratorCache& rCopy); - //--------------------------------------- + /** @short checks if the specified key exists. @param aKey @@ -125,11 +125,11 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b virtual sal_Bool hasKey(const css::awt::KeyEvent& aKey) const; virtual sal_Bool hasCommand(const OUString& sCommand) const; - //--------------------------------------- + /** TODO document me */ virtual TKeyList getAllKeys() const; - //--------------------------------------- + /** @short add a new or change an existing key-command pair of this container. @@ -142,7 +142,7 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b virtual void setKeyCommandPair(const css::awt::KeyEvent& aKey , const OUString& sCommand); - //--------------------------------------- + /** @short returns the list of keys, which are registered for this command. @@ -154,11 +154,11 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b */ virtual TKeyList getKeysByCommand(const OUString& sCommand) const; - //--------------------------------------- + /** TODO */ virtual OUString getCommandByKey(const css::awt::KeyEvent& aKey) const; - //--------------------------------------- + /** TODO */ virtual void removeKey(const css::awt::KeyEvent& aKey); virtual void removeCommand(const OUString& sCommand); diff --git a/framework/source/inc/accelerators/acceleratorconfiguration.hxx b/framework/source/inc/accelerators/acceleratorconfiguration.hxx index 535f87358c91..179492564a06 100644 --- a/framework/source/inc/accelerators/acceleratorconfiguration.hxx +++ b/framework/source/inc/accelerators/acceleratorconfiguration.hxx @@ -51,7 +51,7 @@ #include <cppuhelper/implbase4.hxx> #include <salhelper/singletonref.hxx> -//__________________________________________ + // definition namespace framework @@ -65,7 +65,7 @@ const char CFG_ENTRY_MODULES[] = "Modules"; in combination with the salhelper::SingletonRef mechanism! */ typedef PresetHandler AcceleratorPresets; -//__________________________________________ + /** implements a read/write access to the accelerator configuration. */ @@ -77,17 +77,17 @@ class XMLBasedAcceleratorConfiguration : protected ThreadHelpBase, // css::ui::XUIConfigurationStorage // css::ui::XUIConfiguration { - //______________________________________ + // member protected: - //--------------------------------------- + /** the global uno service manager. Must be used to create own needed services. */ css::uno::Reference< css::uno::XComponentContext > m_xContext; - //--------------------------------------- + /** used to: i ) copy configuration files from the share to the user layer ii ) provide access to these config files @@ -95,15 +95,15 @@ class XMLBasedAcceleratorConfiguration : protected ThreadHelpBase, iv ) provide commit for changes. */ PresetHandler m_aPresetHandler; - //--------------------------------------- + /** contains the cached configuration data */ AcceleratorCache m_aReadCache; - //--------------------------------------- + /** used to implement the copy on write pattern! */ AcceleratorCache* m_pWriteCache; - //______________________________________ + // native interface! public: @@ -111,7 +111,7 @@ class XMLBasedAcceleratorConfiguration : protected ThreadHelpBase, XMLBasedAcceleratorConfiguration( const css::uno::Reference< css::uno::XComponentContext >& xContext); virtual ~XMLBasedAcceleratorConfiguration( ); - //______________________________________ + // uno interface! public: @@ -194,12 +194,12 @@ class XMLBasedAcceleratorConfiguration : protected ThreadHelpBase, // IStorageListener virtual void changesOccurred(const OUString& sPath); - //______________________________________ + // helper for derived classes protected: - //--------------------------------------- + /** @short return the current office locale. @descr We do not cache this value, because we are not listen @@ -210,12 +210,12 @@ class XMLBasedAcceleratorConfiguration : protected ThreadHelpBase, */ OUString impl_ts_getLocale() const; - //______________________________________ + // helper private: - //--------------------------------------- + /** @short load a configuration set, using the given stream. @param xStream @@ -223,7 +223,7 @@ class XMLBasedAcceleratorConfiguration : protected ThreadHelpBase, */ void impl_ts_load(const css::uno::Reference< css::io::XInputStream >& xStream); - //--------------------------------------- + /** @short save a configuration set, using the given stream. @param xStream @@ -231,7 +231,7 @@ class XMLBasedAcceleratorConfiguration : protected ThreadHelpBase, */ void impl_ts_save(const css::uno::Reference< css::io::XOutputStream >& xStream); - //--------------------------------------- + /** @short try to locate and open a sub storage. @descr It search at the root storage for the specified @@ -259,7 +259,7 @@ class XMLBasedAcceleratorConfiguration : protected ThreadHelpBase, const OUString& sSubStorage , sal_Bool bOutStream ); - //--------------------------------------- + /** @short returns a reference to one of our internal cache members. @descr We implement the copy-on-write pattern. Doing so @@ -291,12 +291,12 @@ class XCUBasedAcceleratorConfiguration : protected ThreadHelpBase, // css::ui::XUIConfigurationStorage // css::ui::XUIConfiguration { - //______________________________________ + // member protected: - //--------------------------------------- + /** the global uno service manager. Must be used to create own needed services. */ css::uno::Reference< css::uno::XComponentContext > m_xContext; @@ -312,7 +312,7 @@ class XCUBasedAcceleratorConfiguration : protected ThreadHelpBase, ::salhelper::SingletonRef< KeyMapping > m_rKeyMapping; - //______________________________________ + // native interface! public: @@ -320,7 +320,7 @@ class XCUBasedAcceleratorConfiguration : protected ThreadHelpBase, XCUBasedAcceleratorConfiguration( const css::uno::Reference< css::uno::XComponentContext >& xContext ); virtual ~XCUBasedAcceleratorConfiguration( ); - //______________________________________ + // uno interface! public: @@ -413,12 +413,12 @@ class XCUBasedAcceleratorConfiguration : protected ThreadHelpBase, virtual void SAL_CALL addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException, std::exception); virtual void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& aListener ) throw (::com::sun::star::uno::RuntimeException, std::exception); - //______________________________________ + // helper for derived classes protected: - //--------------------------------------- + /** @short return the current office locale. @descr We do not cache this value, because we are not listen @@ -429,7 +429,7 @@ class XCUBasedAcceleratorConfiguration : protected ThreadHelpBase, */ OUString impl_ts_getLocale() const; - //______________________________________ + // helper private: diff --git a/framework/source/inc/accelerators/istoragelistener.hxx b/framework/source/inc/accelerators/istoragelistener.hxx index 9d84c26d1338..154a1eb0caee 100644 --- a/framework/source/inc/accelerators/istoragelistener.hxx +++ b/framework/source/inc/accelerators/istoragelistener.hxx @@ -24,13 +24,13 @@ #include <stdtypes.h> -//__________________________________________ + // definition namespace framework { -//__________________________________________ + /** TODO document me */ @@ -38,7 +38,7 @@ class IStorageListener { public: - //-------------------------------------- + /** @short TODO */ virtual void changesOccurred(const OUString& sPath) = 0; diff --git a/framework/source/inc/accelerators/keymapping.hxx b/framework/source/inc/accelerators/keymapping.hxx index d73816af181b..0336934f4358 100644 --- a/framework/source/inc/accelerators/keymapping.hxx +++ b/framework/source/inc/accelerators/keymapping.hxx @@ -30,19 +30,19 @@ namespace framework { -//__________________________________________ + /** can be used to map key identifier to the corresponding key codes ... */ class KeyMapping { - //______________________________________ + // const, types private: - //--------------------------------------- + /** @short is used to map a key code to the right key identifier, which is used to make the xml file "human readable" @@ -53,33 +53,33 @@ class KeyMapping const char* Identifier; }; - //--------------------------------------- + /** @short hash structure to map identifier to key codes. */ typedef BaseHash< sal_Int16 > Identifier2CodeHash; - //--------------------------------------- + /** @short hash structure to map key codes to identifier. */ typedef ::boost::unordered_map< sal_Int16 , OUString , ShortHashCode , ::std::equal_to< sal_Int16 > > Code2IdentifierHash; - //______________________________________ + // member private: static KeyIdentifierInfo KeyIdentifierMap[]; - //--------------------------------------- + /** @short hash to map identifier to key codes. */ Identifier2CodeHash m_lIdentifierHash; - //--------------------------------------- + /** @short hash to map key codes to identifier. */ Code2IdentifierHash m_lCodeHash; - //______________________________________ + // interface public: @@ -87,7 +87,7 @@ class KeyMapping KeyMapping(); virtual ~KeyMapping(); - //---------------------------------- + /** @short return a suitable key code for the specified key identifier. @@ -105,7 +105,7 @@ class KeyMapping virtual sal_uInt16 mapIdentifierToCode(const OUString& sIdentifier) throw(css::lang::IllegalArgumentException); - //---------------------------------- + /** @short return a suitable key identifier for the specified key code. @@ -116,12 +116,12 @@ class KeyMapping */ virtual OUString mapCodeToIdentifier(sal_uInt16 nCode); - //______________________________________ + // helper private: - //---------------------------------- + /** @short check if the given string describe a numeric value ... and convert it. diff --git a/framework/source/inc/accelerators/presethandler.hxx b/framework/source/inc/accelerators/presethandler.hxx index 45896436572e..1ca54f710f5e 100644 --- a/framework/source/inc/accelerators/presethandler.hxx +++ b/framework/source/inc/accelerators/presethandler.hxx @@ -64,12 +64,12 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas static OUString RESOURCETYPE_ACCELERATOR(); static OUString RESOURCETYPE_STATUSBAR(); - //------------------------------------------- + // types public: - //--------------------------------------- + /** @short this handler can provide different types of configuration. @@ -85,7 +85,7 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas private: - //--------------------------------------- + /** @short because a concurrent access to the same storage from different implementations isnt supported, we have to share it with others. @@ -112,23 +112,23 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas virtual ~TSharedStorages() {}; }; - //------------------------------------------- + // member private: - //--------------------------------------- + /** @short can be used to create on needed uno resources. */ css::uno::Reference< css::uno::XComponentContext > m_xContext; - //--------------------------------------- + /** @short knows the type of provided configuration. @descr e.g. global, modules, ... */ EConfigType m_eConfigType; - //--------------------------------------- + /** @short specify the type of resource, which configuration sets must be provided here. @@ -136,7 +136,7 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas */ OUString m_sResourceType; - //--------------------------------------- + /** @short specify the application module for a module dependend configuration. @@ -146,19 +146,19 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas */ OUString m_sModule; - //--------------------------------------- + /** @short provides access to the: a) shared root storages b) shared "inbetween" storages of the share and user layer. */ ::salhelper::SingletonRef< TSharedStorages > m_aSharedStorages; - //--------------------------------------- + /** @short if we run in document mode, we cant use the global root storages! We have to use a special document storage explicitly. */ StorageHolder m_lDocumentStorages; - //--------------------------------------- + /** @short holds the folder storage of the share layer alive, where the current configuration set exists. @@ -171,12 +171,12 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas */ css::uno::Reference< css::embed::XStorage > m_xWorkingStorageShare; - //--------------------------------------- + /** @short global language-independent storage */ css::uno::Reference< css::embed::XStorage > m_xWorkingStorageNoLang; - //--------------------------------------- + /** @short holds the folder storage of the user layer alive, where the current configuration set exists. @@ -189,17 +189,17 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas */ css::uno::Reference< css::embed::XStorage > m_xWorkingStorageUser; - //--------------------------------------- + /** @short knows the names of all presets inside the current working storage of the share layer. */ OUStringList m_lPresets; - //--------------------------------------- + /** @short knows the names of all targets inside the current working storage of the user layer. */ OUStringList m_lTargets; - //--------------------------------------- + /** @short its the current office locale and will be used to handle localized presets. @@ -207,18 +207,18 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas localized handling inside this class! */ LanguageTag m_aLanguageTag; - //--------------------------------------- + /** @short knows the relative path from the root. */ OUString m_sRelPathShare; OUString m_sRelPathNoLang; OUString m_sRelPathUser; - //------------------------------------------- + // native interface public: - //--------------------------------------- + /** @short does nothing real. @descr Because this class should be useable in combination @@ -231,19 +231,19 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas */ PresetHandler(const css::uno::Reference< css::uno::XComponentContext >& xContext); - //--------------------------------------- + /** @short copy ctor */ PresetHandler(const PresetHandler& rCopy); - //--------------------------------------- + /** @short closes all open storages ... if user forgot that .-) */ virtual ~PresetHandler(); - //--------------------------------------- + /** @short free all currently cache(!) storages. */ void forgetCachedStorages(); - //--------------------------------------- + /** @short return access to the internally used and cached root storage. @descr These root storages are the base of all further opened @@ -261,7 +261,7 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas css::uno::Reference< css::embed::XStorage > getOrCreateRootStorageShare(); css::uno::Reference< css::embed::XStorage > getOrCreateRootStorageUser(); - //--------------------------------------- + /** @short provides access to the current working storages. @descr Working storages are the "lowest" storages, where the @@ -273,7 +273,7 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas css::uno::Reference< css::embed::XStorage > getWorkingStorageShare(); css::uno::Reference< css::embed::XStorage > getWorkingStorageUser(); - //--------------------------------------- + /** @short check if there is a parent storage well known for the specified child storage and return it. @@ -286,7 +286,7 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas css::uno::Reference< css::embed::XStorage > getParentStorageShare(const css::uno::Reference< css::embed::XStorage >& xChild); css::uno::Reference< css::embed::XStorage > getParentStorageUser (const css::uno::Reference< css::embed::XStorage >& xChild); - //--------------------------------------- + /** @short free all internal structures and let this handler work on a new type of configuration sets. @@ -327,7 +327,7 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas const css::uno::Reference< css::embed::XStorage >& xDocumentRoot , const LanguageTag& rLanguageTag = LanguageTag(LANGUAGE_USER_PRIV_NOTRANSLATE)); - //--------------------------------------- + /** @short try to copy the specified preset from the share layer to the user layer and establish it as the specified target. @@ -351,7 +351,7 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas void copyPresetToTarget(const OUString& sPreset, const OUString& sTarget); - //--------------------------------------- + /** @short open the specified preset as stream object and return it. @@ -369,7 +369,7 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas css::uno::Reference< css::io::XStream > openPreset(const OUString& sPreset, sal_Bool bUseNoLangGlobal = sal_False); - //--------------------------------------- + /** @short open the specified target as stream object and return it. @@ -391,7 +391,7 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas css::uno::Reference< css::io::XStream > openTarget(const OUString& sTarget , sal_Bool bCreateIfMissing); - //--------------------------------------- + /** @short do anything which is necessary to flush all changes back to disk. @@ -401,17 +401,17 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas */ void commitUserChanges(); - //--------------------------------------- + /** TODO */ void addStorageListener(IStorageListener* pListener); void removeStorageListener(IStorageListener* pListener); - //------------------------------------------- + // helper private: - //--------------------------------------- + /** @short open a config path ignoring errors (catching exceptions). @descr We catch only normal exceptions here - no runtime exceptions. @@ -431,7 +431,7 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas sal_Int32 eMode , sal_Bool bShare); - //--------------------------------------- + /** @short try to find the specified locale inside list of possible ones. @descr The lits of possible locale values was e.g. retrieved from the system @@ -458,7 +458,7 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas OUString& rLanguageTag , sal_Bool bAllowFallbacks ); - //--------------------------------------- + /** @short open a config path ignoring errors (catching exceptions). @descr We catch only normal exceptions here - no runtime exceptions. @@ -492,7 +492,7 @@ class PresetHandler : private ThreadHelpBase // attention! Must be the first bas OUString& rLanguageTag , sal_Bool bAllowFallback); - //--------------------------------------- + /** @short returns the names of all sub storages of specified storage. @param xFolder diff --git a/framework/source/inc/accelerators/storageholder.hxx b/framework/source/inc/accelerators/storageholder.hxx index 13bef973296a..8879e0319900 100644 --- a/framework/source/inc/accelerators/storageholder.hxx +++ b/framework/source/inc/accelerators/storageholder.hxx @@ -32,13 +32,13 @@ namespace framework { -//----------------------------------------------- + /** TODO document me */ class StorageHolder : private ThreadHelpBase // attention! Must be the first base class to guarentee right initialize lock ... { - //------------------------------------------- + // types public: @@ -65,7 +65,7 @@ class StorageHolder : private ThreadHelpBase // attention! Must be the first bas OUStringHash , ::std::equal_to< OUString > > TPath2StorageInfo; - //------------------------------------------- + // member private: @@ -75,95 +75,95 @@ class StorageHolder : private ThreadHelpBase // attention! Must be the first bas /** @short TODO */ TPath2StorageInfo m_lStorages; - //------------------------------------------- + // interface public: - //--------------------------------------- + /** @short TODO */ StorageHolder(); - //--------------------------------------- + /** @short TODO */ virtual ~StorageHolder(); - //--------------------------------------- + /** @short TODO */ virtual void forgetCachedStorages(); - //--------------------------------------- + /** @short TODO */ virtual void setRootStorage(const css::uno::Reference< css::embed::XStorage >& xRoot); - //--------------------------------------- + /** @short TODO */ virtual css::uno::Reference< css::embed::XStorage > getRootStorage() const; - //--------------------------------------- + /** @short TODO open or get! */ virtual css::uno::Reference< css::embed::XStorage > openPath(const OUString& sPath , sal_Int32 nOpenMode); - //--------------------------------------- + /** @short TODO */ virtual StorageHolder::TStorageList getAllPathStorages(const OUString& sPath); - //--------------------------------------- + /** @short TODO */ virtual void commitPath(const OUString& sPath); - //--------------------------------------- + /** @short TODO */ virtual void closePath(const OUString& sPath); - //--------------------------------------- + /** @short TODO */ virtual void notifyPath(const OUString& sPath); - //--------------------------------------- + /** @short TODO */ virtual void addStorageListener( IStorageListener* pListener, const OUString& sPath ); - //--------------------------------------- + /** @short TODO */ virtual void removeStorageListener( IStorageListener* pListener, const OUString& sPath ); - //--------------------------------------- + /** @short TODO */ virtual OUString getPathOfStorage(const css::uno::Reference< css::embed::XStorage >& xStorage); - //--------------------------------------- + /** @short TODO */ virtual css::uno::Reference< css::embed::XStorage > getParentStorage(const css::uno::Reference< css::embed::XStorage >& xChild); - //--------------------------------------- + /** @short TODO */ virtual css::uno::Reference< css::embed::XStorage > getParentStorage(const OUString& sChildPath); - //--------------------------------------- + /** @short TODO */ void operator=(const StorageHolder& rCopy); - //--------------------------------------- + /** @short opens a sub element of the specified base storage. @descr First this method try to open the requested sub element @@ -197,16 +197,16 @@ class StorageHolder : private ThreadHelpBase // attention! Must be the first bas sal_Int32 eOpenMode , sal_Bool bAllowFallback); - //--------------------------------------- + // helper private: - //----------------------------------- + /** @short TODO */ static OUString impl_st_normPath(const OUString& sPath); - //----------------------------------- + /** @short TODO */ static OUStringList impl_st_parsePath(const OUString& sPath); |