blob: 10de97dd580623a3ac4f1741c20cdc724e0b2efb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_FRAMEWORK_INC_HELPER_OCOMPONENTENUMERATION_HXX
#define INCLUDED_FRAMEWORK_INC_HELPER_OCOMPONENTENUMERATION_HXX
#include <com/sun/star/lang/XEventListener.hpp>
#include <com/sun/star/container/XEnumeration.hpp>
#include <com/sun/star/lang/XComponent.hpp>
#include <cppuhelper/implbase.hxx>
#include <vector>
namespace framework{
/*-************************************************************************************************************
@short implement a helper for a oneway enumeration of components
@descr You can step during this list only for one time! It's a snapshot.
Don't forget to release the reference. You are the owner of an instance of this implementation.
You can't use this as a baseclass. Please use it as a dynamical object for return.
@implements XInterface
XTypeProvider
XEventListener
XEnumeration
@base OWeakObject
@devstatus ready to use
@threadsafe yes
*//*-*************************************************************************************************************/
class OComponentEnumeration final : public ::cppu::WeakImplHelper< css::container::XEnumeration,css::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.
@param "seqComponents" is a sequence of interfaces, which are components.
@onerror Do nothing and reset this object to default with an empty list.
*//*-*****************************************************************************************************/
OComponentEnumeration( const std::vector< 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 our list and release all references to other objects.
@seealso interface XEventListener
@param "aEvent" describe the source of this event.
*//*-*****************************************************************************************************/
virtual void SAL_CALL disposing( const css::lang::EventObject& aEvent ) override;
// 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 gotten are not accessible!
@seealso interface XEnumeration
@return sal_True = if more elements accessible<BR>
sal_False = other way
@onerror sal_False<BR>
(List is empty and there no accessible elements ...)
*//*-*****************************************************************************************************/
virtual sal_Bool SAL_CALL hasMoreElements() override;
/*-****************************************************************************************************
@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
@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() override;
// protected methods
private:
/*-****************************************************************************************************
@short standard destructor
@descr This method destruct an instance of this class and clear some member.
We make it protected, because it's not supported to use this class as normal instance!
You must create it dynamical in memory and use a pointer.
*//*-*****************************************************************************************************/
virtual ~OComponentEnumeration() 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>
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()
*//*-*****************************************************************************************************/
void impl_resetObject();
// debug methods
// (should be private everyway!)
/*-****************************************************************************************************
@short debug-method to check incoming parameter of some other methods 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
*//*-*****************************************************************************************************/
sal_uInt32 m_nPosition; /// current position in enumeration
std::vector< css::uno::Reference< css::lang::XComponent > > m_seqComponents; /// list of current components
}; // class OComponentEnumeration
} // namespace framework
#endif // INCLUDED_FRAMEWORK_INC_HELPER_OCOMPONENTENUMERATION_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
