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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
/*************************************************************************
*
* 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: targetfinder.hxx,v $
* $Revision: 1.10 $
*
* 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_TARGETFINDER_HXX_
#define __FRAMEWORK_CLASSES_TARGETFINDER_HXX_
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
#include <macros/debug.hxx>
#include <macros/generic.hxx>
#include <targets.h>
#include <general.h>
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
#include <com/sun/star/frame/XFrame.hpp>
//_________________________________________________________________________________________________________________
// other includes
//_________________________________________________________________________________________________________________
#include <rtl/ustring.hxx>
//_________________________________________________________________________________________________________________
// const
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework{
//_________________________________________________________________________________________________________________
// declarations
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@short We need some informations about our caller, With these enum he can specify his frame type ...
(Frame/Desktop ...)
*//*-*************************************************************************************************************/
enum EFrameType
{
E_UNKNOWNFRAME ,
E_DESKTOP ,
E_TASK ,
E_FRAME
};
/*-************************************************************************************************************//**
@short valid result values to classify targeting
*//*-*************************************************************************************************************/
enum ETargetClass
{
//-------------------------------------------------------------------------------------------------------------
// useable by classifyFindFrame() and classifyQueryDispatch()
//-------------------------------------------------------------------------------------------------------------
E_UNKNOWN , /// occure if you call us without valid flag combinations!
E_DEFAULT , /// default handling for opening new documents
E_CREATETASK , /// create new task (supported by desktop only!)
E_SELF , /// you are the target himself
E_PARENT , /// your parent is the target
E_BEAMER , /// an existing beamer is the target (create new one if it not already exist!)
E_TASKS , /// special (but exclusiv) search for tasks only (supported at desktop only - but can combined with CREATE!)
E_FORWARD_UP , /// forward call to your parent
E_DEEP_DOWN , /// search at your children (search children of direct children before another direcht children!)
E_FLAT_DOWN , /// search at your children (search at all direct children first; children of direcht children then!)
E_DEEP_BOTH , /// combination of E_DEEP_DOWN and E_FORWARD_UP ( search down first!)
E_FLAT_BOTH , /// combination of E_FLAT_DOWN and E_FORWARD_UP ( search down first!)
//-------------------------------------------------------------------------------------------------------------
// useable by classifyQueryDispatch() only
//-------------------------------------------------------------------------------------------------------------
E_MENUBAR , /// a menu bar is supported by a task only and should be forwarded to her internal dispatch helper! (valid for classifyQueryDispatch() only!)
E_HELPAGENT /// same like menu bar!
};
/*-************************************************************************************************************//**
@short hold information about environment of frame, which use TargetFinder::classify...()
@descr Follow TargetFinder::classify...() methods need some informations about the environment of
a frame to specify search direction. Use methods of this TargetInfo to collect this informations
and use it on classify...().
@implements -
@base -
@devstatus ready to use
@threadsafe not neccessary
*//*-*************************************************************************************************************/
struct TargetInfo
{
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
TargetInfo ( const css::uno::Reference< css::frame::XFrame >& xFrame ,
const ::rtl::OUString& sTarget ,
sal_Int32 nFlags );
TargetInfo ( const ::rtl::OUString& sTarget ,
sal_Int32 nFlags ,
EFrameType eType ,
sal_Bool bChildrens ,
sal_Bool bParent ,
const ::rtl::OUString& sFrame ,
const ::rtl::OUString& sParent );
static EFrameType getFrameType( const css::uno::Reference< css::frame::XFrame >& xFrame );
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
private:
sal_Bool impl_getCreateFlag( sal_Int32 nSearchFlags );
//-------------------------------------------------------------------------------------------------------------
// debug and test methods
//-------------------------------------------------------------------------------------------------------------
#ifdef ENABLE_ASSERTIONS
private:
static sal_Bool implcp_ctor ( const css::uno::Reference< css::frame::XFrame >& xFrame ,
const ::rtl::OUString& sTarget ,
sal_Int32 nFlags );
static sal_Bool implcp_ctor ( const ::rtl::OUString& sTarget ,
sal_Int32 nFlags ,
EFrameType eType ,
sal_Bool bChildrens ,
sal_Bool bParent ,
const ::rtl::OUString& sFrame ,
const ::rtl::OUString& sParent );
static sal_Bool implcp_getFrameType( const css::uno::Reference< css::frame::XFrame >& xFrame );
#endif
//-------------------------------------------------------------------------------------------------------------
// public variables!
// faster access for TargetFinder::classify...()
//-------------------------------------------------------------------------------------------------------------
public:
EFrameType eFrameType ; /// your node type (desktop, task ,frame) Its neccessary to select right search algorithm.
::rtl::OUString sTargetName ; /// is the search parameter to find right frame by name or special value!
sal_Int32 nSearchFlags ; /// is an optional parameter to regulate search direction if no special target name was given.
sal_Bool bChildrenExist ; /// Say us - if some children exist. Otherwise down search is ignored!
::rtl::OUString sFrameName ; /// If SELF flag is set we can break search earlier if this name is the target!
sal_Bool bParentExist ; /// Say us - if a parent exist. Otherwise upper search is ignored!
::rtl::OUString sParentName ; /// If PARENT flag is set we can break search earlier if this name is the target!
sal_Bool bCreationAllowed ; /// we set it TRUE if flag CREATE is set. You must search for given target, but could create a new tree node if search will fail!
}; // struct TargetInfo
/*-************************************************************************************************************//**
@short implement helper to implement code for targeting only one time!
@descr We need checking of a target name in combination with given search flags at differnt places.
These helper analyze the parameter and recommend the direction for searching.
We can use a method to classify search direction and another one to change our search parameter
to make it right. You can use these - but you don't must do it!
@implements -
@base -
@devstatus ready to use
@threadsafe not neccessary
*//*-*************************************************************************************************************/
class TargetFinder
{
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
static ETargetClass classifyFindFrame ( TargetInfo& aInfo );
static ETargetClass classifyQueryDispatch( TargetInfo& aInfo );
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
private:
static ETargetClass impl_classifyForDesktop_findFrame ( sal_Bool bParentExist ,
const ::rtl::OUString& sTargetName ,
sal_Int32 nSearchFlags );
static ETargetClass impl_classifyForTask_findFrame ( sal_Bool bParentExist ,
sal_Bool bChildrenExist ,
const ::rtl::OUString& sFrameName ,
const ::rtl::OUString& sTargetName ,
sal_Int32 nSearchFlags );
static ETargetClass impl_classifyForFrame_findFrame ( sal_Bool bParentExist ,
sal_Bool bChildrenExist ,
const ::rtl::OUString& sFrameName ,
const ::rtl::OUString& sParentName ,
const ::rtl::OUString& sTargetName ,
sal_Int32 nSearchFlags );
//-------------------------------------------------------------------------------------------------------------
// debug and test methods
//-------------------------------------------------------------------------------------------------------------
#ifdef ENABLE_ASSERTIONS
private:
static sal_Bool implcp_classifyFindFrame ( const TargetInfo& aInfo );
static sal_Bool implcp_classifyQueryDispatch( const TargetInfo& aInfo );
#endif
}; // class TargetFinder
} // namespace framework
#endif // #ifndef __FRAMEWORK_CLASSES_TARGETFINDER_HXX_
|
