blob: 66f25119d60c3d1a02d712d9fddc982ad6fa9b1f (
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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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_CLASSES_FRAMECONTAINER_HXX_
#define __FRAMEWORK_CLASSES_FRAMECONTAINER_HXX_
/** Attention: stl headers must(!) be included at first. Otherwhise it can make trouble
with solaris headers ...
*/
#include <vector>
#include <stdexcept>
#include <algorithm>
#include <threadhelp/threadhelpbase.hxx>
#include <threadhelp/transactionbase.hxx>
#include <macros/debug.hxx>
#include <general.h>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/frame/XDesktop.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include <cppuhelper/weakref.hxx>
#include <rtl/ustring.hxx>
#include <vcl/evntpost.hxx>
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework{
//_________________________________________________________________________________________________________________
// exported const
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// exported definitions
//_________________________________________________________________________________________________________________
typedef ::std::vector< css::uno::Reference< css::frame::XFrame > > TFrameContainer ;
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
of this class, which is a member of a frame, task or desktop! You can append and remove frames.
It's possible to set one of these frames as active or deactive. You could have full index-access to
container-items.
@base ThreadHelpBase
guarantee right initialized lock member during boostrap!
@devstatus ready to use
@threadsafe yes
*//*-*************************************************************************************************************/
class FrameContainer : private ThreadHelpBase
{
//_______________________________________
// member
private:
/// list to hold all frames
TFrameContainer m_aContainer;
/// one container item can be the current active frame. Its neccessary for Desktop or Frame implementation.
css::uno::Reference< css::frame::XFrame > m_xActiveFrame;
//_______________________________________
// interface
public:
/// constructor / destructor
FrameContainer();
virtual ~FrameContainer();
/// add/remove/mark container items
void append ( const css::uno::Reference< css::frame::XFrame >& xFrame );
void remove ( const css::uno::Reference< css::frame::XFrame >& xFrame );
void setActive ( const css::uno::Reference< css::frame::XFrame >& xFrame );
css::uno::Reference< css::frame::XFrame > getActive ( ) const;
/// checks and free memory
sal_Bool exist ( const css::uno::Reference< css::frame::XFrame >& xFrame ) const;
void clear ( );
/// deprecated IndexAccess!
sal_uInt32 getCount ( ) const;
css::uno::Reference< css::frame::XFrame > operator[]( sal_uInt32 nIndex ) const;
/// replacement for deprectaed index access
css::uno::Sequence< css::uno::Reference< css::frame::XFrame > > getAllElements() const;
/// special helper for Frame::findFrame()
css::uno::Reference< css::frame::XFrame > searchOnAllChildrens ( const ::rtl::OUString& sName ) const;
css::uno::Reference< css::frame::XFrame > searchOnDirectChildrens( const ::rtl::OUString& sName ) const;
}; // class FrameContainer
} // namespace framework
#endif // #ifndef __FRAMEWORK_CLASSES_FRAMECONTAINER_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
