diff options
Diffstat (limited to 'framework/inc')
83 files changed, 821 insertions, 843 deletions
diff --git a/framework/inc/classes/actiontriggerpropertyset.hxx b/framework/inc/classes/actiontriggerpropertyset.hxx index 4542001f5f3b..c3219698afd3 100644 --- a/framework/inc/classes/actiontriggerpropertyset.hxx +++ b/framework/inc/classes/actiontriggerpropertyset.hxx @@ -65,9 +65,9 @@ class ActionTriggerPropertySet : public ThreadHelpBase , virtual FWE_DLLPUBLIC ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId( ) throw (::com::sun::star::uno::RuntimeException, std::exception); private: - //--------------------------------------------------------------------------------------------------------- + // OPropertySetHelper - //--------------------------------------------------------------------------------------------------------- + virtual sal_Bool SAL_CALL convertFastPropertyValue( com::sun::star::uno::Any& aConvertedValue, com::sun::star::uno::Any& aOldValue, sal_Int32 nHandle, @@ -88,9 +88,9 @@ class ActionTriggerPropertySet : public ThreadHelpBase , static const com::sun::star::uno::Sequence< com::sun::star::beans::Property > impl_getStaticPropertyDescriptor(); - //--------------------------------------------------------------------------------------------------------- + // helper - //--------------------------------------------------------------------------------------------------------- + sal_Bool impl_tryToChangeProperty( const OUString& aCurrentValue , const com::sun::star::uno::Any& aNewValue , @@ -107,9 +107,9 @@ class ActionTriggerPropertySet : public ThreadHelpBase , com::sun::star::uno::Any& aOldValue , com::sun::star::uno::Any& aConvertedValue ) throw( com::sun::star::lang::IllegalArgumentException ); - //--------------------------------------------------------------------------------------------------------- + // members - //--------------------------------------------------------------------------------------------------------- + OUString m_aCommandURL; OUString m_aHelpURL; diff --git a/framework/inc/classes/actiontriggerseparatorpropertyset.hxx b/framework/inc/classes/actiontriggerseparatorpropertyset.hxx index 025b9b0b8d08..de90232e1702 100644 --- a/framework/inc/classes/actiontriggerseparatorpropertyset.hxx +++ b/framework/inc/classes/actiontriggerseparatorpropertyset.hxx @@ -64,9 +64,9 @@ class ActionTriggerSeparatorPropertySet : public ThreadHelpBase virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId( ) throw (::com::sun::star::uno::RuntimeException, std::exception); private: - //--------------------------------------------------------------------------------------------------------- + // OPropertySetHelper - //--------------------------------------------------------------------------------------------------------- + virtual sal_Bool SAL_CALL convertFastPropertyValue( com::sun::star::uno::Any& aConvertedValue, com::sun::star::uno::Any& aOldValue, sal_Int32 nHandle, @@ -87,18 +87,18 @@ class ActionTriggerSeparatorPropertySet : public ThreadHelpBase static const com::sun::star::uno::Sequence< com::sun::star::beans::Property > impl_getStaticPropertyDescriptor(); - //--------------------------------------------------------------------------------------------------------- + // helper - //--------------------------------------------------------------------------------------------------------- + sal_Bool impl_tryToChangeProperty( sal_Int16 aCurrentValue , const com::sun::star::uno::Any& aNewValue , com::sun::star::uno::Any& aOldValue , com::sun::star::uno::Any& aConvertedValue ) throw( com::sun::star::lang::IllegalArgumentException ); - //--------------------------------------------------------------------------------------------------------- + // members - //--------------------------------------------------------------------------------------------------------- + sal_Int16 m_nSeparatorType; }; diff --git a/framework/inc/classes/checkediterator.hxx b/framework/inc/classes/checkediterator.hxx index ceb3d74b430d..f207e651c177 100644 --- a/framework/inc/classes/checkediterator.hxx +++ b/framework/inc/classes/checkediterator.hxx @@ -26,7 +26,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement a iterator which support 2 end states! @descr For our search methods we need a "walking" iterator object with special functionality! We must check for 3 different states of an iterator - normal position, exact end, after end. @@ -47,17 +47,17 @@ namespace framework{ template< class TContainer > class CheckedIterator { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - //--------------------------------------------------------------------------------------------------------- + // constructor / destructor - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short standard constructor @descr Set default values on members. We set it internal to E_UNKNOWN to detect uninitialized instances of this class. @@ -77,11 +77,11 @@ class CheckedIterator { } - //--------------------------------------------------------------------------------------------------------- + // interface methods - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short initialize instance with valid container @descr Set new container at an instance of this class. The other member will set automaticly! m_pPosition = first element in container @@ -110,7 +110,7 @@ class CheckedIterator } } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short set internal states to E_END @descr Sometimes we need a "walking" check-iterator which is initialized with the END-state! We need it to return one default value if no other ones exist ... @@ -129,7 +129,7 @@ class CheckedIterator m_eEndState = E_END ; } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short set internal states to E_AFTEREND @descr Sometimes we need a "walking" check-iterator which is initialized with AFTEREND-state! We need it if we don't have a container but must prevent us against further searching! @@ -148,7 +148,7 @@ class CheckedIterator m_eEndState = E_AFTEREND ; } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short reset this iterator @descr It must be called on an already initialized iterator. Means the member m_pContainer must be valid. Otherwise the reaction @@ -166,7 +166,7 @@ class CheckedIterator m_pContainer = NULL; } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short step to next element in container. @descr If end of container is reached we change our internal "m_eEndState". If end reached for first time; we set it to E_END; @@ -207,7 +207,7 @@ class CheckedIterator return *this; } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return true if internal iterator was not initialized before @descr These will be true, if use start a new search by using these iterator mechanism! @@ -224,7 +224,7 @@ class CheckedIterator return( m_eEndState == E_UNKNOWN ); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return true if internal iterator reached end of container @descr These will be true if you step to the end of internal container. @@ -245,7 +245,7 @@ class CheckedIterator ); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return true if you call operator++ again and end already reached @descr These indicate, that end already reached but you call operator++ again and again! @@ -263,7 +263,7 @@ class CheckedIterator return( m_eEndState == E_AFTEREND ); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short support readonly access to container entry @descr Use it to get the value of current container item. @@ -285,9 +285,9 @@ class CheckedIterator return m_pPosition; } - //------------------------------------------------------------------------------------------------------------- + // private member - //------------------------------------------------------------------------------------------------------------- + private: diff --git a/framework/inc/classes/filtercache.hxx b/framework/inc/classes/filtercache.hxx index 52a3dcd7b365..797ba1410dc3 100644 --- a/framework/inc/classes/filtercache.hxx +++ b/framework/inc/classes/filtercache.hxx @@ -50,7 +50,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short cache for all filter and type information @descr Frameloader - and filterfactory need some information about our current registered filters and types. For better performance its necessary to cache all needed values. @@ -68,20 +68,20 @@ class FilterCache : private ThreadHelpBase { public: - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - //--------------------------------------------------------------------------------------------------------- + // constructor / destructor - //--------------------------------------------------------------------------------------------------------- + FilterCache( sal_Int32 nVersion = DEFAULT_FILTERCACHE_VERSION, sal_Int16 nMode = DEFAULT_FILTERCACHE_MODE ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard destructor to delete instance @descr This will clear the cache if last owner release it. @@ -97,7 +97,7 @@ class FilterCache : private ThreadHelpBase void flush( DataContainer::ECFGType eType ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short get the current state of the cache @descr Call this methods to get information about the state of the current cache. @@ -117,7 +117,7 @@ class FilterCache : private ThreadHelpBase sal_Bool hasLoaders () const; sal_Bool hasContentHandlers () const; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short search routines to find items which match given parameter @descr Mostly we search for a type first and get all information about filter, detector and loader services from the other configuration tables which are registered for this type. @@ -164,7 +164,7 @@ class FilterCache : private ThreadHelpBase CheckedStringListIterator& aStartEntry , OUString& sResult ) const; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short get all properties of a cache entry by given name @descr If you need additional information about our internal cache values you can use these methods to get a list of all cached config values @@ -205,7 +205,7 @@ class FilterCache : private ThreadHelpBase sal_Bool existsLoader ( const OUString& sName ) const; sal_Bool existsContentHandler ( const OUString& sName ) const; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short support special query modes @descr Our owner services need sometimes a special mode to query for subsets of our configuration! They give us a special query string - we return right values. @@ -223,7 +223,7 @@ class FilterCache : private ThreadHelpBase css::uno::Any queryFilters( const OUString& sQuery ) const; - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short support registration of elements in current configuration @descr Use this methods to add or remove items in our configuration files. We use the globale configuration to do that ... in fat office "share/config/registry/..."! @@ -313,9 +313,9 @@ class FilterCache : private ThreadHelpBase sal_Bool validateAndRepairLoader(); sal_Bool validateAndRepairHandler(); - //------------------------------------------------------------------------------------------------------------- + // private variables - //------------------------------------------------------------------------------------------------------------- + private: static sal_Int32 m_nRefCount ; diff --git a/framework/inc/classes/filtercachedata.hxx b/framework/inc/classes/filtercachedata.hxx index 82336b441f98..dc566f73d6bd 100644 --- a/framework/inc/classes/filtercachedata.hxx +++ b/framework/inc/classes/filtercachedata.hxx @@ -66,16 +66,16 @@ enum EFilterPackage E_ADDITIONAL }; -//***************************************************************************************************************** + // These struct define a type, which present the type of a file. // He is used for easy filter detection without file stream detection! // The internal name is the keyname of an item with these structure in our hash map or our configuration set! -//***************************************************************************************************************** + struct FileType { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: inline FileType ( ) { impl_clear(); } @@ -84,9 +84,9 @@ struct FileType inline FileType& operator= ( const FileType& rCopy ) { return impl_copy( rCopy ); } inline void free ( ) { impl_clear(); } - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: inline void impl_clear() @@ -114,9 +114,9 @@ struct FileType return (*this); } - //------------------------------------------------------------------------------------------------------------- + // public member - //------------------------------------------------------------------------------------------------------------- + public: sal_Bool bPreferred ; @@ -129,17 +129,17 @@ struct FileType OUStringList lExtensions ; }; -//***************************************************************************************************************** + // These struct describe a filter which is registered for one type. // He hold information about services which present the document himself (like a item) and a filter service which // filter a file in these document. // The internal name is the keyname of an item with these structure in our hash map or our configuration set! -//***************************************************************************************************************** + struct Filter { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: inline Filter ( ) { impl_clear(); } @@ -148,9 +148,9 @@ struct Filter inline Filter& operator= ( const Filter& rCopy ) { return impl_copy( rCopy ); } inline void free ( ) { impl_clear(); } - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: inline void impl_clear() @@ -184,9 +184,9 @@ struct Filter return (*this); } - //------------------------------------------------------------------------------------------------------------- + // public member - //------------------------------------------------------------------------------------------------------------- + public: sal_Int32 nOrder ; @@ -202,16 +202,16 @@ struct Filter OUString sTemplateName ; }; -//***************************************************************************************************************** + // Programmer can register his own services for an content detection of different types. // The implementation or service name of these is the keyname of an item with these structure // in our hash map or our configuration set! -//***************************************************************************************************************** + struct Detector { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: inline Detector ( ) { impl_clear(); } @@ -220,9 +220,9 @@ struct Detector inline Detector& operator= ( const Detector& rCopy ) { return impl_copy( rCopy ); } inline void free ( ) { impl_clear(); } - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: inline void impl_clear() @@ -238,25 +238,25 @@ struct Detector return (*this); } - //------------------------------------------------------------------------------------------------------------- + // public member - //------------------------------------------------------------------------------------------------------------- + public: OUString sName ; OUStringList lTypes ; }; -//***************************************************************************************************************** + // Programmer can register his own services for loading documents in a frame. // The implementation or service name of these is the keyname of an item with these structure // in our hash map or our configuration set! -//***************************************************************************************************************** + struct Loader { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: inline Loader ( ) { impl_clear(); } @@ -265,9 +265,9 @@ struct Loader inline Loader& operator= ( const Loader& rCopy ) { return impl_copy( rCopy ); } inline void free ( ) { impl_clear(); } - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: inline void impl_clear() @@ -285,9 +285,9 @@ struct Loader return (*this); } - //------------------------------------------------------------------------------------------------------------- + // public member - //------------------------------------------------------------------------------------------------------------- + public: OUString sName ; @@ -295,15 +295,15 @@ struct Loader OUStringList lTypes ; }; -//***************************************************************************************************************** + // Programmer can register his own services to handle a FileType and intercept dispatches. // Don't forget: It's not a FrameLoader - it's a ContentHandler! (normaly without any UI) -//***************************************************************************************************************** + struct ContentHandler { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: inline ContentHandler( ) { impl_clear(); } @@ -312,9 +312,9 @@ struct ContentHandler inline ContentHandler& operator= ( const ContentHandler& rCopy ) { return impl_copy( rCopy ); } inline void free ( ) { impl_clear(); } - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: inline void impl_clear() @@ -330,33 +330,33 @@ struct ContentHandler return (*this); } - //------------------------------------------------------------------------------------------------------------- + // public member - //------------------------------------------------------------------------------------------------------------- + public: OUString sName ; OUStringList lTypes ; }; -//***************************************************************************************************************** + // We need different hash maps for different tables of our configuration management. // Follow maps convert <names> to <properties> of type, filter, detector, loader ... // and could be used in a generic way -//***************************************************************************************************************** + template< class HashType > class SetNodeHash : public ::boost::unordered_map< OUString , HashType , OUStringHash , ::std::equal_to< OUString > > { - //------------------------------------------------------------------------------------------------------------- + // interface - //------------------------------------------------------------------------------------------------------------- + public: - //--------------------------------------------------------------------------------------------------------- + // The only way to free ALL memory really! - //--------------------------------------------------------------------------------------------------------- + inline void free() { SetNodeHash().swap( *this ); @@ -365,48 +365,48 @@ class SetNodeHash : public ::boost::unordered_map< OUString , lRemovedItems.free(); } - //--------------------------------------------------------------------------------------------------------- + // Append changed, added or removed items to special lists // Necessary for saving changes - //--------------------------------------------------------------------------------------------------------- + void appendChange( const OUString& sName , EModifyState eState ); - //------------------------------------------------------------------------------------------------------------- + // member - //------------------------------------------------------------------------------------------------------------- + public: OUStringList lAddedItems ; OUStringList lChangedItems ; OUStringList lRemovedItems ; }; -//***************************************************************************************************************** + // Use these hashes to implement different tables which assign types to frame loader or detect services. // It's an optimism to find registered services faster! // The preferred hash maps file extensions to preferred types to find these ones faster. -//***************************************************************************************************************** + class PerformanceHash : public ::boost::unordered_map< OUString , OUStringList , OUStringHash , ::std::equal_to< OUString > > { public: - //--------------------------------------------------------------------------------------------------------- + // try to free all used memory REALY! - //--------------------------------------------------------------------------------------------------------- + inline void free() { PerformanceHash().swap( *this ); } - //--------------------------------------------------------------------------------------------------------- + // normaly a complete string must match our hash key values ... // But sometimes we need a search by using these key values as pattern! // The in/out parameter "pStepper" is used to return a pointer to found element in hash ... // and could be used for further searches again, which should be started at next element! // We stop search at the end of hash. You can start it again by setting it to the begin by himself. - //--------------------------------------------------------------------------------------------------------- + inline sal_Bool findPatternKey( const OUString& sSearchValue , const_iterator& pStepper ) { @@ -435,9 +435,9 @@ class PerformanceHash : public ::boost::unordered_map< OUString } }; -//***************************************************************************************************************** + // Define easy usable types -//***************************************************************************************************************** + typedef SetNodeHash< FileType > FileTypeHash ; typedef SetNodeHash< Filter > FilterHash ; typedef SetNodeHash< Detector > DetectorHash ; @@ -452,9 +452,9 @@ typedef CheckedIterator< PerformanceHash > CheckedPerfo typedef ::std::vector< FilterHash::const_iterator > FilterQuery ; -//***************************************************************************************************************** + // Use private static data container to hold all values of configuration! -//***************************************************************************************************************** + class DataContainer : private ThreadHelpBase { public: @@ -586,7 +586,7 @@ class DataContainer : private ThreadHelpBase sal_Bool m_bHandlersModified ; }; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short capsulate configuration access for fiter configuration @descr We use the ConfigItem mechanism to read/write values from/to configuration. This implementation could be used to handle standard AND additional filter configurations in the same way. @@ -602,9 +602,9 @@ class DataContainer : private ThreadHelpBase *//*-*************************************************************************************************************/ class FilterCFGAccess : public ::utl::ConfigItem { - //------------------------------------------------------------------------------------------------------------- + // interface - //------------------------------------------------------------------------------------------------------------- + public: FilterCFGAccess ( const OUString& sPath , sal_Int32 nVersion = DEFAULT_FILTERCACHE_VERSION , @@ -628,9 +628,9 @@ class FilterCFGAccess : public ::utl::ConfigItem void setProductName ( OUStringHashMap& lUINames ); void resetProductName ( OUStringHashMap& lUINames ); - //------------------------------------------------------------------------------------------------------------- + // internal helper - //------------------------------------------------------------------------------------------------------------- + private: void impl_initKeyCounts ( ); // set right key counts, which are used at reading/writing of set node properties void impl_removeNodes ( OUStringList& rChangesList , // helper to remove list of set nodes @@ -650,9 +650,9 @@ class FilterCFGAccess : public ::utl::ConfigItem void impl_saveLoaders ( DataContainer& rData ); void impl_saveContentHandlers ( DataContainer& rData ); - //------------------------------------------------------------------------------------------------------------- + // debug checks - //------------------------------------------------------------------------------------------------------------- + private: static sal_Bool implcp_ctor ( const OUString& sPath , // methods to check incoming parameter on our interface methods! sal_Int32 nVersion , @@ -660,9 +660,9 @@ class FilterCFGAccess : public ::utl::ConfigItem static sal_Bool implcp_read ( const DataContainer& rData ); static sal_Bool implcp_write( const DataContainer& rData ); - //------------------------------------------------------------------------------------------------------------- + // member - //------------------------------------------------------------------------------------------------------------- + private: EFilterPackage m_ePackage ; // ... not really used yet! should split configuration in STANDARD and ADDITIONAL filter sal_Int32 m_nVersion ; // file format version of configuration! (necessary for "xml2xcd" transformation!) diff --git a/framework/inc/classes/framecontainer.hxx b/framework/inc/classes/framecontainer.hxx index a53a007a9185..0866a5e986f6 100644 --- a/framework/inc/classes/framecontainer.hxx +++ b/framework/inc/classes/framecontainer.hxx @@ -46,7 +46,7 @@ typedef ::std::vector< css::uno::Reference< css::frame::XFrame > > TFrameContai typedef TFrameContainer::iterator TFrameIterator ; typedef TFrameContainer::const_iterator TConstFrameIterator ; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement a container to hold children of frame, task or desktop @descr Every object of frame, task or desktop hold reference to his children. These container is used as helper to do this. Some helper-classe like OFrames or OTasksAccess use it to. They hold a pointer to an instance @@ -62,7 +62,7 @@ typedef TFrameContainer::const_iterator TConstFrameI *//*-*************************************************************************************************************/ class FrameContainer : private ThreadHelpBase { - //_______________________________________ + // member private: @@ -72,7 +72,7 @@ class FrameContainer : private ThreadHelpBase /// one container item can be the current active frame. Its necessary for Desktop or Frame implementation. css::uno::Reference< css::frame::XFrame > m_xActiveFrame; - //_______________________________________ + // interface public: diff --git a/framework/inc/classes/propertysethelper.hxx b/framework/inc/classes/propertysethelper.hxx index a99e8a140b1f..a297628b67be 100644 --- a/framework/inc/classes/propertysethelper.hxx +++ b/framework/inc/classes/propertysethelper.hxx @@ -36,7 +36,7 @@ namespace framework{ -//_________________________________________________________________________________________________________________ + /** supports the API XPropertySet and XPropertySetInfo. * @@ -50,13 +50,13 @@ namespace framework{ class FWI_DLLPUBLIC PropertySetHelper : public css::beans::XPropertySet , public css::beans::XPropertySetInfo { - //------------------------------------------------------------------------- + /* types */ protected: typedef BaseHash< css::beans::Property > TPropInfoHash; - //------------------------------------------------------------------------- + /* member */ protected: @@ -73,11 +73,11 @@ class FWI_DLLPUBLIC PropertySetHelper : public css::beans::XPropertySet LockHelper& m_rLock; TransactionManager& m_rTransactionManager; - //------------------------------------------------------------------------- + /* native interface */ public: - //--------------------------------------------------------------------- + /** initialize new instance of this helper. * * @param pExternalLock @@ -97,12 +97,12 @@ class FWI_DLLPUBLIC PropertySetHelper : public css::beans::XPropertySet TransactionManager* pExternalTransactionManager , sal_Bool bReleaseLockOnCall ); - //--------------------------------------------------------------------- + /** free all needed memory. */ virtual ~PropertySetHelper(); - //--------------------------------------------------------------------- + /** set a new owner for this helper. * * This owner is used as source for all broadcasted events. @@ -110,7 +110,7 @@ class FWI_DLLPUBLIC PropertySetHelper : public css::beans::XPropertySet */ void impl_setPropertyChangeBroadcaster(const css::uno::Reference< css::uno::XInterface >& xBroadcaster); - //--------------------------------------------------------------------- + /** add a new property info to the set of supported ones. * * @param aProperty @@ -128,7 +128,7 @@ class FWI_DLLPUBLIC PropertySetHelper : public css::beans::XPropertySet throw(css::beans::PropertyExistException, css::uno::Exception ); - //--------------------------------------------------------------------- + /** remove an existing property info from the set of supported ones. * * @param sProperty @@ -141,7 +141,7 @@ class FWI_DLLPUBLIC PropertySetHelper : public css::beans::XPropertySet throw(css::beans::UnknownPropertyException, css::uno::Exception ); - //--------------------------------------------------------------------- + /** mark the object as "useable for working" or "dead". * * This correspond to the lifetime handling implemented by the base class TransactionBase. @@ -151,7 +151,7 @@ class FWI_DLLPUBLIC PropertySetHelper : public css::beans::XPropertySet virtual void SAL_CALL impl_enablePropertySet(); virtual void SAL_CALL impl_disablePropertySet(); - //--------------------------------------------------------------------- + /** */ virtual void SAL_CALL impl_setPropertyValue(const OUString& sProperty, @@ -161,7 +161,7 @@ class FWI_DLLPUBLIC PropertySetHelper : public css::beans::XPropertySet virtual css::uno::Any SAL_CALL impl_getPropertyValue(const OUString& sProperty, sal_Int32 nHandle ) = 0; - //------------------------------------------------------------------------- + /* uno interface */ public: @@ -217,7 +217,7 @@ class FWI_DLLPUBLIC PropertySetHelper : public css::beans::XPropertySet virtual sal_Bool SAL_CALL hasPropertyByName(const OUString& sName) throw(css::uno::RuntimeException, std::exception); - //------------------------------------------------------------------------- + /* internal helper */ private: diff --git a/framework/inc/classes/protocolhandlercache.hxx b/framework/inc/classes/protocolhandlercache.hxx index c824832ae12f..ef27b690c57c 100644 --- a/framework/inc/classes/protocolhandlercache.hxx +++ b/framework/inc/classes/protocolhandlercache.hxx @@ -38,7 +38,7 @@ namespace framework{ #define SETNAME_HANDLER DECLARE_ASCII("HandlerSet" ) /// name of configuration set inside package #define PROPERTY_PROTOCOLS DECLARE_ASCII("Protocols" ) /// properties of a protocol handler -//_________________________________________________________________________________________________________________ + /** Programmer can register his own services to handle different protocols. @@ -58,7 +58,7 @@ struct FWI_DLLPUBLIC ProtocolHandler OUStringList m_lProtocols; }; -//_________________________________________________________________________________________________________________ + /** This hash use registered pattern of all protocol handlers as keys and provide her @@ -73,14 +73,14 @@ class FWI_DLLPUBLIC PatternHash : public BaseHash< OUString > PatternHash::iterator findPatternKey( const OUString& sURL ); }; -//_________________________________________________________________________________________________________________ + /** This hash holds protocol handler structs by her names. */ typedef BaseHash< ProtocolHandler > HandlerHash; -//_________________________________________________________________________________________________________________ + /** @short this hash makes it easy to find a protocol handler by using his uno implementation name. @@ -128,7 +128,7 @@ class FWI_DLLPUBLIC HandlerCache void takeOver(HandlerHash* pHandler, PatternHash* pPattern); }; -//_________________________________________________________________________________________________________________ + /** @short implements configuration access for handler configuration diff --git a/framework/inc/classes/taskcreator.hxx b/framework/inc/classes/taskcreator.hxx index cf0b5d70f2e1..aaef28cb5fd9 100644 --- a/framework/inc/classes/taskcreator.hxx +++ b/framework/inc/classes/taskcreator.hxx @@ -32,7 +32,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short a helper to create new tasks or sub frames for "_blank" or FrameSearchFlag::CREATE @descr There are different places to create new (task)frames. Its not easy to service this code! Thats the reason for this helper. He capsulate asynchronous/synchronous creation by calling @@ -43,13 +43,13 @@ namespace framework{ *//*-*************************************************************************************************************/ class TaskCreator : private ThreadHelpBase { - //_______________________ + // member private: css::uno::Reference< css::uno::XComponentContext > m_xContext; - //_______________________ + // interface public: @@ -59,7 +59,7 @@ class TaskCreator : private ThreadHelpBase css::uno::Reference< css::frame::XFrame > createTask( const OUString& sName , sal_Bool bVisible ); - //_______________________ + // helper private: diff --git a/framework/inc/classes/wildcard.hxx b/framework/inc/classes/wildcard.hxx index 088dd18eb043..ee6217f11271 100644 --- a/framework/inc/classes/wildcard.hxx +++ b/framework/inc/classes/wildcard.hxx @@ -24,7 +24,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement wildcard-mechanism for unicode @descr This class can be used to get information about the matching of a pattern to a given text. It's suitable for 8-Bit- AND 16-Bit-strings! @@ -39,17 +39,17 @@ namespace framework{ class Wildcard { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - //--------------------------------------------------------------------------------------------------------- + // constructor / destructor - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short standard ctor @descr We do nothing here. @@ -63,7 +63,7 @@ class Wildcard Wildcard(); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard dtor @descr We do nothing here. @@ -77,11 +77,11 @@ class Wildcard virtual ~Wildcard(); - //--------------------------------------------------------------------------------------------------------- + // interface - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short try to find an agreement between given text and searchpattern @descr You can use wildcards in pattern only! diff --git a/framework/inc/dispatch/closedispatcher.hxx b/framework/inc/dispatch/closedispatcher.hxx index 05f694ea51e8..f5cdb15c0e28 100644 --- a/framework/inc/dispatch/closedispatcher.hxx +++ b/framework/inc/dispatch/closedispatcher.hxx @@ -45,7 +45,7 @@ class SystemWindow; namespace framework{ -//----------------------------------------------- + /** @short helper to dispatch the URLs ".uno:CloseDoc"/".uno:CloseWin"/".uno:CloseFrame" to close a frame/document or the whole application implicitly in case it was the last frame @@ -62,12 +62,12 @@ class CloseDispatcher : // baseclasses ... order is necessary for right initiali css::frame::XNotifyingDispatch, // => XDispatch css::frame::XDispatchInformationProvider > { - //------------------------------------------- + // types private: - //--------------------------------------- + /** @short describe, which request must be done here. @descr The incoming URLs {.uno:CloseDoc/CloseWin and CloseFrame can be classified so and checked later performant.}*/ @@ -78,53 +78,53 @@ class CloseDispatcher : // baseclasses ... order is necessary for right initiali E_CLOSE_WIN }; - //------------------------------------------- + // member private: - //--------------------------------------- + /** @short reference to an uno service manager, which can be used to create own needed uno resources. */ css::uno::Reference< css::uno::XComponentContext > m_xContext; - //--------------------------------------- + /** @short reference to the target frame, which should be closed by this dispatch. */ css::uno::WeakReference< css::frame::XFrame > m_xCloseFrame; - //--------------------------------------- + /** @short used for asynchronous callbacks within the main thread. @descr Internally we work asynchronous. Because our callis are not aware, that her request can kill its own environment ... */ ::vcl::EventPoster m_aAsyncCallback; - //--------------------------------------- + /** @short used inside asyncronous callback to decide, which operation must be executed. */ EOperation m_eOperation; - //--------------------------------------- + /** @short for asynchronous operations we must hold us self alive! */ css::uno::Reference< css::uno::XInterface > m_xSelfHold; - //--------------------------------------- + /** @short list of registered status listener */ ListenerHash m_lStatusListener; - //--------------------------------------- + /** @short holded alive for internally asynchronous operations! */ css::uno::Reference< css::frame::XDispatchResultListener > m_xResultListener; SystemWindow* m_pSysWindow; - //------------------------------------------- + // native interface public: - //--------------------------------------- + /** @short connect a new CloseDispatcher instance to its frame. @descr One CloseDispatcher instance is bound to onw frame only. That makes an implementation (e.g. of listener support) @@ -144,22 +144,22 @@ class CloseDispatcher : // baseclasses ... order is necessary for right initiali const css::uno::Reference< css::frame::XFrame >& xFrame , const OUString& sTarget); - //--------------------------------------- + /** @short does nothing real. */ virtual ~CloseDispatcher(); - //------------------------------------------- + // uno interface public: - //--------------------------------------- + // XNotifyingDispatch virtual void SAL_CALL dispatchWithNotification( const css::util::URL& aURL , const css::uno::Sequence< css::beans::PropertyValue >& lArguments, const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) throw(css::uno::RuntimeException, std::exception); - //--------------------------------------- + // XDispatch virtual void SAL_CALL dispatch ( const css::util::URL& aURL , const css::uno::Sequence< css::beans::PropertyValue >& lArguments) throw(css::uno::RuntimeException, std::exception); @@ -168,17 +168,17 @@ class CloseDispatcher : // baseclasses ... order is necessary for right initiali virtual void SAL_CALL removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xListener , const css::util::URL& aURL ) throw(css::uno::RuntimeException, std::exception); - //--------------------------------------- + // XDispatchInformationProvider virtual css::uno::Sequence< sal_Int16 > SAL_CALL getSupportedCommandGroups ( ) throw (css::uno::RuntimeException, std::exception); virtual css::uno::Sequence< css::frame::DispatchInformation > SAL_CALL getConfigurableDispatchInformation( sal_Int16 nCommandGroup ) throw (css::uno::RuntimeException, std::exception); - //------------------------------------------- + // internal helper private: - //--------------------------------------- + /** @short a callback for asynchronous started operations. @descr As already mentione, we make internally all operations @@ -187,7 +187,7 @@ class CloseDispatcher : // baseclasses ... order is necessary for right initiali */ DECL_LINK( impl_asyncCallback, void* ); - //--------------------------------------- + /** @short prepare m_xCloseFrame so it should be closeable without problems. @descr Thats needed to be shure, that the document cant disagree @@ -213,7 +213,7 @@ class CloseDispatcher : // baseclasses ... order is necessary for right initiali sal_Bool bCloseAllOtherViewsToo, sal_Bool& bControllerSuspended ); - //--------------------------------------- + /** @short close the member m_xCloseFrame. @descr This method does not look for any document @@ -230,7 +230,7 @@ class CloseDispatcher : // baseclasses ... order is necessary for right initiali */ sal_Bool implts_closeFrame(); - //--------------------------------------- + /** @short set the special BackingComponent (now StartModule) as new component of our m_xCloseFrame. @@ -239,7 +239,7 @@ class CloseDispatcher : // baseclasses ... order is necessary for right initiali */ sal_Bool implts_establishBackingMode(); - //--------------------------------------- + /** @short calls XDesktop->terminate(). @descr No office code has to be called @@ -253,7 +253,7 @@ class CloseDispatcher : // baseclasses ... order is necessary for right initiali */ sal_Bool implts_terminateApplication(); - //--------------------------------------- + /** @short notify a DispatchResultListener. @descr We check the listener reference before we use it. @@ -273,7 +273,7 @@ class CloseDispatcher : // baseclasses ... order is necessary for right initiali sal_Int16 nState , const css::uno::Any& aResult ); - //--------------------------------------- + /** @short try to find the right target frame where this close request must be really done. diff --git a/framework/inc/dispatch/dispatchinformationprovider.hxx b/framework/inc/dispatch/dispatchinformationprovider.hxx index 36fe400dcc39..1f5fcb23c9f4 100644 --- a/framework/inc/dispatch/dispatchinformationprovider.hxx +++ b/framework/inc/dispatch/dispatchinformationprovider.hxx @@ -36,20 +36,20 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short a helper to merge dispatch information of different sources together. *//*-*************************************************************************************************************/ class DispatchInformationProvider : private ThreadHelpBase , public ::cppu::WeakImplHelper1< css::frame::XDispatchInformationProvider > { - //_______________________ + // member private: css::uno::Reference< css::uno::XComponentContext > m_xContext; css::uno::WeakReference< css::frame::XFrame > m_xFrame; - //_______________________ + // interface public: @@ -64,7 +64,7 @@ class DispatchInformationProvider : private ThreadHelpBase virtual css::uno::Sequence< css::frame::DispatchInformation > SAL_CALL getConfigurableDispatchInformation(sal_Int16 nCommandGroup) throw (css::uno::RuntimeException, std::exception); - //_______________________ + // helper private: diff --git a/framework/inc/dispatch/interceptionhelper.hxx b/framework/inc/dispatch/interceptionhelper.hxx index 55c630ce3f89..2f2162e5a92a 100644 --- a/framework/inc/dispatch/interceptionhelper.hxx +++ b/framework/inc/dispatch/interceptionhelper.hxx @@ -55,7 +55,7 @@ class InterceptionHelper : // order of base classes is important for right initi css::frame::XDispatchProviderInterception, css::lang::XEventListener > { - //_____________________________________________________ + // structs, helper /** @short bind an interceptor component to it's URL pattern registration. */ @@ -73,7 +73,7 @@ class InterceptionHelper : // order of base classes is important for right initi css::uno::Sequence< OUString > lURLPattern; }; - //_____________________________________________________ + /** @short implements a list of items of type InterceptorInfo, and provides some special functions on it. @@ -85,7 +85,7 @@ class InterceptionHelper : // order of base classes is important for right initi { public: - //_____________________________________________ + /** @short search for an interceptor inside this list using it's reference. @@ -107,7 +107,7 @@ class InterceptionHelper : // order of base classes is important for right initi return end(); } - //_____________________________________________ + /** @short search for an interceptor inside this list using it's reference. @@ -136,7 +136,7 @@ class InterceptionHelper : // order of base classes is important for right initi } }; - //_____________________________________________________ + // member private: @@ -157,12 +157,12 @@ class InterceptionHelper : // order of base classes is important for right initi The last or the first registered one. */ static sal_Bool m_bPreferrFirstInterceptor; - //_____________________________________________________ + // native interface public: - //_________________________________________________ + /** @short creates a new interception helper instance. @@ -177,7 +177,7 @@ class InterceptionHelper : // order of base classes is important for right initi protected: - //_________________________________________________ + /** @short standard destructor. @@ -187,12 +187,12 @@ class InterceptionHelper : // order of base classes is important for right initi */ virtual ~InterceptionHelper(); - //_____________________________________________________ + // uno interface public: - //_________________________________________________ + // XDispatchProvider /** @short query for a dispatch, which implements the requested feature. @@ -220,7 +220,7 @@ class InterceptionHelper : // order of base classes is important for right initi sal_Int32 nSearchFlags ) throw(css::uno::RuntimeException, std::exception); - //_________________________________________________ + // XDispatchProvider /** @short implements an optimized queryDispatch() for remote. @@ -237,7 +237,7 @@ class InterceptionHelper : // order of base classes is important for right initi virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches(const css::uno::Sequence< css::frame::DispatchDescriptor >& lDescriptor) throw(css::uno::RuntimeException, std::exception); - //_________________________________________________ + // XDispatchProviderInterception /** @short register an interceptor. @@ -256,7 +256,7 @@ class InterceptionHelper : // order of base classes is important for right initi virtual void SAL_CALL registerDispatchProviderInterceptor(const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor) throw(css::uno::RuntimeException, std::exception); - //_________________________________________________ + // XDispatchProviderInterception /** @short release an interceptor. @@ -271,7 +271,7 @@ class InterceptionHelper : // order of base classes is important for right initi */ virtual void SAL_CALL releaseDispatchProviderInterceptor( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor ) throw( css::uno::RuntimeException, std::exception ); - //_________________________________________________ + // XEventListener /** @short Is called from our owner frame, in case he will be disposed. diff --git a/framework/inc/dispatch/menudispatcher.hxx b/framework/inc/dispatch/menudispatcher.hxx index 2a9201525024..9cb73ae48aef 100644 --- a/framework/inc/dispatch/menudispatcher.hxx +++ b/framework/inc/dispatch/menudispatcher.hxx @@ -48,7 +48,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ We must save information about our listener and URL for listening. We implement this as a hashtable for strings. *//*-*************************************************************************************************************/ @@ -57,7 +57,7 @@ typedef ::cppu::OMultiTypeInterfaceContainerHelperVar< OUString , OUStringHash > IMPL_ListenerHashContainer; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short helper for desktop only(!) to create new tasks on demand for dispatches @descr Use this class as member only! Never use it as baseclass. XInterface will be ambigous and we hold a weakcss::uno::Reference to ouer OWNER - not to ouer SUPERCLASS! @@ -80,17 +80,17 @@ class MenuDispatcher : // baseclasses css::frame::XDispatch , css::frame::XFrameActionListener > { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - //--------------------------------------------------------------------------------------------------------- + // constructor / destructor - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short standard ctor @descr These initialize a new instance of ths class with needed information for work. @@ -106,11 +106,11 @@ class MenuDispatcher : // baseclasses MenuDispatcher( const css::uno::Reference< css::uno::XComponentContext >& rxContext , const css::uno::Reference< css::frame::XFrame >& xOwner ); - //--------------------------------------------------------------------------------------------------------- + // XDispatch - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short dispatch URL with arguments @descr Every dispatch create a new task. If load of URL failed task will deleted automaticly! @@ -126,7 +126,7 @@ class MenuDispatcher : // baseclasses virtual void SAL_CALL dispatch( const css::util::URL& aURL , const css::uno::Sequence< css::beans::PropertyValue >& seqProperties ) throw( css::uno::RuntimeException, std::exception ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short add listener for state events @descr You can add a listener to get information about status of dispatch: OK or Failed. @@ -143,7 +143,7 @@ class MenuDispatcher : // baseclasses virtual void SAL_CALL addStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xControl, const css::util::URL& aURL ) throw( css::uno::RuntimeException, std::exception ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short remove listener for state events @descr You can remove a listener if information of dispatch isn't important for you any longer. @@ -161,17 +161,17 @@ class MenuDispatcher : // baseclasses const css::util::URL& aURL ) throw( css::uno::RuntimeException, std::exception ); - //--------------------------------------------------------------------------------------------------------- + // XFrameActionListener - //--------------------------------------------------------------------------------------------------------- + virtual void SAL_CALL frameAction( const css::frame::FrameActionEvent& aEvent ) throw ( css::uno::RuntimeException, std::exception ); - //--------------------------------------------------------------------------------------------------------- + // XEventListener - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short dispose current instance @descr If service helper isn't required any longer call this method to release all used resources. @@ -185,13 +185,13 @@ class MenuDispatcher : // baseclasses void SAL_CALL disposing( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException, std::exception ); - //------------------------------------------------------------------------------------------------------------- + // protected methods - //------------------------------------------------------------------------------------------------------------- + protected: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard destructor @descr This method destruct an instance of this class and clear some member. This method is protected, because its not allowed to use an instance of this class as a member! @@ -207,13 +207,13 @@ class MenuDispatcher : // baseclasses virtual ~MenuDispatcher(); - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short - @descr - @@ -227,7 +227,7 @@ class MenuDispatcher : // baseclasses sal_Bool impl_setMenuBar( MenuBar* pMenuBar, sal_Bool bMenuFromResource = sal_False ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short - @descr - @@ -241,10 +241,10 @@ class MenuDispatcher : // baseclasses void impl_setAccelerators( Menu* pMenu, const Accelerator& aAccel ); - //------------------------------------------------------------------------------------------------------------- + // variables // (should be private everyway!) - //------------------------------------------------------------------------------------------------------------- + private: diff --git a/framework/inc/dispatch/oxt_handler.hxx b/framework/inc/dispatch/oxt_handler.hxx index 2ec6b630dc1b..706901fc2c92 100644 --- a/framework/inc/dispatch/oxt_handler.hxx +++ b/framework/inc/dispatch/oxt_handler.hxx @@ -43,7 +43,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short handler to detect and play sounds ("wav" and "au" only!) @descr Register this implementation as a content handler to detect and/or play wav- and au-sounds. It doesn't depend from the target platform. But one instance of this class @@ -63,32 +63,32 @@ class Oxt_Handler : // baseclasses css::frame::XNotifyingDispatch, // => XDispatch css::document::XExtendedFilterDetection > { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - //--------------------------------------------------------------------------------------------------------- + // constructor / destructor - //--------------------------------------------------------------------------------------------------------- + Oxt_Handler( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory ); virtual ~Oxt_Handler( ); - //--------------------------------------------------------------------------------------------------------- + // XInterface, XTypeProvider, XServiceInfo - //--------------------------------------------------------------------------------------------------------- + DECLARE_XSERVICEINFO - //--------------------------------------------------------------------------------------------------------- + // XNotifyingDispatch - //--------------------------------------------------------------------------------------------------------- + virtual void SAL_CALL dispatchWithNotification(const css::util::URL& aURL , const css::uno::Sequence< css::beans::PropertyValue >& lArguments, const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) throw( css::uno::RuntimeException, std::exception ); - //--------------------------------------------------------------------------------------------------------- + // XDispatch - //--------------------------------------------------------------------------------------------------------- + virtual void SAL_CALL dispatch ( const css::util::URL& aURL , const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) throw( css::uno::RuntimeException, std::exception ); // not supported ! @@ -97,25 +97,23 @@ class Oxt_Handler : // baseclasses virtual void SAL_CALL removeStatusListener ( const css::uno::Reference< css::frame::XStatusListener >& /*xListener*/ , const css::util::URL& /*aURL*/ ) throw( css::uno::RuntimeException, std::exception ) {}; - //--------------------------------------------------------------------------------------------------------- + // XExtendedFilterDetection - //--------------------------------------------------------------------------------------------------------- virtual OUString SAL_CALL detect ( css::uno::Sequence< css::beans::PropertyValue >& lDescriptor ) throw( css::uno::RuntimeException, std::exception ); - //------------------------------------------------------------------------------------------------------------- // protected methods - //------------------------------------------------------------------------------------------------------------- + protected: - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: - //------------------------------------------------------------------------------------------------------------- + // variables // (should be private everyway!) - //------------------------------------------------------------------------------------------------------------- + private: css::uno::Reference< css::lang::XMultiServiceFactory > m_xFactory ; /// global uno service factory to create new services diff --git a/framework/inc/dispatch/popupmenudispatcher.hxx b/framework/inc/dispatch/popupmenudispatcher.hxx index b35fb4c8c11a..8b58855574e5 100644 --- a/framework/inc/dispatch/popupmenudispatcher.hxx +++ b/framework/inc/dispatch/popupmenudispatcher.hxx @@ -50,7 +50,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ We must save information about our listener and URL for listening. We implement this as a hashtable for strings. *//*-*************************************************************************************************************/ @@ -59,7 +59,7 @@ typedef ::cppu::OMultiTypeInterfaceContainerHelperVar< OUString , OUStringHash > IMPL_ListenerHashContainer; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short helper for desktop only(!) to create new tasks on demand for dispatches @descr Use this class as member only! Never use it as baseclass. XInterface will be ambigous and we hold a weakcss::uno::Reference to ouer OWNER - not to our SUPERCLASS! @@ -85,9 +85,9 @@ class PopupMenuDispatcher : // baseclasses css::frame::XFrameActionListener, css::lang::XInitialization > { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: // constructor / destructor diff --git a/framework/inc/dispatch/startmoduledispatcher.hxx b/framework/inc/dispatch/startmoduledispatcher.hxx index 966ba30e0d15..681593bf5bbc 100644 --- a/framework/inc/dispatch/startmoduledispatcher.hxx +++ b/framework/inc/dispatch/startmoduledispatcher.hxx @@ -44,7 +44,7 @@ namespace framework{ -//----------------------------------------------- + /** @short helper to handle all URLs related to the StartModule */ @@ -54,35 +54,35 @@ class StartModuleDispatcher : // baseclasses ... order is necessary for right in css::frame::XNotifyingDispatch, // => XDispatch css::frame::XDispatchInformationProvider > { - //------------------------------------------- + // member private: - //--------------------------------------- + /** @short reference to an uno service manager, which can be used to create own needed uno resources. */ css::uno::Reference< css::uno::XComponentContext > m_xContext; - //--------------------------------------- + /** @short our "context" frame. */ css::uno::WeakReference< css::frame::XFrame > m_xOwner; - //--------------------------------------- + /** @short the original queryDispatch() target. */ OUString m_sDispatchTarget; - //--------------------------------------- + /** @short list of registered status listener */ ListenerHash m_lStatusListener; - //------------------------------------------- + // native interface public: - //--------------------------------------- + /** @short connect a new StartModuleDispatcher instance to its "owner frame". @descr Such "owner frame" is used as context for all related operations. @@ -101,24 +101,24 @@ class StartModuleDispatcher : // baseclasses ... order is necessary for right in const css::uno::Reference< css::frame::XFrame >& xFrame , const OUString& sTarget); - //--------------------------------------- + /** @short does nothing real. */ virtual ~StartModuleDispatcher(); - //------------------------------------------- + // uno interface public: - //--------------------------------------- - //--------------------------------------- + + // XNotifyingDispatch virtual void SAL_CALL dispatchWithNotification( const css::util::URL& aURL , const css::uno::Sequence< css::beans::PropertyValue >& lArguments, const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) throw(css::uno::RuntimeException, std::exception); - //--------------------------------------- + // XDispatch virtual void SAL_CALL dispatch ( const css::util::URL& aURL , const css::uno::Sequence< css::beans::PropertyValue >& lArguments) throw(css::uno::RuntimeException, std::exception); @@ -127,22 +127,22 @@ class StartModuleDispatcher : // baseclasses ... order is necessary for right in virtual void SAL_CALL removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xListener , const css::util::URL& aURL ) throw(css::uno::RuntimeException, std::exception); - //--------------------------------------- + // XDispatchInformationProvider virtual css::uno::Sequence< sal_Int16 > SAL_CALL getSupportedCommandGroups ( ) throw (css::uno::RuntimeException, std::exception); virtual css::uno::Sequence< css::frame::DispatchInformation > SAL_CALL getConfigurableDispatchInformation( sal_Int16 nCommandGroup ) throw (css::uno::RuntimeException, std::exception); - //------------------------------------------- + // internal helper private: - //--------------------------------------- + /** @short check if StartModule can be shown. */ ::sal_Bool implts_isBackingModePossible(); - //--------------------------------------- + /** @short open the special BackingComponent (now StartModule) @return [bool] @@ -150,7 +150,7 @@ class StartModuleDispatcher : // baseclasses ... order is necessary for right in */ ::sal_Bool implts_establishBackingMode(); - //--------------------------------------- + /** @short notify a DispatchResultListener. @descr We check the listener reference before we use it. diff --git a/framework/inc/dispatchcommands.h b/framework/inc/dispatchcommands.h index 4b43e2897295..3f923191bbcb 100644 --- a/framework/inc/dispatchcommands.h +++ b/framework/inc/dispatchcommands.h @@ -24,7 +24,7 @@ namespace framework{ -//_________________________________________________________________________________________________________________ + #define CMD_UNO_SHOWSTARTMODULE ".uno:ShowStartModule" diff --git a/framework/inc/helper/dockingareadefaultacceptor.hxx b/framework/inc/helper/dockingareadefaultacceptor.hxx index e14c1071cc3a..8c302e67d52c 100644 --- a/framework/inc/helper/dockingareadefaultacceptor.hxx +++ b/framework/inc/helper/dockingareadefaultacceptor.hxx @@ -34,7 +34,7 @@ namespace framework{ -//_________________________________________________________________________________________________________________ + class DockingAreaDefaultAcceptor : private ThreadHelpBase , @@ -42,11 +42,11 @@ class DockingAreaDefaultAcceptor : private ThreadHelpBase { public: - //--------------------------------------------------------------------------------------------------------- + // constructor / destructor - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short constructor to initialize this instance @descr A docking area acceptor But we need a instance to create more then one enumerations to the same tasklist! @@ -64,19 +64,19 @@ class DockingAreaDefaultAcceptor : private ThreadHelpBase DockingAreaDefaultAcceptor( const css::uno::Reference< css::frame::XFrame >& xOwner ); virtual ~DockingAreaDefaultAcceptor(); - //--------------------------------------------------------------------------------------------------------- + // XDockingAreaAcceptor - //--------------------------------------------------------------------------------------------------------- + virtual css::uno::Reference< css::awt::XWindow > SAL_CALL getContainerWindow() throw (css::uno::RuntimeException, std::exception); virtual sal_Bool SAL_CALL requestDockingAreaSpace( const css::awt::Rectangle& RequestedSpace ) throw (css::uno::RuntimeException, std::exception); virtual void SAL_CALL setDockingAreaSpace( const css::awt::Rectangle& BorderSpace ) throw (css::uno::RuntimeException, std::exception); - //------------------------------------------------------------------------------------------------------------- + // variables // (should be private everyway!) - //------------------------------------------------------------------------------------------------------------- + private: diff --git a/framework/inc/helper/mischelper.hxx b/framework/inc/helper/mischelper.hxx index 15c87c3d6b5f..225088c04966 100644 --- a/framework/inc/helper/mischelper.hxx +++ b/framework/inc/helper/mischelper.hxx @@ -148,14 +148,14 @@ FWI_DLLPUBLIC void FillLangItems( std::set< OUString > &rLangItems, //It's common for an object to want to create and own a Broadcaster and set //itself as a Listener on its own Broadcaster member. -// + //However, calling addListener on a Broadcaster means that the Broadcaster adds //a reference to the Listener leading to an ownership cycle where the Listener //owns the Broadcaster which "owns" the Listener. -// + //The WeakContainerListener allows breaking this cycle and retrofitting //afflicted implentations fairly easily. -// + //OriginalListener owns the Broadcaster which "owns" the WeakContainerListener //which forwards the events to the OriginalListener without taking ownership of //it. diff --git a/framework/inc/helper/ocomponentaccess.hxx b/framework/inc/helper/ocomponentaccess.hxx index 306686f37a74..5e4cb9ae58a9 100644 --- a/framework/inc/helper/ocomponentaccess.hxx +++ b/framework/inc/helper/ocomponentaccess.hxx @@ -38,7 +38,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement XEnumerationAccess interface as helper to create many oneway enumeration of components @descr We share mutex and framecontainer with ouer owner and have full access to his child tasks. (Ouer owner can be the Desktop only!) We create oneway enumerations on demand. These "lists" @@ -59,17 +59,17 @@ namespace framework{ class OComponentAccess : private ThreadHelpBase , // Must be the first of baseclasses - Is necessary for right initialization of objects! public ::cppu::WeakImplHelper1< ::com::sun::star::container::XEnumerationAccess > { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - //--------------------------------------------------------------------------------------------------------- + // constructor / destructor - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short constructor to initialize this instance @descr A desktop will create an enumeration-access-object. An enumeration is a oneway-list and a snapshot of the components of current tasks under the desktop. @@ -86,11 +86,11 @@ class OComponentAccess : private ThreadHelpBase , // M OComponentAccess( const css::uno::Reference< css::frame::XDesktop >& xOwner ); - //--------------------------------------------------------------------------------------------------------- + // XEnumerationAccess - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short create a new enumeration of components @descr You can call this method to get a new snapshot from all components of all tasks of the desktop as an enumeration. @@ -107,11 +107,11 @@ class OComponentAccess : private ThreadHelpBase , // M virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL createEnumeration() throw( css::uno::RuntimeException, std::exception ); - //--------------------------------------------------------------------------------------------------------- + // XElementAccess - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short get the type of elements in enumeration @descr - @@ -126,7 +126,7 @@ class OComponentAccess : private ThreadHelpBase , // M virtual css::uno::Type SAL_CALL getElementType() throw( css::uno::RuntimeException, std::exception ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short get state of componentlist of enumeration. @descr - @@ -141,13 +141,13 @@ class OComponentAccess : private ThreadHelpBase , // M virtual sal_Bool SAL_CALL hasElements() throw( css::uno::RuntimeException, std::exception ); - //------------------------------------------------------------------------------------------------------------- + // protected methods - //------------------------------------------------------------------------------------------------------------- + protected: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard destructor @descr This method destruct an instance of this class and clear some member. Don't use an instance of this class as normal member. Use it dynamicly with a pointer. @@ -164,13 +164,13 @@ class OComponentAccess : private ThreadHelpBase , // M virtual ~OComponentAccess(); - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short recursive method (!) to collect all components of all frames from the subtree of given node @descr This is necessary to create the enumeration. @@ -187,7 +187,7 @@ class OComponentAccess : private ThreadHelpBase , // M void impl_collectAllChildComponents( const css::uno::Reference< css::frame::XFramesSupplier >& xNode , css::uno::Sequence< css::uno::Reference< css::lang::XComponent > >& seqComponents ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short get the component of a frame @descr The component of a frame can be the window, the controller or the model. @@ -201,12 +201,12 @@ class OComponentAccess : private ThreadHelpBase , // M css::uno::Reference< css::lang::XComponent > impl_getFrameComponent( const css::uno::Reference< css::frame::XFrame >& xFrame ) const; - //------------------------------------------------------------------------------------------------------------- + // debug methods // (should be private everyway!) - //------------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short debug-method to check incoming parameter of some other mehods of this class @descr The following methods are used to check parameters for other methods of this class. The return value is used directly for an ASSERT(...). @@ -224,10 +224,10 @@ class OComponentAccess : private ThreadHelpBase , // M static sal_Bool impldbg_checkParameter_OComponentAccessCtor( const css::uno::Reference< css::frame::XDesktop >& xOwner ); - //------------------------------------------------------------------------------------------------------------- + // variables // (should be private everyway!) - //------------------------------------------------------------------------------------------------------------- + private: diff --git a/framework/inc/helper/ocomponentenumeration.hxx b/framework/inc/helper/ocomponentenumeration.hxx index e40b60203a06..1b397f050578 100644 --- a/framework/inc/helper/ocomponentenumeration.hxx +++ b/framework/inc/helper/ocomponentenumeration.hxx @@ -34,7 +34,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement a helper for a oneway enumeration of components @descr You can step during this list only for one time! Its a snapshot. Don't forget to release the reference. You are the owner of an instance of this implementation. @@ -55,17 +55,17 @@ namespace framework{ class OComponentEnumeration : public ThreadHelpBase , public ::cppu::WeakImplHelper2< ::com::sun::star::container::XEnumeration,::com::sun::star::lang::XEventListener > { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - //--------------------------------------------------------------------------------------------------------- + // constructor / destructor - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short constructor to initialize this enumeration @descr An enumeration is a list with oneway-access! You can get every member only for one time. This method allow to initialize this oneway list with values. @@ -80,11 +80,11 @@ class OComponentEnumeration : public ThreadHelpBase , OComponentEnumeration( const css::uno::Sequence< css::uno::Reference< css::lang::XComponent > >& seqComponents ); - //--------------------------------------------------------------------------------------------------------- + // XEventListener - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short last chance to release all references and free memory @descr This method is called, if the enumeration is used completely and has no more elements. Then we must destroy ouer list and release all references to other objects. @@ -99,11 +99,11 @@ class OComponentEnumeration : public ThreadHelpBase , virtual void SAL_CALL disposing( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException, std::exception ); - //--------------------------------------------------------------------------------------------------------- + // XEnumeration - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short check count of accessible elements of enumeration @descr You can call this method to get information about accessible elements in future. Elements you have already getted are not accessible! @@ -120,7 +120,7 @@ class OComponentEnumeration : public ThreadHelpBase , virtual sal_Bool SAL_CALL hasMoreElements() throw( css::uno::RuntimeException, std::exception ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short give the next element, if some exist @descr If a call "hasMoreElements()" return true, you can get the next element of list. @@ -136,13 +136,13 @@ class OComponentEnumeration : public ThreadHelpBase , css::lang::WrappedTargetException , css::uno::RuntimeException, std::exception ); - //------------------------------------------------------------------------------------------------------------- + // protected methods - //------------------------------------------------------------------------------------------------------------- + protected: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard destructor @descr This method destruct an instance of this class and clear some member. We make it protected, because its not supported to use this class as normal instance! @@ -158,7 +158,7 @@ class OComponentEnumeration : public ThreadHelpBase , virtual ~OComponentEnumeration(); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short reset instance to default values @descr There are two ways to delete an instance of this class.<BR> @@ -178,18 +178,18 @@ class OComponentEnumeration : public ThreadHelpBase , virtual void impl_resetObject(); - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: - //------------------------------------------------------------------------------------------------------------- + // debug methods // (should be private everyway!) - //------------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short debug-method to check incoming parameter of some other mehods of this class @descr The following methods are used to check parameters for other methods of this class. The return value is used directly for an ASSERT(...). @@ -208,10 +208,10 @@ class OComponentEnumeration : public ThreadHelpBase , static sal_Bool impldbg_checkParameter_OComponentEnumerationCtor ( const css::uno::Sequence< css::uno::Reference< css::lang::XComponent > >& seqComponents ); static sal_Bool impldbg_checkParameter_disposing ( const css::lang::EventObject& aEvent ); - //------------------------------------------------------------------------------------------------------------- + // variables // (should be private everyway!) - //------------------------------------------------------------------------------------------------------------- + private: diff --git a/framework/inc/helper/oframes.hxx b/framework/inc/helper/oframes.hxx index 89d2512235ad..a6b42e71bddf 100644 --- a/framework/inc/helper/oframes.hxx +++ b/framework/inc/helper/oframes.hxx @@ -36,7 +36,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement XFrames, XIndexAccess and XElementAccess interfaces as helper for services @descr Use this class as helper for these interfaces. We share mutex and framecontainer with ouer owner. The framecontainer is a member of it from type "FrameContainer". That means; @@ -60,7 +60,7 @@ class OFrames : private ThreadHelpBase , // Must be the first of base { public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard ctor @descr These initialize a new instance of this class with all needed information for work. We share framecontainer with owner implementation! It's a threadsafe container. @@ -78,7 +78,7 @@ class OFrames : private ThreadHelpBase , // Must be the first of base // XFrames - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short append frame to container @descr We share the container with ouer owner. We can do this only, if no lock is set on container. Valid references are accepted only! @@ -92,7 +92,7 @@ class OFrames : private ThreadHelpBase , // Must be the first of base *//*-*****************************************************************************************************/ virtual void SAL_CALL append( const css::uno::Reference< css::frame::XFrame >& xFrame ) throw( css::uno::RuntimeException, std::exception ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short remove frame from container @descr This is the companion to append(). We only accept valid references and don't work, if a lock is set. @@ -106,7 +106,7 @@ class OFrames : private ThreadHelpBase , // Must be the first of base *//*-*****************************************************************************************************/ virtual void SAL_CALL remove( const css::uno::Reference< css::frame::XFrame >& xFrame ) throw( css::uno::RuntimeException, std::exception ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return list of all applicable frames for given flags @descr Call these to get a list of all frames, which are match with given search flags. @@ -121,7 +121,7 @@ class OFrames : private ThreadHelpBase , // Must be the first of base // XIndexAccess - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short get count of all current frames in container @descr This is the beginning of full index-access. With a count you can step over all items in container. Next call should be getByIndex(). But these mechanism works only, if no lock in container is set! @@ -136,7 +136,7 @@ class OFrames : private ThreadHelpBase , // Must be the first of base *//*-*****************************************************************************************************/ virtual sal_Int32 SAL_CALL getCount() throw( css::uno::RuntimeException, std::exception ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short get specified container item by index @descr If you called getCount() successful - this method return the specified element as an Any. You must observe the range from 0 to count-1! Otherwise an IndexOutOfBoundsException is thrown. @@ -156,7 +156,7 @@ class OFrames : private ThreadHelpBase , // Must be the first of base // XElementAccess - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short get uno-type of all container items @descr In current implementation type is fixed to XFrame! (container-lock is ignored) @@ -170,7 +170,7 @@ class OFrames : private ThreadHelpBase , // Must be the first of base *//*-*****************************************************************************************************/ virtual css::uno::Type SAL_CALL getElementType() throw( css::uno::RuntimeException, std::exception ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short get fill state of current container @descr Call these to get information about, if items exist in container or not. (container-lock is ignored) @@ -187,7 +187,7 @@ class OFrames : private ThreadHelpBase , // Must be the first of base protected: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard destructor @descr This method destruct an instance of this class and clear some member. This method is protected, because its not allowed to use this class as a member! @@ -202,7 +202,7 @@ class OFrames : private ThreadHelpBase , // Must be the first of base *//*-*****************************************************************************************************/ virtual ~OFrames(); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short reset instance to default values @descr There are two ways to delete an instance of this class.<BR> 1) delete with destructor<BR> @@ -222,7 +222,7 @@ class OFrames : private ThreadHelpBase , // Must be the first of base private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short append one sequence to another @descr There is no operation to add to sequences! Use this helper-method to do this. @@ -240,7 +240,7 @@ class OFrames : private ThreadHelpBase , // Must be the first of base // debug methods // (should be private everyway!) - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short debug-method to check incoming parameter of some other mehods of this class @descr The following methods are used to check parameters for other methods of this class. The return value is used directly for an ASSERT(...). diff --git a/framework/inc/helper/persistentwindowstate.hxx b/framework/inc/helper/persistentwindowstate.hxx index d9dd42b5760d..f6926d83bf18 100644 --- a/framework/inc/helper/persistentwindowstate.hxx +++ b/framework/inc/helper/persistentwindowstate.hxx @@ -37,7 +37,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short listener for closing document frames to make her window state persistent @descr It's a feature of our office. If a document window was created by ourself (and not from any external process e.g. the office bean) we save and restore the window state of it @@ -63,7 +63,7 @@ class PersistentWindowState : // baseclasses (order necessary for right initia css::lang::XInitialization, css::frame::XFrameActionListener > // => XEventListener { - //________________________________ + // member private: @@ -77,37 +77,37 @@ class PersistentWindowState : // baseclasses (order necessary for right initia /// we call SetWindowState one times only for the same frame! sal_Bool m_bWindowStateAlreadySet; - //________________________________ + // interface public: - //____________________________ + // ctor/dtor PersistentWindowState(const css::uno::Reference< css::uno::XComponentContext >& xContext); virtual ~PersistentWindowState( ); - //____________________________ + // XInitialization virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any >& lArguments) throw(css::uno::Exception , css::uno::RuntimeException, std::exception); - //____________________________ + // XFrameActionListener virtual void SAL_CALL frameAction(const css::frame::FrameActionEvent& aEvent) throw(css::uno::RuntimeException, std::exception); - //____________________________ + // XEventListener virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent) throw(css::uno::RuntimeException, std::exception); - //________________________________ + // helper private: - //____________________________ + /** @short identify the application module, which is used behind the component of our frame. @@ -123,7 +123,7 @@ class PersistentWindowState : // baseclasses (order necessary for right initia static OUString implst_identifyModule(const css::uno::Reference< css::uno::XComponentContext >& rxContext, const css::uno::Reference< css::frame::XFrame >& xFrame); - //____________________________ + /** @short retrieve the window state from the configuration. @param rxContext @@ -139,7 +139,7 @@ class PersistentWindowState : // baseclasses (order necessary for right initia static OUString implst_getWindowStateFromConfig(const css::uno::Reference< css::uno::XComponentContext >& rxContext , const OUString& sModuleName); - //____________________________ + /** @short retrieve the window state from the container window. @param xWindow @@ -152,7 +152,7 @@ class PersistentWindowState : // baseclasses (order necessary for right initia */ static OUString implst_getWindowStateFromWindow(const css::uno::Reference< css::awt::XWindow >& xWindow); - //____________________________ + /** @short restore the position and size on the container window. @param rxContext @@ -169,7 +169,7 @@ class PersistentWindowState : // baseclasses (order necessary for right initia const OUString& sModuleName , const OUString& sWindowState ); - //____________________________ + /** @short restore the position and size on the container window. @param xWindow diff --git a/framework/inc/helper/statusindicator.hxx b/framework/inc/helper/statusindicator.hxx index c7f59a76ae5b..a5ddac56d32b 100644 --- a/framework/inc/helper/statusindicator.hxx +++ b/framework/inc/helper/statusindicator.hxx @@ -20,7 +20,7 @@ #ifndef INCLUDED_FRAMEWORK_INC_HELPER_STATUSINDICATOR_HXX #define INCLUDED_FRAMEWORK_INC_HELPER_STATUSINDICATOR_HXX -//_______________________________________________ + // include files of own module #include <helper/statusindicatorfactory.hxx> @@ -29,11 +29,11 @@ #include <macros/xtypeprovider.hxx> #include <macros/generic.hxx> -//_______________________________________________ + // include UNO interfaces #include <com/sun/star/task/XStatusIndicator.hpp> -//_______________________________________________ + // include all others #include <cppuhelper/implbase1.hxx> #include <cppuhelper/weakref.hxx> @@ -42,7 +42,7 @@ namespace framework{ -//_______________________________________________ + /** @short implement a status indicator object @@ -62,7 +62,7 @@ namespace framework{ class StatusIndicator : private ThreadHelpBase // Order of baseclasses is necessary for right initializaton! , public ::cppu::WeakImplHelper1< css::task::XStatusIndicator > { - //------------------------------------------- + // member private: @@ -76,11 +76,11 @@ class StatusIndicator : private ThreadHelpBase // Order of base */ css::uno::WeakReference< css::task::XStatusIndicatorFactory > m_xFactory; - //------------------------------------------- + // c++ interface public: - //---------------------------------------- + /** @short initialize new instance of this class. @param pFactory @@ -88,16 +88,16 @@ class StatusIndicator : private ThreadHelpBase // Order of base */ StatusIndicator(StatusIndicatorFactory* pFactory); - //---------------------------------------- + /** @short does nothing real .... */ virtual ~StatusIndicator(); - //------------------------------------------- + // uno interface public: - //--------------------------------------- + // XStatusIndicator virtual void SAL_CALL start(const OUString& sText , sal_Int32 nRange) diff --git a/framework/inc/helper/statusindicatorfactory.hxx b/framework/inc/helper/statusindicatorfactory.hxx index 37300bba9fd8..57c8271fd503 100644 --- a/framework/inc/helper/statusindicatorfactory.hxx +++ b/framework/inc/helper/statusindicatorfactory.hxx @@ -24,7 +24,7 @@ // with solaris headers ... #include <vector> -//_______________________________________________ + // include files of own module #include <helper/wakeupthread.hxx> #include <threadhelp/threadhelpbase.hxx> @@ -34,7 +34,7 @@ #include <macros/generic.hxx> #include <general.h> -//_______________________________________________ + // include uno interfaces #include <com/sun/star/lang/XTypeProvider.hpp> #include <com/sun/star/lang/XServiceInfo.hpp> @@ -59,7 +59,7 @@ namespace framework{ -//=============================================== + /** @descr This struct hold some information about all currently running progress proccesses. Because the can be used on a stack, we must cache her states but must paint only @@ -67,7 +67,7 @@ namespace framework{ */ struct IndicatorInfo { - //------------------------------------------- + // member public: @@ -84,11 +84,11 @@ struct IndicatorInfo /** @short the last set value for this indicator */ sal_Int32 m_nValue; - //------------------------------------------- + // interface public: - //--------------------------------------- + /** @short initialize new instance of this class @param xIndicator @@ -110,7 +110,7 @@ struct IndicatorInfo m_nValue = 0 ; } - //--------------------------------------- + /** @short Don't forget to free used references! */ ~IndicatorInfo() @@ -118,7 +118,7 @@ struct IndicatorInfo m_xIndicator.clear(); } - //--------------------------------------------------------------------------------------------------------- + /** @short Used to locate an info struct inside a stl structure ... @descr The indicator object itself is used as key. Its values @@ -131,11 +131,11 @@ struct IndicatorInfo } }; -//=============================================== + /** @descr Define a lits of child indicator objects and her data. */ typedef ::std::vector< IndicatorInfo > IndicatorStack; -//=============================================== + /** @short implement a factory service to create new status indicator objects @descr Internally it uses: @@ -158,7 +158,7 @@ class StatusIndicatorFactory : private ThreadHelpBase , css::task::XStatusIndicatorFactory , css::util::XUpdatable > { - //------------------------------------------- + // member private: @@ -202,7 +202,7 @@ class StatusIndicatorFactory : private ThreadHelpBase /** prevent recursive calling of Application::Reschedule(). */ static sal_Int32 m_nInReschedule; - //------------------------------------------- + // interface public: @@ -228,23 +228,23 @@ class StatusIndicatorFactory : private ThreadHelpBase return aSeq; } - //--------------------------------------- + // XInitialization virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any >& lArguments) throw(css::uno::Exception , css::uno::RuntimeException, std::exception); - //--------------------------------------- + // XStatusIndicatorFactory virtual css::uno::Reference< css::task::XStatusIndicator > SAL_CALL createStatusIndicator() throw(css::uno::RuntimeException, std::exception); - //--------------------------------------- + // XUpdatable virtual void SAL_CALL update() throw(css::uno::RuntimeException, std::exception); - //--------------------------------------- + // similar (XStatusIndicator) virtual void start(const css::uno::Reference< css::task::XStatusIndicator >& xChild, const OUString& sText , @@ -260,14 +260,14 @@ class StatusIndicatorFactory : private ThreadHelpBase virtual void SAL_CALL setValue(const css::uno::Reference< css::task::XStatusIndicator >& xChild, sal_Int32 nValue); - //------------------------------------------- + // specials protected: virtual ~StatusIndicatorFactory(); - //------------------------------------------- + // helper private: diff --git a/framework/inc/helper/tagwindowasmodified.hxx b/framework/inc/helper/tagwindowasmodified.hxx index 0c92ef0086d4..8966a89a88ad 100644 --- a/framework/inc/helper/tagwindowasmodified.hxx +++ b/framework/inc/helper/tagwindowasmodified.hxx @@ -36,7 +36,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short listen for modify events on model and tag frame container window so it can react accordingly @descr Used e.g. by our MAC port where such state is shown separately on some controls of the title bar. @@ -58,7 +58,7 @@ class TagWindowAsModified : // baseclasses (order necessary for right initiali css::frame::XFrameActionListener, // => XEventListener css::util::XModifyListener > // => XEventListener { - //________________________________ + // member private: @@ -72,43 +72,43 @@ class TagWindowAsModified : // baseclasses (order necessary for right initiali /// we list on the model for modify events css::uno::WeakReference< css::frame::XModel > m_xModel; - //________________________________ + // interface public: - //____________________________ + // ctor/dtor TagWindowAsModified(); virtual ~TagWindowAsModified( ); - //____________________________ + // XInterface, XTypeProvider - //____________________________ + // XInitialization virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any >& lArguments) throw(css::uno::Exception , css::uno::RuntimeException, std::exception); - //____________________________ + // XModifyListener virtual void SAL_CALL modified(const css::lang::EventObject& aEvent) throw(css::uno::RuntimeException, std::exception); - //____________________________ + // XFrameActionListener virtual void SAL_CALL frameAction(const css::frame::FrameActionEvent& aEvent) throw(css::uno::RuntimeException, std::exception); - //____________________________ + // XEventListener virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent) throw(css::uno::RuntimeException, std::exception); private: - //____________________________ + // @todo document me void impl_update(const css::uno::Reference< css::frame::XFrame >& xFrame); diff --git a/framework/inc/helper/titlebarupdate.hxx b/framework/inc/helper/titlebarupdate.hxx index bfc0dbf6101d..75e01193b697 100644 --- a/framework/inc/helper/titlebarupdate.hxx +++ b/framework/inc/helper/titlebarupdate.hxx @@ -37,7 +37,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short helps our frame on setting title/icon on the titlebar (including updates) @devstatus draft @@ -51,7 +51,7 @@ class TitleBarUpdate : // baseclasses (order necessary for right initialization! , css::frame::XTitleChangeListener // => XEventListener , css::frame::XFrameActionListener > // => XEventListener { - //________________________________ + // structs, types private: @@ -66,7 +66,7 @@ class TitleBarUpdate : // baseclasses (order necessary for right initialization! ::sal_Int32 nIcon; }; - //________________________________ + // member private: @@ -77,46 +77,46 @@ class TitleBarUpdate : // baseclasses (order necessary for right initialization! /// reference to the frame which was created by the office himself css::uno::WeakReference< css::frame::XFrame > m_xFrame; - //________________________________ + // interface public: - //____________________________ + // ctor/dtor TitleBarUpdate(const css::uno::Reference< css::uno::XComponentContext >& xContext); virtual ~TitleBarUpdate( ); - //____________________________ + // XInterface, XTypeProvider - //____________________________ + // XInitialization virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any >& lArguments) throw(css::uno::Exception , css::uno::RuntimeException, std::exception); - //____________________________ + // XFrameActionListener virtual void SAL_CALL frameAction(const css::frame::FrameActionEvent& aEvent) throw(css::uno::RuntimeException, std::exception); - //____________________________ + // XTitleChangeListener virtual void SAL_CALL titleChanged(const css::frame::TitleChangedEvent& aEvent) throw (css::uno::RuntimeException, std::exception); - //____________________________ + // XEventListener virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent) throw(css::uno::RuntimeException, std::exception); - //________________________________ + // helper private: - //____________________________ + /** @short identify the application module, which is used behind the component of our frame. @@ -134,7 +134,7 @@ class TitleBarUpdate : // baseclasses (order necessary for right initialization! ::sal_Bool implst_getModuleInfo(const css::uno::Reference< css::frame::XFrame >& xFrame, TModuleInfo& rInfo ); - //____________________________ + /** @short set a new icon and title on the title bar of our connected frame window. @descr It does not check if an update is really needed. That has to be done outside. @@ -143,7 +143,7 @@ class TitleBarUpdate : // baseclasses (order necessary for right initialization! */ void impl_forceUpdate(); - //____________________________ + /** @short identify the current component (inside the connected frame) and set the right module icon on the title bar. @@ -153,7 +153,7 @@ class TitleBarUpdate : // baseclasses (order necessary for right initialization! */ void impl_updateIcon(const css::uno::Reference< css::frame::XFrame >& xFrame); - //____________________________ + /** @short gets the current title from the frame and set it on the window. @param xFrame diff --git a/framework/inc/helper/uiconfigelementwrapperbase.hxx b/framework/inc/helper/uiconfigelementwrapperbase.hxx index 60b4594da468..3f1a360b3e14 100644 --- a/framework/inc/helper/uiconfigelementwrapperbase.hxx +++ b/framework/inc/helper/uiconfigelementwrapperbase.hxx @@ -55,9 +55,9 @@ class UIConfigElementWrapperBase : protected ThreadHelpBase public ::cppu::OPropertySetHelper , public UIConfigElementWrapperBase_BASE { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: UIConfigElementWrapperBase( sal_Int16 nType ); virtual ~UIConfigElementWrapperBase(); @@ -103,9 +103,9 @@ class UIConfigElementWrapperBase : protected ThreadHelpBase using cppu::OPropertySetHelper::disposing; virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& aEvent ) throw(::com::sun::star::uno::RuntimeException, std::exception); - //------------------------------------------------------------------------------------------------------------- + // protected methods - //------------------------------------------------------------------------------------------------------------- + protected: // OPropertySetHelper diff --git a/framework/inc/helper/uielementwrapperbase.hxx b/framework/inc/helper/uielementwrapperbase.hxx index ab91b1c3e5bb..649a21f4dc03 100644 --- a/framework/inc/helper/uielementwrapperbase.hxx +++ b/framework/inc/helper/uielementwrapperbase.hxx @@ -49,9 +49,9 @@ class UIElementWrapperBase : protected ThreadHelpBase public ::cppu::OPropertySetHelper , public UIElementWrapperBase_BASE { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: UIElementWrapperBase( sal_Int16 nType ); virtual ~UIElementWrapperBase(); @@ -83,9 +83,9 @@ class UIElementWrapperBase : protected ThreadHelpBase virtual ::sal_Int16 SAL_CALL getType() throw (::com::sun::star::uno::RuntimeException, std::exception); virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getRealInterface() throw (::com::sun::star::uno::RuntimeException, std::exception) = 0; - //------------------------------------------------------------------------------------------------------------- + // protected methods - //------------------------------------------------------------------------------------------------------------- + protected: // OPropertySetHelper diff --git a/framework/inc/helper/vclstatusindicator.hxx b/framework/inc/helper/vclstatusindicator.hxx index 1fdc17a85f43..650c8e6a4fb6 100644 --- a/framework/inc/helper/vclstatusindicator.hxx +++ b/framework/inc/helper/vclstatusindicator.hxx @@ -35,13 +35,13 @@ namespace framework { -//----------------------------------------------- + // declaration class VCLStatusIndicator : private ThreadHelpBase, // must be the first real base class! public ::cppu::WeakImplHelper1< css::task::XStatusIndicator > { - //------------------------------------------- + // member private: @@ -67,7 +67,7 @@ class VCLStatusIndicator : private ThreadHelpBase, // must be the first real bas /** knows the current value of the progress. */ sal_Int32 m_nValue; - //------------------------------------------- + // interface public: @@ -95,7 +95,7 @@ class VCLStatusIndicator : private ThreadHelpBase, // must be the first real bas virtual void SAL_CALL setValue(sal_Int32 nValue) throw(css::uno::RuntimeException, std::exception); - //------------------------------------------- + // helper private: diff --git a/framework/inc/helper/wakeupthread.hxx b/framework/inc/helper/wakeupthread.hxx index 846b67b41a29..4c46bebbe67c 100644 --- a/framework/inc/helper/wakeupthread.hxx +++ b/framework/inc/helper/wakeupthread.hxx @@ -20,7 +20,7 @@ #ifndef INCLUDED_FRAMEWORK_INC_HELPER_WAKEUPTHREAD_HXX #define INCLUDED_FRAMEWORK_INC_HELPER_WAKEUPTHREAD_HXX -//_______________________________________________ + // include files of own module #include <threadhelp/threadhelpbase.hxx> @@ -28,12 +28,12 @@ #include <general.h> -//_______________________________________________ + // include UNO interfaces #include <com/sun/star/util/XUpdatable.hpp> -//_______________________________________________ + // include all others #include <cppuhelper/weakref.hxx> #include <osl/thread.hxx> @@ -42,13 +42,13 @@ namespace framework{ -//=============================================== + /** @short implements a "sleeping" thread, which try to sleep without a using cpu consumption :-) */ class WakeUpThread : public ThreadHelpBase , public ::osl::Thread { - //------------------------------------------- + // member private: @@ -56,7 +56,7 @@ class WakeUpThread : public ThreadHelpBase waked up. */ css::uno::WeakReference< css::util::XUpdatable > m_xListener; - //------------------------------------------- + // interface public: diff --git a/framework/inc/jobs/configaccess.hxx b/framework/inc/jobs/configaccess.hxx index b50b90fce508..de0ee8a6d774 100644 --- a/framework/inc/jobs/configaccess.hxx +++ b/framework/inc/jobs/configaccess.hxx @@ -32,7 +32,7 @@ namespace framework{ -//_______________________________________ + /** @short implements a simple configuration access @descr Sometimes it's better to have direct config access @@ -56,7 +56,7 @@ class FWI_DLLPUBLIC ConfigAccess : public ThreadHelpBase E_READWRITE }; - //___________________________________ + // member private: @@ -76,7 +76,7 @@ class FWI_DLLPUBLIC ConfigAccess : public ThreadHelpBase /** represent the current open mode */ EOpenMode m_eMode; - //___________________________________ + // native interface methods public: diff --git a/framework/inc/jobs/helponstartup.hxx b/framework/inc/jobs/helponstartup.hxx index dfbd1e86f3eb..e30d1a4ce914 100644 --- a/framework/inc/jobs/helponstartup.hxx +++ b/framework/inc/jobs/helponstartup.hxx @@ -38,7 +38,7 @@ namespace framework{ -//_______________________________________________ + /** @short implements a job component, which handle the special feature to show a suitable help page for every (visible!) loaded document. @@ -48,43 +48,43 @@ namespace framework{ class HelpOnStartup : private ThreadHelpBase ,public ::cppu::WeakImplHelper3< ::com::sun::star::lang::XServiceInfo,::com::sun::star::lang::XEventListener,::com::sun::star::task::XJob > { - //------------------------------------------- + // member private: - //....................................... + /** @short reference to an uno service manager. */ css::uno::Reference< css::uno::XComponentContext > m_xContext; - //....................................... + /** @short such module manager is used to classify new opened documents. */ css::uno::Reference< css::frame::XModuleManager2 > m_xModuleManager; - //....................................... + /** @short is needed to locate a might open help frame. */ css::uno::Reference< css::frame::XDesktop2 > m_xDesktop; - //....................................... + /** @short provides read access to the underlying configuration. */ css::uno::Reference< css::container::XNameAccess > m_xConfig; - //....................................... + /** @short knows the current locale of this office session, which is needed to build complete help URLs. */ OUString m_sLocale; - //....................................... + /** @short knows the current operating system of this office session, which is needed to build complete help URLs. */ OUString m_sSystem; - //------------------------------------------- + // native interface public: - //--------------------------------------- + /** @short create new instance of this class. @param xContext @@ -93,7 +93,7 @@ class HelpOnStartup : private ThreadHelpBase */ HelpOnStartup(const css::uno::Reference< css::uno::XComponentContext >& xContext); - //--------------------------------------- + /** @short does nothing real ... @descr But it should exists as virtual function, @@ -102,11 +102,11 @@ class HelpOnStartup : private ThreadHelpBase */ virtual ~HelpOnStartup(); - //------------------------------------------- + // uno interface public: - //--------------------------------------- + // css.lang.XServiceInfo DECLARE_XSERVICEINFO @@ -120,11 +120,11 @@ class HelpOnStartup : private ThreadHelpBase virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent) throw(css::uno::RuntimeException, std::exception); - //------------------------------------------- + // helper private: - //--------------------------------------- + /** @short analyze the given job arguments, try to locate a model reference and try to classify this model. @@ -140,7 +140,7 @@ class HelpOnStartup : private ThreadHelpBase */ OUString its_getModuleIdFromEnv(const css::uno::Sequence< css::beans::NamedValue >& lArguments); - //--------------------------------------- + /** @short tries to locate the open help module and return the url of the currently shown help content. @@ -152,7 +152,7 @@ class HelpOnStartup : private ThreadHelpBase */ OUString its_getCurrentHelpURL(); - //--------------------------------------- + /** @short checks if the given help url match to a default help url of any office module. @@ -165,7 +165,7 @@ class HelpOnStartup : private ThreadHelpBase */ ::sal_Bool its_isHelpUrlADefaultOne(const OUString& sHelpURL); - //--------------------------------------- + /** @short checks, if the help module should be shown automaticly for the currently opened office module. @@ -182,7 +182,7 @@ class HelpOnStartup : private ThreadHelpBase */ OUString its_checkIfHelpEnabledAndGetURL(const OUString& sModule); - //--------------------------------------- + /** @short create a help URL for the given parameters. @param sBaseURL diff --git a/framework/inc/jobs/job.hxx b/framework/inc/jobs/job.hxx index 1f4c504a28a9..d0c423ded10e 100644 --- a/framework/inc/jobs/job.hxx +++ b/framework/inc/jobs/job.hxx @@ -59,7 +59,7 @@ class Job : private ThreadHelpBase , css::frame::XTerminateListener , css::util::XCloseListener > { - //___________________________________ + // structs private: @@ -76,7 +76,7 @@ class Job : private ThreadHelpBase E_DISPOSED }; - //___________________________________ + // member private: @@ -169,7 +169,7 @@ class Job : private ThreadHelpBase */ ERunState m_eRunState; - //___________________________________ + // native interface public: @@ -193,7 +193,7 @@ class Job : private ThreadHelpBase void impl_startListening ( ); void impl_stopListening ( ); - //___________________________________ + // uno interface public: diff --git a/framework/inc/jobs/jobconst.hxx b/framework/inc/jobs/jobconst.hxx index aa8332de3b62..0b3b302a2e4f 100644 --- a/framework/inc/jobs/jobconst.hxx +++ b/framework/inc/jobs/jobconst.hxx @@ -31,7 +31,7 @@ namespace framework{ -//_______________________________________ + /** @short defines all constant values used within a job environment. diff --git a/framework/inc/jobs/jobdata.hxx b/framework/inc/jobs/jobdata.hxx index 2acc493a907d..201334079f9d 100644 --- a/framework/inc/jobs/jobdata.hxx +++ b/framework/inc/jobs/jobdata.hxx @@ -102,7 +102,7 @@ class JobData : private ThreadHelpBase {} }; - //___________________________________ + // member private: @@ -179,7 +179,7 @@ class JobData : private ThreadHelpBase */ JobResult m_aLastExecutionResult; - //___________________________________ + // native interface public: @@ -217,7 +217,7 @@ class JobData : private ThreadHelpBase const OUString& sEvent , ::comphelper::SequenceAsVector< JobData::TJob2DocEventBinding >& lJobs ); - //___________________________________ + // private helper private: diff --git a/framework/inc/jobs/jobresult.hxx b/framework/inc/jobs/jobresult.hxx index 4d24d4ec1a71..d1d190209659 100644 --- a/framework/inc/jobs/jobresult.hxx +++ b/framework/inc/jobs/jobresult.hxx @@ -33,7 +33,7 @@ namespace framework{ -//_______________________________________ + /** @short represent a result of a finished job execution @descr Such result instance transport all neccessarry @@ -42,7 +42,7 @@ namespace framework{ */ class JobResult : private ThreadHelpBase { - //___________________________________ + // types public: @@ -63,7 +63,7 @@ class JobResult : private ThreadHelpBase E_DISPATCHRESULT = 4 }; - //___________________________________ + // member private: @@ -105,7 +105,7 @@ class JobResult : private ThreadHelpBase */ css::frame::DispatchResultEvent m_aDispatchResult; - //___________________________________ + // native interface public: diff --git a/framework/inc/jobs/joburl.hxx b/framework/inc/jobs/joburl.hxx index 2839280d721e..3f80c4a0be15 100644 --- a/framework/inc/jobs/joburl.hxx +++ b/framework/inc/jobs/joburl.hxx @@ -45,7 +45,7 @@ namespace framework{ #define JOBURL_PART_SEPARATOR ';' #define JOBURL_PARTARGS_SEPARATOR ',' -//_______________________________________ + /** @short can be used to parse, validate and work with job URL's @descr Job URLs are specified by the following syntax: @@ -55,7 +55,7 @@ namespace framework{ */ class JobURL : private ThreadHelpBase { - //___________________________________ + // types private: @@ -77,7 +77,7 @@ class JobURL : private ThreadHelpBase E_SERVICE = 4 }; - //___________________________________ + // types private: @@ -103,7 +103,7 @@ class JobURL : private ThreadHelpBase /** holds the service arguments */ OUString m_sServiceArgs; - //___________________________________ + // native interface public: @@ -114,7 +114,7 @@ class JobURL : private ThreadHelpBase sal_Bool getAlias ( OUString& sAlias ) const; sal_Bool getService ( OUString& sService ) const; - //___________________________________ + // private helper private: @@ -125,7 +125,7 @@ class JobURL : private ThreadHelpBase OUString& rPartValue , OUString& rPartArguments ); - //___________________________________ + // debug methods! #ifdef ENABLE_COMPONENT_SELF_CHECK diff --git a/framework/inc/jobs/shelljob.hxx b/framework/inc/jobs/shelljob.hxx index 12a99eb663f3..8d051ffe897b 100644 --- a/framework/inc/jobs/shelljob.hxx +++ b/framework/inc/jobs/shelljob.hxx @@ -37,7 +37,7 @@ namespace framework{ -//_______________________________________________ + /** @short implements a job component which can be used to execute system shell commands. @@ -52,19 +52,19 @@ namespace framework{ class ShellJob : private ThreadHelpBase ,public ::cppu::WeakImplHelper2< ::com::sun::star::lang::XServiceInfo,::com::sun::star::task::XJob > { - //------------------------------------------- + // member private: - //....................................... + /** @short reference to an uno service manager. */ css::uno::Reference< css::uno::XComponentContext > m_xContext; - //------------------------------------------- + // native interface public: - //--------------------------------------- + /** @short create new instance of this class. @param xContext @@ -73,7 +73,7 @@ class ShellJob : private ThreadHelpBase */ ShellJob(const css::uno::Reference< css::uno::XComponentContext >& xContext); - //--------------------------------------- + /** @short does nothing real ... @descr But it should exists as virtual function, @@ -82,11 +82,11 @@ class ShellJob : private ThreadHelpBase */ virtual ~ShellJob(); - //------------------------------------------- + // uno interface public: - //--------------------------------------- + // css.lang.XServiceInfo DECLARE_XSERVICEINFO @@ -96,11 +96,11 @@ class ShellJob : private ThreadHelpBase css::uno::Exception , css::uno::RuntimeException, std::exception ); - //------------------------------------------- + // helper private: - //--------------------------------------- + /** generate a return value for method execute() which will force deactivation of this job for further requests. @@ -108,7 +108,7 @@ class ShellJob : private ThreadHelpBase */ static css::uno::Any impl_generateAnswer4Deactivation(); - //--------------------------------------- + /** substitute all might existing placeholder variables within the configured command. @@ -124,7 +124,7 @@ class ShellJob : private ThreadHelpBase */ OUString impl_substituteCommandVariables(const OUString& sCommand); - //--------------------------------------- + /** executes the command. @param sCommand diff --git a/framework/inc/macros/generic.hxx b/framework/inc/macros/generic.hxx index c313783bcadc..ee99f0ed834b 100644 --- a/framework/inc/macros/generic.hxx +++ b/framework/inc/macros/generic.hxx @@ -23,9 +23,9 @@ #include <rtl/ustring.hxx> #include <rtl/textenc.h> -//***************************************************************************************************************** + // generic macros -//***************************************************************************************************************** + /*_________________________________________________________________________________________________________________ DECLARE_ASCII( SASCIIVALUE ) diff --git a/framework/inc/macros/registration.hxx b/framework/inc/macros/registration.hxx index db2b95cb5ccb..2dff57de9543 100644 --- a/framework/inc/macros/registration.hxx +++ b/framework/inc/macros/registration.hxx @@ -36,10 +36,10 @@ _________________________________________________________________________________________________________________*/ -//***************************************************************************************************************** + // public // use it as parameter for COMPONENT_GETFACTORY( IFFACTORIES ) -//***************************************************************************************************************** + #define IFFACTORY( CLASS ) \ /* If searched name found ... */ \ /* You can't add some statements before follow line ... Here can be an ELSE-statement! */ \ @@ -50,10 +50,10 @@ ________________________________________________________________________________ xFactory = CLASS::impl_createFactory( xServiceManager ); \ } -//***************************************************************************************************************** + // public // define method to instanciate new services -//***************************************************************************************************************** + #define COMPONENTGETFACTORY( LIB, IFFACTORIES ) \ extern "C" SAL_DLLPUBLIC_EXPORT void* SAL_CALL LIB##_component_getFactory( const sal_Char* pImplementationName, \ void* pServiceManager , \ diff --git a/framework/inc/macros/xinterface.hxx b/framework/inc/macros/xinterface.hxx index b7cabea59c79..8c245d0dbd49 100644 --- a/framework/inc/macros/xinterface.hxx +++ b/framework/inc/macros/xinterface.hxx @@ -45,11 +45,11 @@ namespace framework{ _________________________________________________________________________________________________________________*/ -//***************************************************************************************************************** + // private // implementation of XInterface::aquire() // XInterface::release() -//***************************************************************************************************************** + #define PRIVATE_DEFINE_XINTERFACE_AQUIRE_RELEASE( CLASS, BASECLASS ) \ void SAL_CALL CLASS::acquire() throw() \ { \ @@ -63,10 +63,10 @@ ________________________________________________________________________________ BASECLASS::release(); \ } -//***************************************************************************************************************** + // private // implementation of XInterface::queryInterface() without any other interfaces! -//***************************************************************************************************************** + #define PRIVATE_DEFINE_XINTERFACE_QUERYINTERFACE_PURE( CLASS, BASECLASS ) \ ::com::sun::star::uno::Any SAL_CALL CLASS::queryInterface( const ::com::sun::star::uno::Type& aType ) throw( ::com::sun::star::uno::RuntimeException ) \ { \ @@ -76,10 +76,10 @@ ________________________________________________________________________________ return BASECLASS::queryInterface( aType ); \ } -//***************************************************************************************************************** + // private // implementation of XInterface::queryInterface() with max. 12 other interfaces! -//***************************************************************************************************************** + #define PRIVATE_DEFINE_XINTERFACE_QUERYINTERFACE( CLASS, BASECLASS, INTERFACES ) \ ::com::sun::star::uno::Any SAL_CALL CLASS::queryInterface( const ::com::sun::star::uno::Type& aType ) throw( ::com::sun::star::uno::RuntimeException, std::exception ) \ { \ @@ -97,10 +97,10 @@ ________________________________________________________________________________ return aReturn; \ } -//***************************************************************************************************************** + // private // implementation of XInterface::queryInterface() with more then 12 other interfaces! -//***************************************************************************************************************** + #define PRIVATE_DEFINE_XINTERFACE_QUERYINTERFACE_LARGE( CLASS, BASECLASS, INTERFACES_FIRST, INTERFACES_SECOND ) \ ::com::sun::star::uno::Any SAL_CALL CLASS::queryInterface( const ::com::sun::star::uno::Type& aType ) throw( ::com::sun::star::uno::RuntimeException, std::exception ) \ { \ @@ -124,10 +124,10 @@ ________________________________________________________________________________ return aReturn; \ } -//***************************************************************************************************************** + // private // complete implementation of XInterface for different use cases -//***************************************************************************************************************** + #define PRIVATE_DEFINE_XINTERFACE_PURE( CLASS, BASECLASS ) \ PRIVATE_DEFINE_XINTERFACE_AQUIRE_RELEASE( CLASS, BASECLASS ) \ PRIVATE_DEFINE_XINTERFACE_QUERYINTERFACE_PURE( CLASS, BASECLASS ) @@ -140,10 +140,10 @@ ________________________________________________________________________________ PRIVATE_DEFINE_XINTERFACE_AQUIRE_RELEASE( CLASS, BASECLASS ) \ PRIVATE_DEFINE_XINTERFACE_QUERYINTERFACE_LARGE( CLASS, BASECLASS, INTERFACES_FIRST, INTERFACES_SECOND ) -//***************************************************************************************************************** + // private // help macros to replace INTERFACES in queryInterface() [see before] -//***************************************************************************************************************** + /* #ifdef ENABLE_SERVICEDEBUG #define PRIVATE_DEFINE_INTERFACE_1( INTERFACE1 ) \ @@ -195,10 +195,10 @@ ________________________________________________________________________________ PRIVATE_DEFINE_INTERFACE_10( INTERFACE1, INTERFACE2, INTERFACE3, INTERFACE4, INTERFACE5, INTERFACE6, INTERFACE7, INTERFACE8, INTERFACE9, INTERFACE10 ), \ INTERFACE11 -//***************************************************************************************************************** + // public // help macros for follow XInterface definitions -//***************************************************************************************************************** + // Use it as parameter for DEFINE_XINTERFACE_X(), if you CAN use an interface directly in queryInterface()! #define DIRECT_INTERFACE( INTERFACE ) \ @@ -209,19 +209,19 @@ ________________________________________________________________________________ #define DERIVED_INTERFACE( BASEINTERFACE, DERIVEDINTERFACE ) \ static_cast< BASEINTERFACE* >( static_cast< DERIVEDINTERFACE* >( this ) ) -//***************************************************************************************************************** + // public // declaration of XInterface -//***************************************************************************************************************** + #define FWK_DECLARE_XINTERFACE \ virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType ) throw( ::com::sun::star::uno::RuntimeException, std::exception ); \ virtual void SAL_CALL acquire ( ) throw(); \ virtual void SAL_CALL release ( ) throw(); -//***************************************************************************************************************** + // public // implementation of XInterface -//***************************************************************************************************************** + // implementation of XInterface with 0 additional interface for queryInterface() #define DEFINE_XINTERFACE_0( CLASS, BASECLASS ) \ diff --git a/framework/inc/macros/xtypeprovider.hxx b/framework/inc/macros/xtypeprovider.hxx index cdcbac5f5839..7854b2f6f1d0 100644 --- a/framework/inc/macros/xtypeprovider.hxx +++ b/framework/inc/macros/xtypeprovider.hxx @@ -49,10 +49,10 @@ namespace framework{ _________________________________________________________________________________________________________________*/ -//***************************************************************************************************************** + // private // implementation of XTypeProvider::getImplementationId() -//***************************************************************************************************************** + #define PRIVATE_DEFINE_XTYPEPROVIDER_GETIMPLEMENTATIONID( CLASS ) \ ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL CLASS::getImplementationId() throw( ::com::sun::star::uno::RuntimeException, std::exception ) \ { \ @@ -78,10 +78,10 @@ ________________________________________________________________________________ return pID->getImplementationId(); \ } -//***************************************************************************************************************** + // private // implementation of XTypeProvider::getTypes() with max. 12 interfaces! -//***************************************************************************************************************** + #define PRIVATE_DEFINE_XTYPEPROVIDER_GETTYPES( CLASS, TYPES ) \ ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL CLASS::getTypes() throw( ::com::sun::star::uno::RuntimeException, std::exception ) \ { \ @@ -108,10 +108,10 @@ ________________________________________________________________________________ return pTypeCollection->getTypes(); \ } -//***************************************************************************************************************** + // private // implementation of XTypeProvider::getTypes() with more then 12 interfaces! -//***************************************************************************************************************** + #define PRIVATE_DEFINE_XTYPEPROVIDER_GETTYPES_LARGE( CLASS, TYPES_FIRST, TYPES_SECOND ) \ ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL CLASS::getTypes() throw( ::com::sun::star::uno::RuntimeException, std::exception ) \ { \ @@ -160,10 +160,10 @@ ________________________________________________________________________________ return *pTypeCollection; \ } -//***************************************************************************************************************** + // private // implementation of XTypeProvider::getTypes() with using max. 12 interfaces + baseclass! -//***************************************************************************************************************** + #define PRIVATE_DEFINE_XTYPEPROVIDER_GETTYPES_BASECLASS( CLASS, BASECLASS, TYPES ) \ ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL CLASS::getTypes() throw( ::com::sun::star::uno::RuntimeException ) \ { \ @@ -211,10 +211,10 @@ ________________________________________________________________________________ return *pTypeCollection; \ } -//***************************************************************************************************************** + // private // help macros to replace TYPES in getTypes() [see before] -//***************************************************************************************************************** + #define PRIVATE_DEFINE_TYPE_1( TYPE1 ) \ ::getCppuType(( const ::com::sun::star::uno::Reference< TYPE1 >*)NULL ) @@ -262,10 +262,10 @@ ________________________________________________________________________________ PRIVATE_DEFINE_TYPE_11( TYPE1, TYPE2, TYPE3, TYPE4, TYPE5, TYPE6, TYPE7, TYPE8, TYPE9, TYPE10, TYPE11 ), \ ::getCppuType(( const ::com::sun::star::uno::Reference< TYPE12 >*)NULL ) -//***************************************************************************************************************** + // private // complete implementation of XTypeProvider -//***************************************************************************************************************** + #define PRIVATE_DEFINE_XTYPEPROVIDER_PURE( CLASS ) \ PRIVATE_DEFINE_XTYPEPROVIDER_GETIMPLEMENTATIONID( CLASS ) \ PRIVATE_DEFINE_XTYPEPROVIDER_GETTYPES( CLASS, ::getCppuType(( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XTypeProvider >*)NULL ) ) @@ -282,18 +282,18 @@ ________________________________________________________________________________ PRIVATE_DEFINE_XTYPEPROVIDER_GETIMPLEMENTATIONID( CLASS ) \ PRIVATE_DEFINE_XTYPEPROVIDER_GETTYPES_BASECLASS( CLASS, BASECLASS, TYPES ) -//***************************************************************************************************************** + // public // declaration of XTypeProvider -//***************************************************************************************************************** + #define FWK_DECLARE_XTYPEPROVIDER \ virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes () throw( ::com::sun::star::uno::RuntimeException, std::exception );\ virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw( ::com::sun::star::uno::RuntimeException, std::exception ); -//***************************************************************************************************************** + // public // implementation of XTypeProvider -//***************************************************************************************************************** + // implementation of XTypeProvider without additional interface for getTypes() // XTypeProvider is used as the only one interface automaticly. // Following defines don't use XTypeProvider automaticly!!!! diff --git a/framework/inc/properties.h b/framework/inc/properties.h index f38420c6f5aa..22c74b2e8b64 100644 --- a/framework/inc/properties.h +++ b/framework/inc/properties.h @@ -26,7 +26,7 @@ namespace framework{ -//_______________________________________________ + /** properties for "Frame" class */ #define FRAME_PROPNAME_ASCII_DISPATCHRECORDERSUPPLIER "DispatchRecorderSupplier" @@ -52,7 +52,7 @@ namespace framework{ #define FRAME_PROPCOUNT 5 -//_______________________________________________ + /** properties for "Desktop" class */ #define DESKTOP_PROPNAME_ASCII_ACTIVEFRAME "ActiveFrame" @@ -78,7 +78,7 @@ namespace framework{ #define DESKTOP_PROPCOUNT 5 -//_______________________________________________ + /** properties for "PathSettings" class */ #define PATHSETTINGS_PROPNAME_ASCII_ADDIN "Addin" @@ -161,7 +161,7 @@ namespace framework{ #define PATHSETTINGS_PROPCOUNT 24 -//_______________________________________________ + /** properties for "LayoutManager" class */ #define LAYOUTMANAGER_PROPNAME_ASCII_MENUBARCLOSER "MenuBarCloser" @@ -185,7 +185,7 @@ namespace framework{ #define LAYOUTMANAGER_PROPHANDLE_LOCKCOUNT 4 #define LAYOUTMANAGER_PROPHANDLE_PRESERVE_CONTENT_SIZE 5 -//_______________________________________________ + /** properties for "UICommandDescription" class */ #define UICOMMANDDESCRIPTION_NAMEACCESS_COMMANDIMAGELIST "private:resource/image/commandimagelist" #define UICOMMANDDESCRIPTION_NAMEACCESS_COMMANDROTATEIMAGELIST "private:resource/image/commandrotateimagelist" @@ -199,7 +199,7 @@ namespace framework{ #define UICOMMANDDESCRIPTION_PROPERTIES_IMAGE_ROTATED 4 #define UICOMMANDDESCRIPTION_PROPERTIES_TOGGLEBUTTON 8 -//_______________________________________________ + /** properties for "AutoRecovery" class */ #define AUTORECOVERY_PROPNAME_ASCII_EXISTS_RECOVERYDATA "ExistsRecoveryData" @@ -216,14 +216,14 @@ namespace framework{ #define AUTORECOVERY_PROPCOUNT 3 -//_______________________________________________ + /** properties for Filter config */ #define FILTER_PROPNAME_ASCII_DOCUMENTSERVICE "DocumentService" #define FILTER_PROPNAME_DOCUMENTSERVICE OUString( FILTER_PROPNAME_ASCII_DOCUMENTSERVICE ) -//_______________________________________________ + /** properties for office module config (Setup.xcu) */ #define OFFICEFACTORY_PROPNAME_ASCII_WINDOWATTRIBUTES "ooSetupFactoryWindowAttributes" @@ -234,7 +234,7 @@ namespace framework{ #define OFFICEFACTORY_PROPNAME_UINAME OUString( OFFICEFACTORY_PROPNAME_ASCII_UINAME ) #define OFFICEFACTORY_PROPNAME_ICON OUString( OFFICEFACTORY_PROPNAME_ASCII_ICON ) -//_______________________________________________ + /** properties for tab window (old) */ #define TABWINDOW_PROPNAME_ASCII_PARENTWINDOW "ParentWindow" #define TABWINDOW_PROPNAME_ASCII_TOPWINDOW "TopWindow" @@ -248,14 +248,14 @@ namespace framework{ #define TABWINDOWSERVICE_PROPHANDLE_WINDOW 0 #define TABWINDOWSERVICE_PROPCOUNT 1 -//_______________________________________________ + /** provides some helper methods to implement property sets. */ class PropHelper { public: - //___________________________________________ + /** checks if given property will be changed by this settings. * We compare the content of the given any values. If they are different we return sal_True - sal_False otherwise. diff --git a/framework/inc/protocols.h b/framework/inc/protocols.h index fd277de4963d..197dd8db9160 100644 --- a/framework/inc/protocols.h +++ b/framework/inc/protocols.h @@ -26,7 +26,7 @@ namespace framework{ -//_______________________________________________________________________ + /** some protocols must be checked during loading or dispatching URLs manually It can be necessary to decide, if a URL represent a non visible content or @@ -58,7 +58,7 @@ class ProtocolCheck { public: - //_______________________________________________________________________ + /** enums for well known protocols */ @@ -77,7 +77,7 @@ class ProtocolCheck E_NEWS }; - //_______________________________________________________________________ + /** it checks, if the given URL string match one of the well known protocols. It returns the right enum value. @@ -120,7 +120,7 @@ class ProtocolCheck return E_UNKNOWN_PROTOCOL; } - //_______________________________________________________________________ + /** it checks if given URL match the required protocol only It should be used instead of specifyProtocol() if only this question diff --git a/framework/inc/queries.h b/framework/inc/queries.h index 2a4e09632af1..6dc16be91c64 100644 --- a/framework/inc/queries.h +++ b/framework/inc/queries.h @@ -28,7 +28,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short These values describe our supported queries for type, filter ... properties. They are used by our FilterFactory or ouer TypeDetection to return subsets of our cached configuration. @@ -44,7 +44,7 @@ namespace framework{ #define BASE_QUERY_MATH DECLARE_ASCII("_query_math" ) #define BASE_QUERY_GRAPHICS DECLARE_ASCII("_query_graphics") -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short These parameters can be used in combination with BASE_QUERY_... defines to specialize it. use follow syntax to do so: "<query>[:<param>[=<value>]]" @@ -75,23 +75,23 @@ namespace framework{ #define QUERYPARAMVALUE_SORT_PROP_NAME DECLARE_ASCII("name" ) #define QUERYPARAMVALUE_SORT_PROP_UINAME DECLARE_ASCII("uiname" ) -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short Helper class to support easy building of a query statements. *//*-*************************************************************************************************************/ class QueryBuilder { public: - //--------------------------------------------------------------------------------------------------------- + // start with empty query - //--------------------------------------------------------------------------------------------------------- + QueryBuilder() { resetAll(); } - //--------------------------------------------------------------------------------------------------------- + // returns full query as copy of internal set values - //--------------------------------------------------------------------------------------------------------- + OUString getQuery() { OUStringBuffer sCopy( m_sParams ); @@ -99,17 +99,17 @@ class QueryBuilder return sCopy.makeStringAndClear(); } - //--------------------------------------------------------------------------------------------------------- + // set new or change existing base query part - //--------------------------------------------------------------------------------------------------------- + void setBase( const OUString& sBase ) { m_sBase = sBase; } - //--------------------------------------------------------------------------------------------------------- + // add new parameter (with optional value) to param list - //--------------------------------------------------------------------------------------------------------- + void addParam( const OUString& sParam, const OUString& sValue = OUString() ) { m_sParams.append( SEPARATOR_QUERYPARAM ); @@ -121,19 +121,19 @@ class QueryBuilder } } - //--------------------------------------------------------------------------------------------------------- + // forget all setted params and start with empty ones // Attention: base of query isn't changed! - //--------------------------------------------------------------------------------------------------------- + void resetParams() { m_sParams.makeStringAndClear(); m_sParams.ensureCapacity( 256 ); } - //--------------------------------------------------------------------------------------------------------- + // start with new empty query - //--------------------------------------------------------------------------------------------------------- + void resetAll() { m_sBase = OUString(); @@ -146,18 +146,18 @@ class QueryBuilder }; // class QueryBuilder -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short Helper class to analyze queries and split into his different parts (base, params and values). *//*-*************************************************************************************************************/ class QueryAnalyzer { public: - //--------------------------------------------------------------------------------------------------------- + // it's will not perform to compare strings as query type ... // so we convert it into these enum values. // default = E_ALL! - //--------------------------------------------------------------------------------------------------------- + enum EQuery { E_ALL , @@ -172,20 +172,20 @@ class QueryAnalyzer E_GRAPHICS }; - //--------------------------------------------------------------------------------------------------------- + // these are valid values for param "sort_prop". // other ones are not supported! // default = E_NAME - //--------------------------------------------------------------------------------------------------------- + enum ESortProp { E_NAME , E_UINAME }; - //--------------------------------------------------------------------------------------------------------- + // analyze given query and split it into his different parts; <base>:<param1>:<param2=value>... - //--------------------------------------------------------------------------------------------------------- + QueryAnalyzer(const OUString& sQuery) // Don't forget to set default values for non given params! : m_eQuery ( E_ALL ) // return ALL filter ... @@ -320,16 +320,16 @@ class QueryAnalyzer } } - //--------------------------------------------------------------------------------------------------------- + // return type of query. User can decide then, which action should be started. // For faster work we converted query string into corresponding enum value! - //--------------------------------------------------------------------------------------------------------- + EQuery getQueryType() const { return m_eQuery; } - //--------------------------------------------------------------------------------------------------------- + // access to additional parameter values // Methods return default of really set values! - //--------------------------------------------------------------------------------------------------------- + sal_uInt32 getIFlags () const { return m_nIFlags ; } sal_uInt32 getEFlags () const { return m_nEFlags ; } ESortProp getSortProp () const { return m_eSortProp ; } @@ -338,10 +338,10 @@ class QueryAnalyzer sal_Bool getUseOrder () const { return m_bUseOrder ; } sal_Bool getDefaultFirst () const { return m_bDefaultFirst ; } - //--------------------------------------------------------------------------------------------------------- + // this method checks if given string match any supported query. // (ignore additional parameters!) - //--------------------------------------------------------------------------------------------------------- + static sal_Bool isQuery( const OUString& sQuery ) { return( diff --git a/framework/inc/recording/dispatchrecordersupplier.hxx b/framework/inc/recording/dispatchrecordersupplier.hxx index 494a2603e181..df0170719926 100644 --- a/framework/inc/recording/dispatchrecordersupplier.hxx +++ b/framework/inc/recording/dispatchrecordersupplier.hxx @@ -53,12 +53,12 @@ class DispatchRecorderSupplier : // baseclasses css::lang::XServiceInfo , css::frame::XDispatchRecorderSupplier > { - //___________________________________________ + // member private: - //_______________________________________ + /** provided dispatch recorder of this supplier instance @life Is controled from outside. Because this variable is setted @@ -67,17 +67,17 @@ class DispatchRecorderSupplier : // baseclasses */ css::uno::Reference< css::frame::XDispatchRecorder > m_xDispatchRecorder; - //___________________________________________ + // uno interface public: - //_______________________________________ + // XInterface, XTypeProvider, XServiceInfo DECLARE_XSERVICEINFO - //_______________________________________ + // XDispatchRecorderSupplier virtual void SAL_CALL setDispatchRecorder( const css::uno::Reference< css::frame::XDispatchRecorder >& xRecorder ) throw (css::uno::RuntimeException, std::exception); @@ -86,7 +86,7 @@ class DispatchRecorderSupplier : // baseclasses const css::uno::Sequence< css::beans::PropertyValue >& lArguments , const css::uno::Reference< css::frame::XDispatch >& xDispatcher ) throw (css::uno::RuntimeException, std::exception); - //___________________________________________ + // native interface public: diff --git a/framework/inc/services.h b/framework/inc/services.h index 167d8ac61d22..c1cc2373873d 100644 --- a/framework/inc/services.h +++ b/framework/inc/services.h @@ -24,9 +24,9 @@ namespace framework{ -//_________________________________________________________________________________________________________________ + // used servicenames by framework -//_________________________________________________________________________________________________________________ + #define SERVICENAME_FILTERFACTORY DECLARE_ASCII("com.sun.star.document.FilterFactory" ) #define SERVICENAME_CFGUPDATEACCESS DECLARE_ASCII("com.sun.star.configuration.ConfigurationUpdateAccess") // provides read/write access to the configuration @@ -49,9 +49,9 @@ namespace framework{ #define SERVICENAME_STRINGABBREVIATION DECLARE_ASCII("com.sun.star.util.UriAbbreviation" ) #define SERVICENAME_TABWINDOWSERVICE DECLARE_ASCII("com.sun.star.ui.dialogs.TabContainerWindow" ) -//_________________________________________________________________________________________________________________ + // used implementationnames by framework -//_________________________________________________________________________________________________________________ + #define IMPLEMENTATIONNAME_DESKTOP DECLARE_ASCII("com.sun.star.comp.framework.Desktop" ) #define IMPLEMENTATIONNAME_URLTRANSFORMER DECLARE_ASCII("com.sun.star.comp.framework.URLTransformer" ) diff --git a/framework/inc/services/contenthandlerfactory.hxx b/framework/inc/services/contenthandlerfactory.hxx index 47a08754c36c..af94e0b83b86 100644 --- a/framework/inc/services/contenthandlerfactory.hxx +++ b/framework/inc/services/contenthandlerfactory.hxx @@ -45,7 +45,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short factory to create handler-objects @descr These class can be used to create new handler for specified contents. We use cached values of our configuration to lay down, which handler match @@ -81,37 +81,37 @@ class ContentHandlerFactory : // interfaces private TransactionBase , public ::cppu::OWeakObject { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - //--------------------------------------------------------------------------------------------------------- + // constructor / destructor - //--------------------------------------------------------------------------------------------------------- + ContentHandlerFactory( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory ); virtual ~ContentHandlerFactory( ); - //--------------------------------------------------------------------------------------------------------- + // XInterface, XTypeProvider, XServiceInfo - //--------------------------------------------------------------------------------------------------------- + DECLARE_XINTERFACE DECLARE_XTYPEPROVIDER DECLARE_XSERVICEINFO - //--------------------------------------------------------------------------------------------------------- + // XMultiServiceFactory - //--------------------------------------------------------------------------------------------------------- + virtual css::uno::Reference< css::uno::XInterface > SAL_CALL createInstance ( const OUString& sTypeName ) throw( css::uno::Exception , css::uno::RuntimeException ); virtual css::uno::Reference< css::uno::XInterface > SAL_CALL createInstanceWithArguments( const OUString& sTypeName , const css::uno::Sequence< css::uno::Any >& lArguments ) throw( css::uno::Exception, css::uno::RuntimeException ); virtual css::uno::Sequence< OUString > SAL_CALL getAvailableServiceNames ( ) throw( css::uno::RuntimeException ); - //--------------------------------------------------------------------------------------------------------- + // XNameContainer - //--------------------------------------------------------------------------------------------------------- + virtual void SAL_CALL insertByName( const OUString& sHandlerName , const css::uno::Any& aHandlerProperties ) throw( css::lang::IllegalArgumentException , css::container::ElementExistException , @@ -121,41 +121,41 @@ class ContentHandlerFactory : // interfaces css::lang::WrappedTargetException , css::uno::RuntimeException ); - //--------------------------------------------------------------------------------------------------------- + // XNameReplace - //--------------------------------------------------------------------------------------------------------- + virtual void SAL_CALL replaceByName( const OUString& sHandlerName , const css::uno::Any& aHandlerProperties ) throw( css::lang::IllegalArgumentException , css::container::NoSuchElementException , css::lang::WrappedTargetException , css::uno::RuntimeException ); - //--------------------------------------------------------------------------------------------------------- + // XNameAccess - //--------------------------------------------------------------------------------------------------------- + virtual css::uno::Any SAL_CALL getByName ( const OUString& sName ) throw( css::container::NoSuchElementException , css::lang::WrappedTargetException , css::uno::RuntimeException ); virtual css::uno::Sequence< OUString > SAL_CALL getElementNames( ) throw( css::uno::RuntimeException ); virtual sal_Bool SAL_CALL hasByName ( const OUString& sName ) throw( css::uno::RuntimeException ); - //--------------------------------------------------------------------------------------------------------- + // XElementAccess - //--------------------------------------------------------------------------------------------------------- + virtual css::uno::Type SAL_CALL getElementType() throw( css::uno::RuntimeException ); virtual sal_Bool SAL_CALL hasElements () throw( css::uno::RuntimeException ); - //--------------------------------------------------------------------------------------------------------- + // XFlushable - //--------------------------------------------------------------------------------------------------------- + virtual void SAL_CALL flush ( ) throw ( css::uno::RuntimeException ); virtual void SAL_CALL addFlushListener ( const css::uno::Reference< css::util::XFlushListener >& xListener ) throw ( css::uno::RuntimeException ); virtual void SAL_CALL removeFlushListener( const css::uno::Reference< css::util::XFlushListener >& xListener ) throw ( css::uno::RuntimeException ); - //------------------------------------------------------------------------------------------------------------- + // private variables // (should be private everyway!) - //------------------------------------------------------------------------------------------------------------- + private: diff --git a/framework/inc/services/desktop.hxx b/framework/inc/services/desktop.hxx index 6cb114662f74..505f5fbddca2 100644 --- a/framework/inc/services/desktop.hxx +++ b/framework/inc/services/desktop.hxx @@ -63,7 +63,7 @@ enum ELoadState E_INTERACTION }; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement the topframe of frame tree @descr This is the root of the frame tree. The desktop has no window, is not visible but he is the logical "masternode" to build the hierarchy. @@ -105,7 +105,7 @@ class Desktop : private osl::Mutex, // internal used types, const etcpp. private: - //--------------------------------------------------------------------- + /** used temporary to know which listener was already called or not. */ typedef ::std::vector< css::uno::Reference< css::frame::XTerminateListener > > TTerminateListenerList; @@ -138,7 +138,7 @@ class Desktop : private osl::Mutex, // XTypeProvider virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes( ) throw(::com::sun::star::uno::RuntimeException, std::exception); - //--------------------------------------------------------------------- + /** @interface XDesktop @@ -170,7 +170,7 @@ class Desktop : private osl::Mutex, virtual ::sal_Bool SAL_CALL terminate() throw( css::uno::RuntimeException, std::exception ); - //--------------------------------------------------------------------- + /** @interface XDesktop @@ -193,7 +193,7 @@ class Desktop : private osl::Mutex, virtual void SAL_CALL addTerminateListener( const css::uno::Reference< css::frame::XTerminateListener >& xListener ) throw( css::uno::RuntimeException, std::exception ); - //--------------------------------------------------------------------- + /** @interface XDesktop @@ -305,9 +305,9 @@ class Desktop : private osl::Mutex, // non-virtual and non-UNO for now bool SAL_CALL terminateQuickstarterToo() throw( css::uno::RuntimeException ); - //------------------------------------------------------------------------------------------------------------- + // protected methods - //------------------------------------------------------------------------------------------------------------- + protected: // OPropertySetHelper @@ -323,15 +323,15 @@ class Desktop : private osl::Mutex, virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper ( ); virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo ( ) throw (css::uno::RuntimeException, std::exception); - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: css::uno::Reference< css::lang::XComponent > impl_getFrameComponent ( const css::uno::Reference< css::frame::XFrame >& xFrame ) const; static const css::uno::Sequence< css::beans::Property > impl_getStaticPropertyDescriptor( ); - //--------------------------------------------------------------------- + /** calls queryTermination() on every registered termination listener. * * Note: Only normal termination listener (registered in list m_aListenerContainer @@ -352,7 +352,7 @@ class Desktop : private osl::Mutex, void impl_sendQueryTerminationEvent(TTerminateListenerList& lCalledListener, ::sal_Bool& bVeto ); - //--------------------------------------------------------------------- + /** calls cancelTermination() on every termination listener * where queryTermination() was called before. * @@ -368,7 +368,7 @@ class Desktop : private osl::Mutex, */ void impl_sendCancelTerminationEvent(const TTerminateListenerList& lCalledListener); - //--------------------------------------------------------------------- + /** calls notifyTermination() on every registered termination listener. * * Note: Only normal termination listener (registered in list m_aListenerContainer @@ -377,7 +377,7 @@ class Desktop : private osl::Mutex, */ void impl_sendNotifyTerminationEvent(); - //--------------------------------------------------------------------- + /** try to close all open frames. * * Iterates over all child frames and try to close them. @@ -395,10 +395,10 @@ class Desktop : private osl::Mutex, */ ::sal_Bool impl_closeFrames(::sal_Bool bAllowUI); - //------------------------------------------------------------------------------------------------------------- + // debug methods // (should be private everytime!) - //------------------------------------------------------------------------------------------------------------- + private: static sal_Bool implcp_addEventListener ( const css::uno::Reference< css::lang::XEventListener >& xListener ); @@ -407,10 +407,10 @@ class Desktop : private osl::Mutex, sal_Bool m_bIsTerminated ; /// check flag to protect us against dispose before terminate! /// see dispose() for further information! - //------------------------------------------------------------------------------------------------------------- + // variables // (should be private everytime!) - //------------------------------------------------------------------------------------------------------------- + private: css::uno::Reference< css::uno::XComponentContext > m_xContext ; /// reference to factory, which has create this instance @@ -427,13 +427,13 @@ class Desktop : private osl::Mutex, OUString m_sTitle ; css::uno::Reference< css::frame::XDispatchRecorderSupplier > m_xDispatchRecorderSupplier ; - //--------------------------------------------------------------------- + /** special terminate listener to close pipe and block external requests * during/after termination process is/was running */ css::uno::Reference< css::frame::XTerminateListener > m_xPipeTerminator; - //--------------------------------------------------------------------- + /** special terminate listener shown inside system tray (quick starter) * Will hinder the office on shutdown ... but wish to allow closing * of open documents. And because thats different to a normal terminate listener @@ -441,7 +441,7 @@ class Desktop : private osl::Mutex, */ css::uno::Reference< css::frame::XTerminateListener > m_xQuickLauncher; - //--------------------------------------------------------------------- + /** special terminate listener which loads images asynchronous for current open documents. * Because internally it uses blocking system APIs ... it cant be guaranteed that * running jobs can be cancelled successfully if the corressponding document will be closed ... @@ -451,7 +451,7 @@ class Desktop : private osl::Mutex, */ css::uno::Reference< css::frame::XTerminateListener > m_xSWThreadManager; - //--------------------------------------------------------------------- + /** special terminate listener shuting down the SfxApplication. * Because these desktop instance closes documents and informs listener * only ... it does not really shutdown the whole application. diff --git a/framework/inc/services/dispatchhelper.hxx b/framework/inc/services/dispatchhelper.hxx index 0aab05c12351..922848c3af1e 100644 --- a/framework/inc/services/dispatchhelper.hxx +++ b/framework/inc/services/dispatchhelper.hxx @@ -50,7 +50,7 @@ class DispatchHelper : public ThreadHelpBase // must be the ,public ::cppu::WeakImplHelper3< ::com::sun::star::lang::XServiceInfo,::com::sun::star::frame::XDispatchHelper,::com::sun::star::frame::XDispatchResultListener > { - //------------------------------------------- + // member private: @@ -66,23 +66,23 @@ class DispatchHelper : public ThreadHelpBase // must be the css::uno::Reference< css::uno::XInterface > m_xBroadcaster; - //------------------------------------------- + // interface public: - //--------------------------------------- + // ctor/dtor DispatchHelper( const css::uno::Reference< css::uno::XComponentContext >& xContext ); virtual ~DispatchHelper( ); - //--------------------------------------- + // XInterface, XTypeProvider, XServiceInfo DECLARE_XSERVICEINFO - //--------------------------------------- + // XDispatchHelper virtual css::uno::Any SAL_CALL executeDispatch( const css::uno::Reference< css::frame::XDispatchProvider >& xDispatchProvider , @@ -92,13 +92,13 @@ class DispatchHelper : public ThreadHelpBase // must be the const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) throw(css::uno::RuntimeException, std::exception); - //--------------------------------------- + // XDispatchResultListener virtual void SAL_CALL dispatchFinished( const css::frame::DispatchResultEvent& aResult ) throw(css::uno::RuntimeException, std::exception); - //--------------------------------------- + // XEventListener virtual void SAL_CALL disposing( const css::lang::EventObject& aEvent ) diff --git a/framework/inc/services/layoutmanager.hxx b/framework/inc/services/layoutmanager.hxx index 08932cbf0dc5..db8be46e50f9 100644 --- a/framework/inc/services/layoutmanager.hxx +++ b/framework/inc/services/layoutmanager.hxx @@ -112,9 +112,8 @@ namespace framework return aSeq; } - //--------------------------------------------------------------------------------------------------------- + // XLayoutManager - //--------------------------------------------------------------------------------------------------------- virtual void SAL_CALL attachFrame( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& Frame ) throw (::com::sun::star::uno::RuntimeException, std::exception); virtual void SAL_CALL reset() throw (::com::sun::star::uno::RuntimeException, std::exception); virtual ::com::sun::star::awt::Rectangle SAL_CALL getCurrentDockingArea( ) throw (::com::sun::star::uno::RuntimeException, std::exception); @@ -147,51 +146,42 @@ namespace framework virtual void SAL_CALL setVisible( sal_Bool bVisible ) throw (::com::sun::star::uno::RuntimeException, std::exception); virtual sal_Bool SAL_CALL isVisible() throw (::com::sun::star::uno::RuntimeException, std::exception); - //--------------------------------------------------------------------------------------------------------- // XMenuBarMergingAcceptor - //--------------------------------------------------------------------------------------------------------- + virtual sal_Bool SAL_CALL setMergedMenuBar( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& xMergedMenuBar ) throw (::com::sun::star::uno::RuntimeException, std::exception); virtual void SAL_CALL removeMergedMenuBar( ) throw (::com::sun::star::uno::RuntimeException, std::exception); - //--------------------------------------------------------------------------------------------------------- + // XWindowListener - //--------------------------------------------------------------------------------------------------------- virtual void SAL_CALL windowResized( const css::awt::WindowEvent& aEvent ) throw( css::uno::RuntimeException, std::exception ); virtual void SAL_CALL windowMoved( const css::awt::WindowEvent& aEvent ) throw( css::uno::RuntimeException, std::exception ); virtual void SAL_CALL windowShown( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException, std::exception ); virtual void SAL_CALL windowHidden( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException, std::exception ); - //--------------------------------------------------------------------------------------------------------- // XFrameActionListener - //--------------------------------------------------------------------------------------------------------- virtual void SAL_CALL frameAction( const css::frame::FrameActionEvent& aEvent ) throw ( css::uno::RuntimeException, std::exception ); - //--------------------------------------------------------------------------------------------------------- // XEventListener - //--------------------------------------------------------------------------------------------------------- using cppu::OPropertySetHelper::disposing; virtual void SAL_CALL disposing( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException, std::exception ); - //--------------------------------------------------------------------------------------------------------- + // XUIConfigurationListener - //--------------------------------------------------------------------------------------------------------- virtual void SAL_CALL elementInserted( const ::com::sun::star::ui::ConfigurationEvent& Event ) throw (::com::sun::star::uno::RuntimeException, std::exception); virtual void SAL_CALL elementRemoved( const ::com::sun::star::ui::ConfigurationEvent& Event ) throw (::com::sun::star::uno::RuntimeException, std::exception); virtual void SAL_CALL elementReplaced( const ::com::sun::star::ui::ConfigurationEvent& Event ) throw (::com::sun::star::uno::RuntimeException, std::exception); - //--------------------------------------------------------------------------------------------------------- // XLayoutManagerEventBroadcaster - //--------------------------------------------------------------------------------------------------------- virtual void SAL_CALL addLayoutManagerEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XLayoutManagerListener >& aLayoutManagerListener ) throw (::com::sun::star::uno::RuntimeException, std::exception); virtual void SAL_CALL removeLayoutManagerEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XLayoutManagerListener >& aLayoutManagerListener ) throw (::com::sun::star::uno::RuntimeException, std::exception); DECL_LINK(MenuBarClose, void *); DECL_LINK( WindowEventListener, VclSimpleEvent* ); - //--------------------------------------------------------------------------------------------------------- + // ILayoutNotifications - //--------------------------------------------------------------------------------------------------------- + virtual void requestLayout( Hint eHint ); /// Reading of settings - shared with ToolbarLayoutManager. @@ -204,27 +194,27 @@ namespace framework DECL_LINK(AsyncLayoutHdl, void *); private: - //--------------------------------------------------------------------------------------------------------- + // helper - //--------------------------------------------------------------------------------------------------------- - //--------------------------------------------------------------------------------------------------------- + + // menu bar - //--------------------------------------------------------------------------------------------------------- + void impl_clearUpMenuBar(); void implts_reset( sal_Bool bAttach ); void implts_updateMenuBarClose(); sal_Bool implts_resetMenuBar(); - //--------------------------------------------------------------------------------------------------------- + // locking - //--------------------------------------------------------------------------------------------------------- + void implts_lock(); sal_Bool implts_unlock(); - //--------------------------------------------------------------------------------------------------------- + // query - //--------------------------------------------------------------------------------------------------------- + ::com::sun::star::uno::Reference< ::com::sun::star::ui::XUIElement > implts_findElement( const OUString& aName ); void implts_writeNewStateData( const OUString aName, const ::com::sun::star::uno::Reference< com::sun::star::awt::XWindow >& xWindow ); @@ -281,9 +271,9 @@ namespace framework DECL_LINK( OptionsChanged, void* ); DECL_LINK( SettingsChanged, void* ); - //--------------------------------------------------------------------------------------------------------- + // OPropertySetHelper - //--------------------------------------------------------------------------------------------------------- + virtual sal_Bool SAL_CALL convertFastPropertyValue ( com::sun::star::uno::Any& aConvertedValue , com::sun::star::uno::Any& aOldValue , sal_Int32 nHandle , diff --git a/framework/inc/services/mediatypedetectionhelper.hxx b/framework/inc/services/mediatypedetectionhelper.hxx index dbb2819ea73e..6af692938147 100644 --- a/framework/inc/services/mediatypedetectionhelper.hxx +++ b/framework/inc/services/mediatypedetectionhelper.hxx @@ -29,13 +29,13 @@ #include <com/sun/star/util/XStringMapping.hpp> #include <cppuhelper/implbase2.hxx> -//_________________________________________________________________________________________________________________ + // namespaces -//_________________________________________________________________________________________________________________ + namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short - @descr - @@ -50,17 +50,17 @@ namespace framework{ class MediaTypeDetectionHelper : public ::cppu::WeakImplHelper2< ::com::sun::star::util::XStringMapping, css::lang::XServiceInfo> { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - //--------------------------------------------------------------------------------------------------------- + // constructor / destructor - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short standard ctor @descr These initialize a new instance of this class with all needed information for work. @@ -74,7 +74,7 @@ class MediaTypeDetectionHelper : public ::cppu::WeakImplHelper2< ::com::sun:: MediaTypeDetectionHelper( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory ); - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard destructor @descr This method destruct an instance of this class and clear some member. @@ -88,17 +88,17 @@ class MediaTypeDetectionHelper : public ::cppu::WeakImplHelper2< ::com::sun:: virtual ~MediaTypeDetectionHelper(); - //--------------------------------------------------------------------------------------------------------- + // XInterface, XTypeProvider, XServiceInfo - //--------------------------------------------------------------------------------------------------------- + DECLARE_XSERVICEINFO - //--------------------------------------------------------------------------------------------------------- + // XStringMapping - //--------------------------------------------------------------------------------------------------------- - /*-****************************************************************************************************//** + + /*-**************************************************************************************************** @short - @descr - @@ -113,10 +113,10 @@ class MediaTypeDetectionHelper : public ::cppu::WeakImplHelper2< ::com::sun:: virtual sal_Bool SAL_CALL mapStrings(css::uno::Sequence< OUString >& seqParameter) throw (css::uno::RuntimeException, std::exception); - //------------------------------------------------------------------------------------------------------------- + // variables // should be private every time - //------------------------------------------------------------------------------------------------------------- + private: diff --git a/framework/inc/stdtypes.h b/framework/inc/stdtypes.h index 0214c90715b2..463d8abdba30 100644 --- a/framework/inc/stdtypes.h +++ b/framework/inc/stdtypes.h @@ -79,7 +79,7 @@ struct KeyEventEqualsFunc } }; -//_________________________________________________________________________________________________________________ + /** Basic string list based on a std::vector() @@ -114,7 +114,7 @@ class OUStringList : public ::comphelper::SequenceAsVector< OUString > } }; -//_________________________________________________________________________________________________________________ + /** Basic string queue based on a std::queue() @@ -123,7 +123,7 @@ class OUStringList : public ::comphelper::SequenceAsVector< OUString > */ typedef ::std::queue< OUString > OUStringQueue; -//_________________________________________________________________________________________________________________ + /** Basic hash based on a boost::unordered_map() which provides key=[OUString] and value=[template type] pairs @@ -145,7 +145,7 @@ class BaseHash : public ::boost::unordered_map< OUString , } }; -//_________________________________________________________________________________________________________________ + /** Basic OUString hash. @@ -153,7 +153,7 @@ class BaseHash : public ::boost::unordered_map< OUString , */ typedef BaseHash< OUString > OUStringHashMap; -//_________________________________________________________________________________________________________________ + /** It can be used to map names (e.g. of properties) to her corresponding handles. @@ -162,7 +162,7 @@ typedef BaseHash< OUString > OUStringHashMap; */ typedef BaseHash< sal_Int32 > NameToHandleHash; -//_________________________________________________________________________________________________________________ + /** Sometimes we need this template to implement listener container ... diff --git a/framework/inc/tabwin/tabwindow.hxx b/framework/inc/tabwin/tabwindow.hxx index 2751d9b4d680..f0dbce002352 100644 --- a/framework/inc/tabwin/tabwindow.hxx +++ b/framework/inc/tabwin/tabwindow.hxx @@ -72,21 +72,16 @@ class TabWindow : public ::com::sun::star::lang::XTypeProvider , using ::cppu::OPropertySetHelper::disposing; using ::cppu::OPropertySetHelper::getFastPropertyValue; - //--------------------------------------------------------------------------------------------------------- + // XInitialization - //--------------------------------------------------------------------------------------------------------- virtual void SAL_CALL initialize( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments ) throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException, std::exception); - //--------------------------------------------------------------------------------------------------------- // XComponent - //--------------------------------------------------------------------------------------------------------- virtual void SAL_CALL dispose() throw (::com::sun::star::uno::RuntimeException, std::exception); 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); - //--------------------------------------------------------------------------------------------------------- // XSimpleTabController - //--------------------------------------------------------------------------------------------------------- virtual ::sal_Int32 SAL_CALL insertTab() throw (::com::sun::star::uno::RuntimeException, std::exception); virtual void SAL_CALL removeTab( ::sal_Int32 ID ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException, std::exception); virtual void SAL_CALL setTabProps( ::sal_Int32 ID, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue >& Properties ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException, std::exception); @@ -96,14 +91,11 @@ class TabWindow : public ::com::sun::star::lang::XTypeProvider , virtual void SAL_CALL addTabListener( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XTabListener >& Listener ) throw (::com::sun::star::uno::RuntimeException, std::exception); virtual void SAL_CALL removeTabListener( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XTabListener >& Listener ) throw (::com::sun::star::uno::RuntimeException, std::exception); - //--------------------------------------------------------------------------------------------------------- + // XEventListener - //--------------------------------------------------------------------------------------------------------- virtual void SAL_CALL disposing( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException, std::exception ); - //--------------------------------------------------------------------------------------------------------- // XTopWindowListener - //--------------------------------------------------------------------------------------------------------- virtual void SAL_CALL windowOpened( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException, std::exception); virtual void SAL_CALL windowClosing( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException, std::exception); virtual void SAL_CALL windowClosed( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException, std::exception); @@ -112,9 +104,7 @@ class TabWindow : public ::com::sun::star::lang::XTypeProvider , virtual void SAL_CALL windowActivated( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException, std::exception); virtual void SAL_CALL windowDeactivated( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException, std::exception); - //--------------------------------------------------------------------------------------------------------- // XWindowListener - //--------------------------------------------------------------------------------------------------------- virtual void SAL_CALL windowResized( const css::awt::WindowEvent& aEvent ) throw( css::uno::RuntimeException, std::exception ); virtual void SAL_CALL windowMoved( const css::awt::WindowEvent& aEvent ) throw( css::uno::RuntimeException, std::exception ); virtual void SAL_CALL windowShown( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException, std::exception ); @@ -125,9 +115,9 @@ class TabWindow : public ::com::sun::star::lang::XTypeProvider , DECL_LINK( Deactivate, TabControl* ); private: - //--------------------------------------------------------------------------------------------------------- + // OPropertySetHelper - //--------------------------------------------------------------------------------------------------------- + virtual sal_Bool SAL_CALL convertFastPropertyValue( com::sun::star::uno::Any& aConvertedValue , com::sun::star::uno::Any& aOldValue , sal_Int32 nHandle , diff --git a/framework/inc/targets.h b/framework/inc/targets.h index 8198fbb5cd38..0d7fdf26b28d 100644 --- a/framework/inc/targets.h +++ b/framework/inc/targets.h @@ -24,9 +24,9 @@ namespace framework{ -//_________________________________________________________________________________________________________________ + // Values for special frame search ... sTargetFrameName of findFrame() or queryDispatch() or loadComponentFromURL() -//_________________________________________________________________________________________________________________ + #define SPECIALTARGET_ASCII_SELF "_self" // The frame himself is searched. #define SPECIALTARGET_ASCII_PARENT "_parent" // The direct parent frame is searched. diff --git a/framework/inc/threadhelp/fairrwlock.hxx b/framework/inc/threadhelp/fairrwlock.hxx index ece091b7e295..8d90ad091281 100644 --- a/framework/inc/threadhelp/fairrwlock.hxx +++ b/framework/inc/threadhelp/fairrwlock.hxx @@ -30,7 +30,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement a read/write lock with fairness between read/write accessors @descr These implementation never should used as base class! Use it as a member every time. Use ReadGuard and/or WriteGuard in your methods (which work with these lock) @@ -49,12 +49,12 @@ namespace framework{ class FairRWLock : public IRWLock , private INonCopyable { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short standard ctor @descr Initialize instance with right start values for correct working. no reader could exist => m_nReadCount = 0 @@ -77,7 +77,7 @@ class FairRWLock : public IRWLock { } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @interface IRWLock @short set lock for reading @descr A guard should call this method to acquire read access on your member. @@ -110,7 +110,7 @@ class FairRWLock : public IRWLock ++m_nReadCount; } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @interface IRWLock @short reset lock for reading @descr A guard should call this method to release read access on your member. @@ -138,7 +138,7 @@ class FairRWLock : public IRWLock } } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @interface IRWLock @short set lock for writing @descr A guard should call this method to acquire write access on your member. @@ -164,7 +164,7 @@ class FairRWLock : public IRWLock m_aWriteCondition.wait(); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @interface IRWLock @short reset lock for writing @descr A guard should call this method to release write access on your member. @@ -186,7 +186,7 @@ class FairRWLock : public IRWLock m_aSerializer.release(); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @interface IRWLock @short downgrade a write access to a read access @descr A guard should call this method to change a write to a read access. @@ -223,9 +223,9 @@ class FairRWLock : public IRWLock m_aSerializer.release(); } - //------------------------------------------------------------------------------------------------------------- + // private member - //------------------------------------------------------------------------------------------------------------- + private: ::osl::Mutex m_aAccessLock ; /// regulate access on internal member of this instance diff --git a/framework/inc/threadhelp/gate.hxx b/framework/inc/threadhelp/gate.hxx index 1960909a997e..d3c92c2ace12 100644 --- a/framework/inc/threadhelp/gate.hxx +++ b/framework/inc/threadhelp/gate.hxx @@ -28,7 +28,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement a gate to block multiple threads at same time or unblock all @descr A gate can be used as a negative-condition! You can open a "door" - wait() will not block ... or you can close it - wait() blocks till open() is called again. @@ -46,12 +46,12 @@ namespace framework{ class Gate : public IGate , private INonCopyable { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short ctor @descr These initialize the object right as an open gate. @@ -69,7 +69,7 @@ class Gate : public IGate open(); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short dtor @descr Is user forget it - we open the gate ... blocked threads can running ... but I don't know @@ -87,7 +87,7 @@ class Gate : public IGate open(); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @interface IGate @short open the gate @descr A wait() call will not block then. @@ -110,7 +110,7 @@ class Gate : public IGate m_bClosed = !m_aPassage.check(); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @interface IGate @short close the gate @descr A wait() call will block then. @@ -133,7 +133,7 @@ class Gate : public IGate m_bClosed = !m_aPassage.check(); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @interface IGate @short open gate for current waiting threads @descr All current waiting threads stand in wait() at line "m_aPassage.wait()" ... @@ -159,7 +159,7 @@ class Gate : public IGate m_bGapOpen = m_aPassage.check(); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @interface IGate @short must be called to pass the gate @descr If gate "open" => wait() will not block. @@ -200,9 +200,9 @@ class Gate : public IGate return bSuccessful; } - //------------------------------------------------------------------------------------------------------------- + // private member - //------------------------------------------------------------------------------------------------------------- + private: ::osl::Mutex m_aAccessLock ; diff --git a/framework/inc/threadhelp/igate.h b/framework/inc/threadhelp/igate.h index 1d2b2fba4c47..957493c8972a 100644 --- a/framework/inc/threadhelp/igate.h +++ b/framework/inc/threadhelp/igate.h @@ -24,17 +24,17 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr We need this interface to support using of different gate implementations in a generic way. *//*-*************************************************************************************************************/ class IGate { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @descr These functions must be supported by a derived class! open() -open access for all waiting threads close() -close access for all further coming threads diff --git a/framework/inc/threadhelp/inoncopyable.h b/framework/inc/threadhelp/inoncopyable.h index e5799baca580..bf18ff47e578 100644 --- a/framework/inc/threadhelp/inoncopyable.h +++ b/framework/inc/threadhelp/inoncopyable.h @@ -22,7 +22,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr Use this as one of your base classes to disable all possiblities to copy or assign one object to another one! We declare necessary functions private to do so. diff --git a/framework/inc/threadhelp/irwlock.h b/framework/inc/threadhelp/irwlock.h index 20a97f104ea3..e8e7165bb9d5 100644 --- a/framework/inc/threadhelp/irwlock.h +++ b/framework/inc/threadhelp/irwlock.h @@ -22,7 +22,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr A guard (specialy a write guard) support different internal working states. His lock can set for reading or writing/reading! Or he was unlocked by user ... *//*-*************************************************************************************************************/ @@ -33,7 +33,7 @@ enum ELockMode E_WRITELOCK }; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr We implement two guards for using an rw-lock. But if you wish to implement different rw-locks to you will have problems by using with same guard implementation! Thats why we define this "pure virtual base class" ... @@ -41,12 +41,12 @@ enum ELockMode *//*-*************************************************************************************************************/ class IRWLock { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @descr These functions must be supported by a derived class! acquireReadAccess() -try to register thread as reader releaseReadAccess() -unregister thread as reader diff --git a/framework/inc/threadhelp/itransactionmanager.h b/framework/inc/threadhelp/itransactionmanager.h index 979ca8c197c1..0cbb084ab9eb 100644 --- a/framework/inc/threadhelp/itransactionmanager.h +++ b/framework/inc/threadhelp/itransactionmanager.h @@ -26,7 +26,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr Describe different states of a feature of following implementation. During lifetime of an object different working states occur: initialization - working - closing - closed @@ -44,7 +44,7 @@ enum EWorkingMode E_CLOSE // Object is dead! -> all calls are rejected! }; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr If a request was refused by a transaction manager (internal state different E_WORK ...) user can check the reason by using this enum values. *//*-*************************************************************************************************************/ @@ -56,7 +56,7 @@ enum ERejectReason E_CLOSED }; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr A transaction object should support throwing exceptions if user used it at wrong working mode. e.g. We can throw a DisposedException if user try to work and our mode is E_CLOSE! But sometimes he dont need this feature - will handle it by himself. @@ -94,7 +94,7 @@ enum EExceptionMode E_SOFTEXCEPTIONS }; -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @descr How can you use the transaction manager? Use it in combination with an TransactionGuard, which register your transaction in ctor and release in dtor automaticly! Follow interface class can be used to make using @@ -102,12 +102,12 @@ enum EExceptionMode *//*-*************************************************************************************************************/ class ITransactionManager { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @descr These functions must be supported by a derived class! getWorkingMode() -return current set working mode setWorkingMode() -change working mode diff --git a/framework/inc/threadhelp/lockhelper.hxx b/framework/inc/threadhelp/lockhelper.hxx index b5ca773c1f62..f961f2c2a40e 100644 --- a/framework/inc/threadhelp/lockhelper.hxx +++ b/framework/inc/threadhelp/lockhelper.hxx @@ -30,7 +30,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short helper to set right lock in right situation @descr This helper support different types of locking: a) no locks - transparent for user! @@ -60,45 +60,45 @@ class FWI_DLLPUBLIC LockHelper : public IMutex , public IRWLock , private INonCopyable { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - //------------------------------------------------------------------------------------------------------------- + // ctor/dtor - //------------------------------------------------------------------------------------------------------------- + LockHelper( comphelper::SolarMutex* pSolarMutex = NULL ); virtual ~LockHelper( ); - //------------------------------------------------------------------------------------------------------------- + // interface ::framework::IMutex - //------------------------------------------------------------------------------------------------------------- + virtual void acquire(); virtual void release(); - //------------------------------------------------------------------------------------------------------------- + // interface ::framework::IRWLock - //------------------------------------------------------------------------------------------------------------- + virtual void acquireReadAccess (); virtual void releaseReadAccess (); virtual void acquireWriteAccess (); virtual void releaseWriteAccess (); virtual void downgradeWriteAccess(); - //------------------------------------------------------------------------------------------------------------- + // something else - //------------------------------------------------------------------------------------------------------------- + static LockHelper& getGlobalLock(); //TODO: this presumable should return the SolarMutex, though it // actually returns some independent mutex ::osl::Mutex& getShareableOslMutex( ); - //------------------------------------------------------------------------------------------------------------- + // private member // Make some member mutable for using in const functions! - //------------------------------------------------------------------------------------------------------------- + private: mutable comphelper::SolarMutex* m_pSolarMutex ; diff --git a/framework/inc/threadhelp/readguard.hxx b/framework/inc/threadhelp/readguard.hxx index afdd17316f3c..4dacd9dc63ee 100644 --- a/framework/inc/threadhelp/readguard.hxx +++ b/framework/inc/threadhelp/readguard.hxx @@ -28,7 +28,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement a guard to set read locks @descr This guard should be used to set a lock for reading object internal member. Nobody can control it but don't use member after successfully locking for writing! @@ -46,12 +46,12 @@ namespace framework{ *//*-*************************************************************************************************************/ class ReadGuard : private INonCopyable { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short ctor @descr These ctors initialize the guard with a reference to used lock member of object to protect. Null isn't allowed as value! @@ -71,7 +71,7 @@ class ReadGuard : private INonCopyable lock(); } - //********************************************************************************************************* + inline ReadGuard( IRWLock& rLock ) : m_pLock ( &rLock ) , m_bLocked ( sal_False ) @@ -79,7 +79,7 @@ class ReadGuard : private INonCopyable lock(); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short dtor @descr We unlock the used lock member automaticly if user forget it. @@ -95,7 +95,7 @@ class ReadGuard : private INonCopyable unlock(); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short set read lock @descr Call this method to set the read lock. The call will block till all current threads are synchronized! @@ -115,7 +115,7 @@ class ReadGuard : private INonCopyable } } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short unset read lock @descr Call this method to unlock the rw-lock temp.! Normaly we do it at dtor automaticly for you ... @@ -136,12 +136,12 @@ class ReadGuard : private INonCopyable } } - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short disable using of these functions! @descr It's not allowed to use this methods. Different problem can occur otherwise. Thats why we disable it by make it private. @@ -155,9 +155,9 @@ class ReadGuard : private INonCopyable *//*-*****************************************************************************************************/ ReadGuard(); - //------------------------------------------------------------------------------------------------------------- + // private member - //------------------------------------------------------------------------------------------------------------- + private: IRWLock* m_pLock ; /// reference to lock-member of protected object diff --git a/framework/inc/threadhelp/resetableguard.hxx b/framework/inc/threadhelp/resetableguard.hxx index fcb287a33c40..a27941a495dd 100644 --- a/framework/inc/threadhelp/resetableguard.hxx +++ b/framework/inc/threadhelp/resetableguard.hxx @@ -28,7 +28,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement a guard for implementing save thread access @descr These guard has an additional feature to well known one ::osl::Guard. You can lock() and unlock() it very often! @@ -46,12 +46,12 @@ namespace framework{ *//*-*************************************************************************************************************/ class ResetableGuard : private INonCopyable { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short ctors @descr Use these ctor methods to initialize the guard right. Given lock reference must be valid - otherwise crashes could occur! @@ -71,7 +71,7 @@ class ResetableGuard : private INonCopyable lock(); } - //********************************************************************************************************* + inline ResetableGuard( IMutex& rLock ) : m_pLock ( &rLock ) , m_bLocked ( sal_False ) @@ -79,7 +79,7 @@ class ResetableGuard : private INonCopyable lock(); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short dtor @descr We must release set mutex if programmer forget it ... @@ -95,7 +95,7 @@ class ResetableGuard : private INonCopyable unlock(); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short enable/disable the lock @descr Use this methods to lock or unlock the mutex. You can do it so often you wish to do that ... @@ -122,7 +122,7 @@ class ResetableGuard : private INonCopyable } } - //********************************************************************************************************* + inline void unlock() { if( m_bLocked == sal_True ) @@ -132,12 +132,12 @@ class ResetableGuard : private INonCopyable } } - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short disable using of these functions! @descr It's not allowed to use this methods. Different problem can occur otherwise. Thats why we disable it by make it private. @@ -151,9 +151,9 @@ class ResetableGuard : private INonCopyable *//*-*****************************************************************************************************/ ResetableGuard(); - //------------------------------------------------------------------------------------------------------------- + // private member - //------------------------------------------------------------------------------------------------------------- + private: IMutex* m_pLock ; /// pointer to safed lock member of user diff --git a/framework/inc/threadhelp/threadhelpbase.hxx b/framework/inc/threadhelp/threadhelpbase.hxx index b769d65b0dc7..4ac22bfcb4f3 100644 --- a/framework/inc/threadhelp/threadhelpbase.hxx +++ b/framework/inc/threadhelp/threadhelpbase.hxx @@ -24,7 +24,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short "baseclass" to make own classes threadsafe @descr Sometimes you must share your lock- or mutex member with any other baseclasses. And baseclasses are initialized erlier then members! That's why you should use @@ -41,19 +41,19 @@ namespace framework{ *//*-*************************************************************************************************************/ struct ThreadHelpBase { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: ThreadHelpBase( comphelper::SolarMutex* pSolarMutex = NULL ) : m_aLock( pSolarMutex ) { } - //------------------------------------------------------------------------------------------------------------- + // public member // Make it mutable for using in const functions! - //------------------------------------------------------------------------------------------------------------- + public: mutable LockHelper m_aLock; diff --git a/framework/inc/threadhelp/transactionbase.hxx b/framework/inc/threadhelp/transactionbase.hxx index a36f4aa2b264..70308e781dad 100644 --- a/framework/inc/threadhelp/transactionbase.hxx +++ b/framework/inc/threadhelp/transactionbase.hxx @@ -24,7 +24,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short make it possible to instanciate a transacion manager as first member! @descr If you use a transaction manager as a member of your class and wish to use it earlier then other ones you should have a look on this implementation. You must use it as the first base class @@ -38,9 +38,9 @@ namespace framework{ *//*-*************************************************************************************************************/ struct TransactionBase { - //------------------------------------------------------------------------------------------------------------- + // public member - //------------------------------------------------------------------------------------------------------------- + public: mutable TransactionManager m_aTransactionManager ; /// "your" public manager-member! diff --git a/framework/inc/threadhelp/transactionguard.hxx b/framework/inc/threadhelp/transactionguard.hxx index 858fd9909738..352bdcf87211 100644 --- a/framework/inc/threadhelp/transactionguard.hxx +++ b/framework/inc/threadhelp/transactionguard.hxx @@ -25,7 +25,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement a guard to support non breakable transactions @descr If you wish to support non breakable method calls without lockingf any mutex, rw-lock or something like that - you should use this guard implementation. @@ -44,12 +44,12 @@ namespace framework{ *//*-*************************************************************************************************************/ class TransactionGuard : private INonCopyable { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short ctors @descr Use these ctor methods to initialize the guard right. Given reference must be valid - otherwise crashes could occur! @@ -83,7 +83,7 @@ class TransactionGuard : private INonCopyable } } - /*-************************************************************************************************************//** + /*-************************************************************************************************************ @short dtor @descr We must release the transaction manager and can forget his pointer. @@ -99,7 +99,7 @@ class TransactionGuard : private INonCopyable stop(); } - /*-************************************************************************************************************//** + /*-************************************************************************************************************ @short stop current transaction @descr We must release the transaction manager and can forget his pointer. @@ -123,12 +123,12 @@ class TransactionGuard : private INonCopyable } } - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short disable using of these functions! @descr It's not allowed to use this methods. Different problem can occur otherwise. Thats why we disable it by make it private. @@ -142,9 +142,9 @@ class TransactionGuard : private INonCopyable *//*-*****************************************************************************************************/ TransactionGuard(); - //------------------------------------------------------------------------------------------------------------- + // private member - //------------------------------------------------------------------------------------------------------------- + private: ITransactionManager* m_pManager ; /// pointer to safed transaction manager diff --git a/framework/inc/threadhelp/transactionmanager.hxx b/framework/inc/threadhelp/transactionmanager.hxx index 4f029aa5fd00..104b9fddb24d 100644 --- a/framework/inc/threadhelp/transactionmanager.hxx +++ b/framework/inc/threadhelp/transactionmanager.hxx @@ -34,7 +34,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement a transaction manager to support non breakable interface methods @descr Use it to support non breakable interface methods without using any thread synchronization like e.g. mutex, rw-lock! @@ -51,9 +51,9 @@ namespace framework{ class FWI_DLLPUBLIC TransactionManager : public ITransactionManager , private INonCopyable { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: TransactionManager ( ); @@ -64,16 +64,16 @@ class FWI_DLLPUBLIC TransactionManager : public ITransactionManager virtual void registerTransaction ( EExceptionMode eMode, ERejectReason& eReason ) throw( css::uno::RuntimeException, css::lang::DisposedException ); virtual void unregisterTransaction ( ) throw( css::uno::RuntimeException, css::lang::DisposedException ); - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: void impl_throwExceptions( EExceptionMode eMode, ERejectReason eReason ) const throw( css::uno::RuntimeException, css::lang::DisposedException ); - //------------------------------------------------------------------------------------------------------------- + // private member - //------------------------------------------------------------------------------------------------------------- + private: mutable ::osl::Mutex m_aAccessLock ; /// regulate access on internal member of this instance diff --git a/framework/inc/threadhelp/writeguard.hxx b/framework/inc/threadhelp/writeguard.hxx index faf123086ca9..74ba3c606b20 100644 --- a/framework/inc/threadhelp/writeguard.hxx +++ b/framework/inc/threadhelp/writeguard.hxx @@ -26,7 +26,7 @@ namespace framework{ -/*-************************************************************************************************************//** +/*-************************************************************************************************************ @short implement a guard to set write locks @descr This guard should be used to set a lock for reading AND writing object internal member. We never need a own mutex to safe our internal member access - because @@ -43,12 +43,12 @@ namespace framework{ *//*-*************************************************************************************************************/ class WriteGuard : private INonCopyable { - //------------------------------------------------------------------------------------------------------------- + // public methods - //------------------------------------------------------------------------------------------------------------- + public: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short ctor @descr These ctors initialize the guard with a reference to used lock member of object to protect. Null isn't allowed as value! @@ -68,7 +68,7 @@ class WriteGuard : private INonCopyable lock(); } - //********************************************************************************************************* + inline WriteGuard( IRWLock& rLock ) : m_pLock ( &rLock ) , m_eMode ( E_NOLOCK ) @@ -76,7 +76,7 @@ class WriteGuard : private INonCopyable lock(); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short dtor @descr We unlock the used lock member automaticly if user forget it. @@ -92,7 +92,7 @@ class WriteGuard : private INonCopyable unlock(); } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short set write lock @descr Call this method to set the write lock. The call will block till all current threads are synchronized! @@ -126,7 +126,7 @@ class WriteGuard : private INonCopyable } } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short unset write lock @descr Call this method to unlock the rw-lock temp.! Normaly we do it at dtor automaticly for you ... @@ -158,7 +158,7 @@ class WriteGuard : private INonCopyable } } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short downgrade write access to read access without new blocking! @descr If this write lock is set you can change it to a "read lock". An "upgrade" is the same like new calling "lock()"! @@ -179,7 +179,7 @@ class WriteGuard : private INonCopyable } } - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short return internal states @descr For user they dont know what they are doing ... @@ -195,12 +195,12 @@ class WriteGuard : private INonCopyable return m_eMode; } - //------------------------------------------------------------------------------------------------------------- + // private methods - //------------------------------------------------------------------------------------------------------------- + private: - /*-****************************************************************************************************//** + /*-**************************************************************************************************** @short disable using of these functions! @descr It's not allowed to use this methods. Different problem can occur otherwise. Thats why we disable it by make it private. @@ -214,9 +214,9 @@ class WriteGuard : private INonCopyable *//*-*****************************************************************************************************/ WriteGuard(); - //------------------------------------------------------------------------------------------------------------- + // private member - //------------------------------------------------------------------------------------------------------------- + private: IRWLock* m_pLock ; /// reference to lock-member of protected object diff --git a/framework/inc/uielement/itemcontainer.hxx b/framework/inc/uielement/itemcontainer.hxx index 346caff49e87..95ba6d34c5bf 100644 --- a/framework/inc/uielement/itemcontainer.hxx +++ b/framework/inc/uielement/itemcontainer.hxx @@ -49,9 +49,9 @@ class FWI_DLLPUBLIC ItemContainer : public ::cppu::WeakImplHelper1< ::com::sun ItemContainer( const com::sun::star::uno::Reference< com::sun::star::container::XIndexAccess >& rItemAccessContainer, const ShareableMutex& rMutex ); virtual ~ItemContainer(); - //--------------------------------------------------------------------------------------------------------- + // XInterface, XTypeProvider - //--------------------------------------------------------------------------------------------------------- + // XUnoTunnel static const ::com::sun::star::uno::Sequence< sal_Int8 >& GetUnoTunnelId() throw(); static ItemContainer* GetImplementation( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& rxIFace ) throw(); diff --git a/framework/inc/uielement/menubarwrapper.hxx b/framework/inc/uielement/menubarwrapper.hxx index dabe2b960edd..0cb648ab2839 100644 --- a/framework/inc/uielement/menubarwrapper.hxx +++ b/framework/inc/uielement/menubarwrapper.hxx @@ -43,9 +43,9 @@ class MenuBarWrapper : public UIConfigElementWrapperBase, const com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext >& xContext ); virtual ~MenuBarWrapper(); - //--------------------------------------------------------------------------------------------------------- + // XInterface, XTypeProvider - //--------------------------------------------------------------------------------------------------------- + FWK_DECLARE_XINTERFACE FWK_DECLARE_XTYPEPROVIDER diff --git a/framework/inc/uielement/progressbarwrapper.hxx b/framework/inc/uielement/progressbarwrapper.hxx index b67391487027..0d883d0b36f5 100644 --- a/framework/inc/uielement/progressbarwrapper.hxx +++ b/framework/inc/uielement/progressbarwrapper.hxx @@ -37,9 +37,9 @@ namespace framework{ class ProgressBarWrapper : public UIElementWrapperBase { public: - //--------------------------------------------------------------------------------------------------------- + // constructor / destructor - //--------------------------------------------------------------------------------------------------------- + ProgressBarWrapper(); virtual ~ProgressBarWrapper(); @@ -67,10 +67,10 @@ class ProgressBarWrapper : public UIElementWrapperBase // XUIElement virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getRealInterface() throw (::com::sun::star::uno::RuntimeException, std::exception); - //------------------------------------------------------------------------------------------------------------- + // variables // (should be private everyway!) - //------------------------------------------------------------------------------------------------------------- + private: ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindow > m_xStatusBar; // Reference to our status bar XWindow ::com::sun::star::uno::WeakReference< ::com::sun::star::uno::XInterface > m_xProgressBarIfacWrapper; diff --git a/framework/inc/uielement/rootitemcontainer.hxx b/framework/inc/uielement/rootitemcontainer.hxx index 0646d0db1f44..3403975d36e1 100644 --- a/framework/inc/uielement/rootitemcontainer.hxx +++ b/framework/inc/uielement/rootitemcontainer.hxx @@ -61,7 +61,7 @@ class RootItemContainer : protected ThreadHelpBase FWI_DLLPUBLIC RootItemContainer( const com::sun::star::uno::Reference< com::sun::star::container::XIndexAccess >& rItemAccessContainer ); virtual FWI_DLLPUBLIC ~RootItemContainer(); - //--------------------------------------------------------------------------------------------------------- + // XInterface virtual void SAL_CALL acquire() throw () { OWeakObject::acquire(); } diff --git a/framework/inc/uielement/statusindicatorinterfacewrapper.hxx b/framework/inc/uielement/statusindicatorinterfacewrapper.hxx index 28e83de40933..c4fcfbe2d96d 100644 --- a/framework/inc/uielement/statusindicatorinterfacewrapper.hxx +++ b/framework/inc/uielement/statusindicatorinterfacewrapper.hxx @@ -43,9 +43,9 @@ class StatusIndicatorInterfaceWrapper : public ::cppu::WeakImplHelper1< ::com: StatusIndicatorInterfaceWrapper( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XComponent >& rStatusIndicatorImpl ); virtual ~StatusIndicatorInterfaceWrapper(); - //--------------------------------------------------------------------------------------------------------- + // XStatusIndicator - //--------------------------------------------------------------------------------------------------------- + virtual void SAL_CALL start ( const OUString& sText , sal_Int32 nRange ) throw( ::com::sun::star::uno::RuntimeException, std::exception ); virtual void SAL_CALL end ( ) throw( ::com::sun::star::uno::RuntimeException, std::exception ); diff --git a/framework/inc/uielement/toolbarwrapper.hxx b/framework/inc/uielement/toolbarwrapper.hxx index 4cf6318bfe1e..e8393e4dc507 100644 --- a/framework/inc/uielement/toolbarwrapper.hxx +++ b/framework/inc/uielement/toolbarwrapper.hxx @@ -66,9 +66,9 @@ class ToolBarWrapper : public ::com::sun::star::ui::XUIFunctionListener, using cppu::OPropertySetHelper::disposing; virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& aEvent ) throw (::com::sun::star::uno::RuntimeException, std::exception); - //------------------------------------------------------------------------------------------------------------- + // protected methods - //------------------------------------------------------------------------------------------------------------- + protected: virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const com::sun::star::uno::Any& aValue ) throw( com::sun::star::uno::Exception, std::exception ); virtual void impl_fillNewData(); diff --git a/framework/inc/uifactory/factoryconfiguration.hxx b/framework/inc/uifactory/factoryconfiguration.hxx index d74bcd8e12e1..6f3c8ed56af8 100644 --- a/framework/inc/uifactory/factoryconfiguration.hxx +++ b/framework/inc/uifactory/factoryconfiguration.hxx @@ -35,16 +35,16 @@ #include <cppuhelper/implbase1.hxx> #include <rtl/ustring.hxx> -//_________________________________________________________________________________________________________________ + // Namespace -//_________________________________________________________________________________________________________________ + namespace framework { -//***************************************************************************************************************** + // Configuration access class for PopupMenuControllerFactory implementation -//***************************************************************************************************************** + class ConfigurationAccess_ControllerFactory : // interfaces private ThreadHelpBase, public ::cppu::WeakImplHelper1< ::com::sun::star::container::XContainerListener> diff --git a/framework/inc/xml/acceleratorconfigurationreader.hxx b/framework/inc/xml/acceleratorconfigurationreader.hxx index f9364a3c5d1a..19f930a3e0c2 100644 --- a/framework/inc/xml/acceleratorconfigurationreader.hxx +++ b/framework/inc/xml/acceleratorconfigurationreader.hxx @@ -39,12 +39,12 @@ namespace framework{ class AcceleratorConfigurationReader : private ThreadHelpBase , public ::cppu::WeakImplHelper1< css::xml::sax::XDocumentHandler > { - //------------------------------------------- + // const, types private: - //--------------------------------------- + /** @short classification of XML elements. */ enum EXMLElement { @@ -52,7 +52,7 @@ class AcceleratorConfigurationReader : private ThreadHelpBase E_ELEMENT_ITEM }; - //--------------------------------------- + /** @short classification of XML attributes. */ enum EXMLAttribute { @@ -64,7 +64,7 @@ class AcceleratorConfigurationReader : private ThreadHelpBase E_ATTRIBUTE_URL }; - //--------------------------------------- + /** @short some namespace defines */ enum EAcceleratorXMLNamespace { @@ -72,31 +72,31 @@ class AcceleratorConfigurationReader : private ThreadHelpBase E_NAMESPACE_XLINK }; - //------------------------------------------- + // member private: - //--------------------------------------- + /** @short needed to read the xml configuration. */ css::uno::Reference< css::xml::sax::XDocumentHandler > m_xReader; - //--------------------------------------- + /** @short reference to the outside container, where this reader/writer must work on. */ AcceleratorCache& m_rContainer; - //--------------------------------------- + /** @short used to detect if an accelerator list occurs recursive inside xml. */ sal_Bool m_bInsideAcceleratorList; - //--------------------------------------- + /** @short used to detect if an accelerator item occurs recursive inside xml. */ sal_Bool m_bInsideAcceleratorItem; - //--------------------------------------- + /** @short is used to map key codes to its string representation. @@ -105,7 +105,7 @@ class AcceleratorConfigurationReader : private ThreadHelpBase alive forever ...*/ ::salhelper::SingletonRef< KeyMapping > m_rKeyMapping; - //--------------------------------------- + /** @short provide information about the parsing state. @descr We use it to find out the line and column, where @@ -113,12 +113,12 @@ class AcceleratorConfigurationReader : private ThreadHelpBase */ css::uno::Reference< css::xml::sax::XLocator > m_xLocator; - //------------------------------------------- + // interface public: - //--------------------------------------- + /** @short connect this new reader/writer instance to an outside container, which should be used flushed to the underlying XML configuration or @@ -129,11 +129,11 @@ class AcceleratorConfigurationReader : private ThreadHelpBase */ AcceleratorConfigurationReader(AcceleratorCache& rContainer); - //--------------------------------------- + /** @short does nothing real ... */ virtual ~AcceleratorConfigurationReader(); - //--------------------------------------- + // XDocumentHandler virtual void SAL_CALL startDocument() throw(css::xml::sax::SAXException, @@ -169,20 +169,20 @@ class AcceleratorConfigurationReader : private ThreadHelpBase throw(css::xml::sax::SAXException, css::uno::RuntimeException, std::exception ); - //------------------------------------------- + // helper private: - //--------------------------------------- + /** TODO document me */ static EXMLElement implst_classifyElement(const OUString& sElement); - //--------------------------------------- + /** TODO document me */ static EXMLAttribute implst_classifyAttribute(const OUString& sAttribute); - //--------------------------------------- + /** TODO document me */ OUString implts_getErrorLineString(); }; diff --git a/framework/inc/xml/acceleratorconfigurationwriter.hxx b/framework/inc/xml/acceleratorconfigurationwriter.hxx index e0119b729b63..00190cbfe381 100644 --- a/framework/inc/xml/acceleratorconfigurationwriter.hxx +++ b/framework/inc/xml/acceleratorconfigurationwriter.hxx @@ -34,21 +34,21 @@ namespace framework{ class AcceleratorConfigurationWriter : private ThreadHelpBase { - //------------------------------------------- + // member private: - //--------------------------------------- + /** @short needed to write the xml configuration. */ css::uno::Reference< css::xml::sax::XDocumentHandler > m_xConfig; - //--------------------------------------- + /** @short reference to the outside container, where this writer must work on. */ const AcceleratorCache& m_rContainer; - //--------------------------------------- + /** @short is used to map key codes to its string representation. @@ -57,12 +57,12 @@ class AcceleratorConfigurationWriter : private ThreadHelpBase alive forever ...*/ ::salhelper::SingletonRef< KeyMapping > m_rKeyMapping; - //------------------------------------------- + // interface public: - //--------------------------------------- + /** @short connect this new writer instance to an outside container, which should be flushed to the underlying XML configuration. @@ -76,20 +76,20 @@ class AcceleratorConfigurationWriter : private ThreadHelpBase AcceleratorConfigurationWriter(const AcceleratorCache& rContainer, const css::uno::Reference< css::xml::sax::XDocumentHandler >& xConfig ); - //--------------------------------------- + /** @short does nothing real ... */ virtual ~AcceleratorConfigurationWriter(); - //--------------------------------------- + /** @short TODO */ virtual void flush(); - //------------------------------------------- + // helper private: - //--------------------------------------- + /** @short TODO */ void impl_ts_writeKeyCommandPair(const css::awt::KeyEvent& aKey , const OUString& sCommand, diff --git a/framework/inc/xml/imagesdocumenthandler.hxx b/framework/inc/xml/imagesdocumenthandler.hxx index 5f23c809bd62..3791b3f99ee0 100644 --- a/framework/inc/xml/imagesdocumenthandler.hxx +++ b/framework/inc/xml/imagesdocumenthandler.hxx @@ -34,7 +34,7 @@ namespace framework{ -//***************************************************************************************************************** + // Hash code function for using in all hash maps of follow implementation. class OReadImagesDocumentHandler : private ThreadHelpBase, // Struct for right initalization of lock member! Must be first of baseclasses. diff --git a/framework/inc/xml/statusbardocumenthandler.hxx b/framework/inc/xml/statusbardocumenthandler.hxx index d5b6cf79b3b7..b9cd3509376f 100644 --- a/framework/inc/xml/statusbardocumenthandler.hxx +++ b/framework/inc/xml/statusbardocumenthandler.hxx @@ -34,7 +34,7 @@ namespace framework{ -//***************************************************************************************************************** + // Hash code function for using in all hash maps of follow implementation. class FWE_DLLPUBLIC OReadStatusBarDocumentHandler : private ThreadHelpBase, // Struct for right initalization of lock member! Must be first of baseclasses. diff --git a/framework/inc/xml/toolboxdocumenthandler.hxx b/framework/inc/xml/toolboxdocumenthandler.hxx index 22a4b4e650a6..f57ce625a9fe 100644 --- a/framework/inc/xml/toolboxdocumenthandler.hxx +++ b/framework/inc/xml/toolboxdocumenthandler.hxx @@ -33,7 +33,7 @@ namespace framework{ -//***************************************************************************************************************** + // Hash code function for using in all hash maps of follow implementation. class FWE_DLLPUBLIC OReadToolBoxDocumentHandler : private ThreadHelpBase, // Struct for right initalization of lock member! Must be first of baseclasses. |