diff options
Diffstat (limited to 'framework')
-rw-r--r-- | framework/inc/classes/taskcreator.hxx | 10 | ||||
-rw-r--r-- | framework/inc/helper/oframes.hxx | 52 |
2 files changed, 31 insertions, 31 deletions
diff --git a/framework/inc/classes/taskcreator.hxx b/framework/inc/classes/taskcreator.hxx index 9bca42869e53..e67a71c83a07 100644 --- a/framework/inc/classes/taskcreator.hxx +++ b/framework/inc/classes/taskcreator.hxx @@ -30,15 +30,15 @@ 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. It's not easy to service this code! - Thats the reason for this helper. He capsulate asynchronous/synchronous creation by calling - a simple interface. + @descr There are different places to create new (task)frames and it's not easy to service this code. + That's the reason for this helper. It encapsulates asynchronous/synchronous creation + by providing a simple interface. @devstatus ready to use @threadsafe yes -*//*-*************************************************************************************************************/ +*/ class TaskCreator { diff --git a/framework/inc/helper/oframes.hxx b/framework/inc/helper/oframes.hxx index 2b35afe52735..9f82c478a186 100644 --- a/framework/inc/helper/oframes.hxx +++ b/framework/inc/helper/oframes.hxx @@ -34,7 +34,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 our owner. The framecontainer is a member of it from type "FrameContainer". That means; @@ -52,24 +52,24 @@ namespace framework{ We hold a weakreference to our owner not to our superclass. @devstatus deprecated -*//*-*************************************************************************************************************/ +*/ class OFrames : public ::cppu::WeakImplHelper< css::frame::XFrames > { 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. @param xOwner , reference to our owner. We hold a wekreference to prevent us against cross-references! @param pFrameContainer , pointer to shared framecontainer of owner. It's valid only, if weakreference is valid! - *//*-*****************************************************************************************************/ + */ OFrames( const css::uno::Reference< css::frame::XFrame >& xOwner , FrameContainer* pFrameContainer ); // XFrames - /*-**************************************************************************************************** + /* @short append frame to container @descr We share the container with our owner. We can do this only, if no lock is set on container. Valid references are accepted only! @@ -78,10 +78,10 @@ class OFrames : public ::cppu::WeakImplHelper< css::frame::XFrames > @param "xFrame", reference to an existing frame to append. @onerror We do nothing in release or throw an assert in debug version. - *//*-*****************************************************************************************************/ + */ virtual void SAL_CALL append( const css::uno::Reference< css::frame::XFrame >& xFrame ) throw( css::uno::RuntimeException, std::exception ) override; - /*-**************************************************************************************************** + /* @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. @@ -90,22 +90,22 @@ class OFrames : public ::cppu::WeakImplHelper< css::frame::XFrames > @param "xFrame", reference to an existing frame to remove. @onerror We do nothing in release or throw an assert in debug version. - *//*-*****************************************************************************************************/ + */ virtual void SAL_CALL remove( const css::uno::Reference< css::frame::XFrame >& xFrame ) throw( css::uno::RuntimeException, std::exception ) override; - /*-**************************************************************************************************** + /* @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. @param "nSearchFlag", flags to search right frames. @return A list of founded frames. @onerror An empty list is returned. - *//*-*****************************************************************************************************/ + */ virtual css::uno::Sequence< css::uno::Reference< css::frame::XFrame > > SAL_CALL queryFrames( sal_Int32 nSearchFlags ) throw( css::uno::RuntimeException, std::exception ) override; // 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! @@ -115,10 +115,10 @@ class OFrames : public ::cppu::WeakImplHelper< css::frame::XFrames > @return Count of current items in container. @onerror If a lock is set, we return 0 for prevent further access! - *//*-*****************************************************************************************************/ + */ virtual sal_Int32 SAL_CALL getCount() throw( css::uno::RuntimeException, std::exception ) override; - /*-**************************************************************************************************** + /* @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. @@ -131,22 +131,22 @@ class OFrames : public ::cppu::WeakImplHelper< css::frame::XFrames > @onerror If a lock is set, we return an empty Any! @onerror If index out of range, an IndexOutOfBoundsException is thrown. - *//*-*****************************************************************************************************/ + */ virtual css::uno::Any SAL_CALL getByIndex( sal_Int32 nIndex ) throw( css::lang::IndexOutOfBoundsException , css::lang::WrappedTargetException , css::uno::RuntimeException, std::exception ) override; // XElementAccess - /*-**************************************************************************************************** + /* @short get uno-type of all container items @descr In current implementation type is fixed to XFrame! (container-lock is ignored) @return A uno-type descriptor. - *//*-*****************************************************************************************************/ + */ virtual css::uno::Type SAL_CALL getElementType() throw( css::uno::RuntimeException, std::exception ) override; - /*-**************************************************************************************************** + /* @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) @@ -154,20 +154,20 @@ class OFrames : public ::cppu::WeakImplHelper< css::frame::XFrames > @return sal_False, otherwise. @onerror We return sal_False. - *//*-*****************************************************************************************************/ + */ virtual sal_Bool SAL_CALL hasElements() throw( css::uno::RuntimeException, std::exception ) override; protected: - /*-**************************************************************************************************** + /* @short standard destructor @descr This method destruct an instance of this class and clear some member. This method is protected, because it's not allowed to use this class as a member! You MUST use a dynamical instance (pointer). That's the reason for a protected dtor. - *//*-*****************************************************************************************************/ + */ virtual ~OFrames() override; - /*-**************************************************************************************************** + /* @short reset instance to default values @descr There are two ways to delete an instance of this class.<BR> 1) delete with destructor<BR> @@ -176,12 +176,12 @@ class OFrames : public ::cppu::WeakImplHelper< css::frame::XFrames > @seealso method dispose() (if it exist!) @seealso destructor ~TaskEnumeration() - *//*-*****************************************************************************************************/ + */ void impl_resetObject(); private: - /*-**************************************************************************************************** + /* @short append one sequence to another @descr There is no operation to add to sequences! Use this helper-method to do this. @@ -190,14 +190,14 @@ class OFrames : public ::cppu::WeakImplHelper< css::frame::XFrames > @param "seqDestination", reference to sequence on which operation will append the other sequence. @param "seqSource" , reference to sequence for append. @return "seqDestination" is parameter AND return value at the same time. - *//*-*****************************************************************************************************/ + */ void impl_appendSequence( css::uno::Sequence< css::uno::Reference< css::frame::XFrame > >& seqDestination , const css::uno::Sequence< css::uno::Reference< css::frame::XFrame > >& seqSource ); // 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(...). @@ -207,7 +207,7 @@ class OFrames : public ::cppu::WeakImplHelper< css::frame::XFrames > @param references to checking variables @return sal_False ,on invalid parameter @return sal_True ,otherwise - *//*-*****************************************************************************************************/ + */ private: static bool impldbg_checkParameter_OFramesCtor ( const css::uno::Reference< css::frame::XFrame >& xOwner , |