blob: 72a868f66d3403e27b0437e58b553d1e853b96e7 (
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
|
/* -*- 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_CLASSES_FRAMECONTAINER_HXX
#define INCLUDED_FRAMEWORK_INC_CLASSES_FRAMECONTAINER_HXX
#include <sal/config.h>
#include <vector>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include <rtl/ustring.hxx>
namespace framework{
typedef ::std::vector< css::uno::Reference< css::frame::XFrame > > TFrameContainer;
/*-************************************************************************************************************
@short implement a container to hold children of frame, task or desktop
@descr Every object of frame, task or desktop hold reference to its children. These container is used as helper
to do this. Some helper-classes 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 deactivate. You could have full index-access to
container-items.
@devstatus ready to use
@threadsafe yes
*//*-*************************************************************************************************************/
class FrameContainer final
{
// member
private:
/// list to hold all frames
TFrameContainer m_aContainer;
/// one container item can be the current active frame. It's necessary for Desktop or Frame implementation.
css::uno::Reference< css::frame::XFrame > m_xActiveFrame;
// interface
public:
/// constructor / destructor
FrameContainer();
~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
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 deprecated 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 OUString& sName ) const;
css::uno::Reference< css::frame::XFrame > searchOnDirectChildrens( const OUString& sName ) const;
}; // class FrameContainer
} // namespace framework
#endif // INCLUDED_FRAMEWORK_INC_CLASSES_FRAMECONTAINER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
