ca00697e3d
2009-08-21 15:08:49 +0200 oj r275263 : wrong check 2009-08-21 08:56:01 +0200 oj r275215 : missing not 2009-08-20 07:27:13 +0200 oj r275164 : use new method from global 2009-08-19 10:22:35 +0200 oj r275138 : call GetLocale instead of pLocale 2009-08-18 10:39:32 +0200 oj r275082 : missing header include 2009-08-18 10:09:44 +0200 oj r275081 : new methods at global 2009-08-18 10:09:00 +0200 oj r275080 : unused var 2009-08-18 08:59:04 +0200 oj r275078 : move files from classes to xml 2009-08-17 14:58:16 +0200 oj r275056 : CWS-TOOLING: rebase CWS oj18 to trunk@275001 (milestone: DEV300:m55) 2009-08-17 13:29:44 +0200 oj r275047 : compile error 2009-08-17 13:27:47 +0200 oj r275045 : compile error 2009-08-17 11:44:54 +0200 oj r275040 : add dep 2009-07-22 14:26:05 +0200 oj r274240 : move unused services into fwl 2009-07-22 14:25:35 +0200 oj r274239 : move unused services into fwl 2009-07-22 13:47:45 +0200 oj r274233 : remove some unused code 2009-07-22 09:06:20 +0200 oj r274219 : export dbtoolsclient dbcharsethelper for sc 2009-07-22 08:48:58 +0200 oj r274218 : create NumberFormatter on demand 2009-07-22 08:39:23 +0200 oj r274217 : change char to sal_Char 2009-07-22 07:33:34 +0200 oj r274214 : export dbtoolsclient dbcharsethelper for sc 2009-07-22 07:30:04 +0200 oj r274213 : late init of numberformatter and breakiterator 2009-07-22 07:28:55 +0200 oj r274212 : export dbtoolsclient dbcharsethelper for sc 2009-07-21 13:43:28 +0200 oj r274196 : check if quick start is enbaled 2009-07-21 13:40:09 +0200 oj r274195 : check config entry for UiEventsLogger 2009-07-21 13:37:40 +0200 oj r274194 : code refactoring, remove of duplicate code and some late inits and removale of not needed files 2009-07-21 13:35:38 +0200 oj r274193 : code refactoring, remove of duplicate code and some late inits and removale of not needed files 2009-07-21 13:33:41 +0200 oj r274192 : doc meta data will now be created on demand 2009-07-21 13:13:40 +0200 oj r274187 : load ldap functions on demand 2009-07-21 13:03:17 +0200 oj r274183 : late init of TransliterationImpl 2009-07-21 12:36:10 +0200 oj r274180 : late init of charClass
265 lines
13 KiB
C++
265 lines
13 KiB
C++
/*************************************************************************
|
|
*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* Copyright 2008 by Sun Microsystems, Inc.
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: ocomponentenumeration.hxx,v $
|
|
* $Revision: 1.7 $
|
|
*
|
|
* This file is part of OpenOffice.org.
|
|
*
|
|
* OpenOffice.org is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License version 3
|
|
* only, as published by the Free Software Foundation.
|
|
*
|
|
* OpenOffice.org is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License version 3 for more details
|
|
* (a copy is included in the LICENSE file that accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* version 3 along with OpenOffice.org. If not, see
|
|
* <http://www.openoffice.org/license.html>
|
|
* for a copy of the LGPLv3 License.
|
|
*
|
|
************************************************************************/
|
|
|
|
#ifndef __FRAMEWORK_HELPER_OCOMPONENTENUMERATION_HXX_
|
|
#define __FRAMEWORK_HELPER_OCOMPONENTENUMERATION_HXX_
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// my own includes
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
#ifndef __FRAMEWORK_OMUTEXMEMBER_HXX_
|
|
#include <threadhelp/threadhelpbase.hxx>
|
|
#endif
|
|
#include <macros/generic.hxx>
|
|
#include <macros/xinterface.hxx>
|
|
#include <macros/xtypeprovider.hxx>
|
|
#include <macros/debug.hxx>
|
|
#include <general.h>
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// interface includes
|
|
//_________________________________________________________________________________________________________________
|
|
#include <com/sun/star/lang/XEventListener.hpp>
|
|
#include <com/sun/star/container/XEnumeration.hpp>
|
|
#include <com/sun/star/lang/XComponent.hpp>
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// other includes
|
|
//_________________________________________________________________________________________________________________
|
|
#include <cppuhelper/implbase2.hxx>
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// namespace
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
namespace framework{
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// exported const
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// exported definitions
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
/*-************************************************************************************************************//**
|
|
@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.
|
|
You cant use this as a baseclass. Please use it as a dynamical object for return.
|
|
|
|
@implements XInterface
|
|
XTypeProvider
|
|
XEventListener
|
|
XEnumeration
|
|
|
|
@base ThreadHelpBase
|
|
OWeakObject
|
|
|
|
@devstatus ready to use
|
|
@threadsafe yes
|
|
*//*-*************************************************************************************************************/
|
|
|
|
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.
|
|
|
|
@seealso -
|
|
|
|
@param "seqComponents" is a sequence of interfaces, which are components.
|
|
@return -
|
|
|
|
@onerror Do nothing and reset this object to default with an empty list.
|
|
*//*-*****************************************************************************************************/
|
|
|
|
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 completly and has no more elements.
|
|
Then we must destroy ouer list and release all references to other objects.
|
|
|
|
@seealso interface XEventListener
|
|
|
|
@param "aEvent" describe the source of this event.
|
|
@return -
|
|
|
|
@onerror -
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual void SAL_CALL disposing( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException );
|
|
|
|
//---------------------------------------------------------------------------------------------------------
|
|
// 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!
|
|
|
|
@seealso interface XEnumeration
|
|
|
|
@param -
|
|
@return sal_True = if more elements accessible<BR>
|
|
sal_False = other way
|
|
|
|
@onerror sal_False<BR>
|
|
(List is emtpy and there no accessible elements ...)
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual sal_Bool SAL_CALL hasMoreElements() throw( css::uno::RuntimeException );
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short give the next element, if some exist
|
|
@descr If a call "hasMoreElements()" return true, you can get the next element of list.
|
|
|
|
@seealso interface XEnumeration
|
|
|
|
@param -
|
|
@return A Reference to a component, safed in an Any-structure.
|
|
|
|
@onerror If end of enumeration is arrived or there are no elements in list => a NoSuchElementException is thrown.
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual css::uno::Any SAL_CALL nextElement() throw( css::container::NoSuchElementException ,
|
|
css::lang::WrappedTargetException ,
|
|
css::uno::RuntimeException );
|
|
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
// 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!
|
|
You must create it dynamical in memory and use a pointer.
|
|
|
|
@seealso -
|
|
|
|
@param -
|
|
@return -
|
|
|
|
@onerror -
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual ~OComponentEnumeration();
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short reset instance to default values
|
|
|
|
@descr There are two ways to delete an instance of this class.<BR>
|
|
1) delete with destructor<BR>
|
|
2) dispose from parent or factory ore ...<BR>
|
|
This method do the same for both ways! It free used memory and release references ...
|
|
|
|
@seealso method dispose()
|
|
@seealso destructor ~TaskEnumeration()
|
|
|
|
@param -
|
|
|
|
@return -
|
|
|
|
@onerror -
|
|
*//*-*****************************************************************************************************/
|
|
|
|
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(...).
|
|
|
|
@seealso ASSERT in implementation!
|
|
|
|
@param references to checking variables
|
|
@return sal_False on invalid parameter<BR>
|
|
sal_True otherway
|
|
|
|
@onerror -
|
|
*//*-*****************************************************************************************************/
|
|
|
|
#ifdef ENABLE_ASSERTIONS
|
|
|
|
private:
|
|
|
|
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 );
|
|
|
|
#endif // #ifdef ENABLE_ASSERTIONS
|
|
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
// variables
|
|
// (should be private everyway!)
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
|
|
private:
|
|
|
|
sal_uInt32 m_nPosition ; /// current position in enumeration
|
|
css::uno::Sequence< css::uno::Reference< css::lang::XComponent > > m_seqComponents ; /// list of current components
|
|
|
|
}; // class OComponentEnumeration
|
|
|
|
} // namespace framework
|
|
|
|
#endif // #ifndef __FRAMEWORK_HELPER_OCOMPONENTENUMERATION_HXX_
|