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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
|
/* -*- 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_SFX2_VIEWSH_HXX
#define INCLUDED_SFX2_VIEWSH_HXX
#include <sal/config.h>
#include <sfx2/dllapi.h>
#include <sal/types.h>
#include <com/sun/star/embed/XEmbeddedObject.hpp>
#include <com/sun/star/frame/XController.hpp>
#include <com/sun/star/view/XRenderable.hpp>
#include <com/sun/star/uno/Reference.h>
#include <svl/lstner.hxx>
#include <com/sun/star/ui/XContextMenuInterceptor.hpp>
#include <com/sun/star/datatransfer/clipboard/XClipboardListener.hpp>
#include <com/sun/star/datatransfer/clipboard/XClipboardNotifier.hpp>
#include <cppuhelper/interfacecontainer.hxx>
#include <sfx2/shell.hxx>
#include <tools/gen.hxx>
#include <tools/errcode.hxx>
#include <vcl/jobset.hxx>
#include <vector>
class SfxBaseController;
class Size;
class Fraction;
class Window;
class KeyEvent;
class WorkWindow;
class SvBorder;
class SdrView;
class SfxFrame;
class SfxMedium;
class SfxModule;
class SfxViewFrame;
class SfxItemPool;
class SfxTabPage;
class SfxFrameSetDescriptor;
class Printer;
class SfxPrinter;
class SfxProgress;
class SfxFrameItem;
class Dialog;
class Menu;
class NotifyEvent;
#define SFX_PRINTER_PRINTER 1 // without JOB SETUP => Temporary
#define SFX_PRINTER_JOBSETUP 2
#define SFX_PRINTER_OPTIONS 4
#define SFX_PRINTER_CHG_ORIENTATION 8
#define SFX_PRINTER_CHG_SIZE 16
#define SFX_PRINTER_ALL 31
#define SFX_PRINTER_CHG_ORIENTATION_FLAG 3
#define SFX_PRINTER_CHG_SIZE_FLAG 4
#define SFX_PRINTERROR_NONE 0
#define SFX_PRINTERROR_BUSY 1
// "Verified" using www.apple.com and Netscape 3.01
#define DEFAULT_MARGIN_WIDTH 8
#define DEFAULT_MARGIN_HEIGHT 12
// @[SfxViewShell-Flags]
#define SFX_VIEW_HAS_PRINTOPTIONS 0x0010 /* Options-Button and Options-
Dialog in PrintDialog */
#define SFX_VIEW_CAN_PRINT 0x0020 /* Printing enabled without having
to create a Printer */
#define SFX_VIEW_NO_SHOW 0x0040 /* Window of the ViewShell shall
not be showed automatically */
#define SFX_VIEW_NO_NEWWINDOW 0x0100 /* Allow N View */
/* [Description]
The SfxViewShell flags control the behavior of SfxViewShell for the
duration of its lifetime. They are defined in the constructor of
<SfxViewShell>.
*/
#define SFX_DECL_VIEWFACTORY(Class) \
private: \
static SfxViewFactory *pFactory; \
public: \
static SfxViewShell *CreateInstance(SfxViewFrame *pFrame, SfxViewShell *pOldView); \
static void RegisterFactory( sal_uInt16 nPrio = USHRT_MAX ); \
static SfxViewFactory&Factory() { return *pFactory; } \
static void InitFactory()
#define SFX_IMPL_NAMED_VIEWFACTORY(Class, AsciiViewName) \
SfxViewFactory* Class::pFactory; \
SfxViewShell* Class::CreateInstance(SfxViewFrame *pFrame, SfxViewShell *pOldView) \
{ return new Class(pFrame, pOldView); } \
void Class::RegisterFactory( sal_uInt16 nPrio ) \
{ \
pFactory = new SfxViewFactory(&CreateInstance,nPrio,AsciiViewName);\
InitFactory(); \
} \
void Class::InitFactory()
#define SFX_VIEW_REGISTRATION(DocClass) \
DocClass::Factory().RegisterViewFactory( Factory() )
class SfxInPlaceClient;
typedef ::std::vector< SfxInPlaceClient* > SfxInPlaceClientList;
class SFX2_DLLPUBLIC SfxViewShell: public SfxShell, public SfxListener
{
#ifdef INCLUDED_SFX2_VIEWSH_HXX
friend class SfxViewFrame;
friend class SfxBaseController;
friend class SfxPrinterController;
#endif
struct SfxViewShell_Impl* pImp;
SfxInPlaceClientList* pIPClientList;
SfxViewFrame* pFrame;
SfxShell* pSubShell;
Window* pWindow;
bool bNoNewWindow;
protected:
virtual void Activate(bool IsMDIActivate) SAL_OVERRIDE;
virtual void Deactivate(bool IsMDIActivate) SAL_OVERRIDE;
virtual void InnerResizePixel( const Point &rOfs, const Size &rSize );
virtual void OuterResizePixel( const Point &rOfs, const Size &rSize );
virtual void SetZoomFactor( const Fraction &rZoomX, const Fraction &rZoomY );
virtual void Move();
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) SAL_OVERRIDE;
public:
// Iteration
static SfxViewShell* GetFirst( const TypeId* pType = 0, bool bOnlyVisible = true );
static SfxViewShell* GetNext( const SfxViewShell& rPrev,
const TypeId* pType = 0, bool bOnlyVisible = true );
static SfxViewShell* Current();
static SfxViewShell* Get( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController>& i_rController );
// Initialize Constructors/Destructors
TYPEINFO_OVERRIDE();
SFX_DECL_INTERFACE(SFX_INTERFACE_SFXVIEWSH)
SfxViewShell( SfxViewFrame *pFrame, sal_uInt16 nFlags = 0 );
virtual ~SfxViewShell();
SfxInPlaceClient* GetIPClient() const;
SfxInPlaceClient* GetUIActiveClient() const;
SfxInPlaceClient* FindIPClient( const ::com::sun::star::uno::Reference < ::com::sun::star::embed::XEmbeddedObject >& xObj, Window *pObjParentWin ) const;
virtual ErrCode DoVerb(long nVerb);
virtual void OutplaceActivated( bool bActive, SfxInPlaceClient* pClient );
virtual void InplaceActivating( SfxInPlaceClient* pClient );
virtual void InplaceDeactivated( SfxInPlaceClient* pClient );
virtual void UIActivating( SfxInPlaceClient* pClient );
virtual void UIDeactivated( SfxInPlaceClient* pClient );
void JumpToMark( const OUString& rMark );
void VisAreaChanged(const Rectangle& rRect);
// Misc
virtual bool PrepareClose( bool bUI = true );
virtual OUString GetSelectionText( bool bCompleteWords = false );
virtual bool HasSelection( bool bText = true ) const;
virtual SdrView* GetDrawView() const;
SfxShell* GetSubShell() const { return pSubShell; }
void AddSubShell( SfxShell& rShell );
void RemoveSubShell( SfxShell *pShell=NULL );
SfxShell* GetSubShell( sal_uInt16 );
// Focus, KeyInput, Cursor
void GotFocus() const;
inline void LostFocus() const;
virtual void ShowCursor( bool bOn = true );
virtual bool KeyInput( const KeyEvent &rKeyEvent );
bool Escape();
// Viewing Interface
Window* GetWindow() const { return pWindow; }
void SetWindow( Window *pViewPort );
virtual void AdjustPosSizePixel( const Point &rOfs, const Size &rSize );
const SvBorder& GetBorderPixel() const;
void SetBorderPixel( const SvBorder &rBorder );
void InvalidateBorder();
inline SfxViewFrame* GetViewFrame() const;
// Printing Interface
virtual SfxPrinter* GetPrinter( bool bCreate = false );
virtual sal_uInt16 SetPrinter( SfxPrinter *pNewPrinter, sal_uInt16 nDiffFlags = SFX_PRINTER_ALL, bool bIsAPI=false );
virtual bool HasPrintOptionsPage() const;
virtual SfxTabPage* CreatePrintOptionsPage( Window *pParent, const SfxItemSet &rOptions );
virtual JobSetup GetJobSetup() const;
Printer* GetActivePrinter() const;
// Working set
virtual void WriteUserData( OUString&, bool bBrowse = false );
virtual void ReadUserData( const OUString&, bool bBrowse = false );
virtual void WriteUserDataSequence ( ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue >&, bool bBrowse = false );
virtual void ReadUserDataSequence ( const ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue >&, bool bBrowse = false );
virtual void QueryObjAreaPixel( Rectangle& rRect ) const;
virtual SfxObjectShell* GetObjectShell() SAL_OVERRIDE;
/** retrieves the document which shall be considered the "current document" when the frame is active
The default implementation simply returns the XModel of the associated SfxObjectShell. You will rarely
need to overwrite this behavior.
*/
virtual ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >
GetCurrentDocument() const;
/** forwards the current document, as returned by ->GetCurrentDocument, to SfxObjectShell::SetWorkingDocument
*/
void SetCurrentDocument() const;
/** get an XRenderable instance that can render this document
*/
virtual com::sun::star::uno::Reference< com::sun::star::view::XRenderable > GetRenderable();
virtual void MarginChanged();
const Size& GetMargin() const;
void SetMargin( const Size& );
void DisconnectAllClients();
virtual SfxFrame* GetSmartSelf( SfxFrame* pSelf, SfxMedium& rMedium );
bool NewWindowAllowed() const { return !bNoNewWindow; }
void SetNewWindowAllowed( bool bSet ) { bNoNewWindow = !bSet; }
void SetController( SfxBaseController* pController );
::com::sun::star::uno::Reference< ::com::sun::star::frame::XController >
GetController();
bool TryContextMenuInterception( Menu& rIn, const OUString& rMenuIdentifier, Menu*& rpOut, ::com::sun::star::ui::ContextMenuExecuteEvent aEvent );
void ExecPrint( const com::sun::star::uno::Sequence < com::sun::star::beans::PropertyValue >&, bool, bool );
void AddRemoveClipboardListener( const com::sun::star::uno::Reference < com::sun::star::datatransfer::clipboard::XClipboardListener>&, bool );
::com::sun::star::uno::Reference< ::com::sun::star::datatransfer::clipboard::XClipboardNotifier > GetClipboardNotifier();
SAL_DLLPRIVATE SfxInPlaceClient* GetUIActiveIPClient_Impl() const;
SAL_DLLPRIVATE void AddContextMenuInterceptor_Impl( const ::com::sun::star::uno::Reference < ::com::sun::star::ui::XContextMenuInterceptor >& xInterceptor );
SAL_DLLPRIVATE void RemoveContextMenuInterceptor_Impl( const ::com::sun::star::uno::Reference < ::com::sun::star::ui::XContextMenuInterceptor >& xInterceptor );
SAL_DLLPRIVATE bool GlobalKeyInput_Impl( const KeyEvent &rKeyEvent );
SAL_DLLPRIVATE void NewIPClient_Impl( SfxInPlaceClient *pIPClient )
{ GetIPClientList_Impl(true)->push_back(pIPClient); }
SAL_DLLPRIVATE void IPClientGone_Impl( SfxInPlaceClient *pIPClient );
SAL_DLLPRIVATE SfxInPlaceClientList* GetIPClientList_Impl( bool bCreate = true ) const;
SAL_DLLPRIVATE void ResetAllClients_Impl( SfxInPlaceClient *pIP );
SAL_DLLPRIVATE void DiscardClients_Impl();
SAL_DLLPRIVATE SfxPrinter* SetPrinter_Impl( SfxPrinter *pNewPrinter );
SAL_DLLPRIVATE bool IsShowView_Impl() const;
SAL_DLLPRIVATE bool HandleNotifyEvent_Impl( NotifyEvent& rEvent );
SAL_DLLPRIVATE bool HasKeyListeners_Impl();
SAL_DLLPRIVATE bool HasMouseClickListeners_Impl();
SAL_DLLPRIVATE SfxBaseController* GetBaseController_Impl() const;
// Shell Interface
SAL_DLLPRIVATE void ExecPrint_Impl(SfxRequest &);
SAL_DLLPRIVATE void ExecMisc_Impl(SfxRequest &);
SAL_DLLPRIVATE void GetState_Impl(SfxItemSet&);
SAL_DLLPRIVATE SfxFrameSetDescriptor* GetFrameSet_Impl() const;
SAL_DLLPRIVATE void SetFrameSet_Impl(SfxFrameSetDescriptor*);
SAL_DLLPRIVATE void CheckIPClient_Impl( SfxInPlaceClient*, const Rectangle& );
SAL_DLLPRIVATE void PushSubShells_Impl( bool bPush=true );
SAL_DLLPRIVATE void PopSubShells_Impl() { PushSubShells_Impl( false ); }
SAL_DLLPRIVATE void TakeOwnership_Impl();
SAL_DLLPRIVATE void TakeFrameOwnership_Impl();
SAL_DLLPRIVATE bool ExecKey_Impl(const KeyEvent& aKey);
};
inline void SfxViewShell::LostFocus() const
/* [Description]
This method has to be called by the application developer, if the edit
window has lost the focus. The SFx has for example the ability to turn off
the accelerator, so that the cursor keys, the Delete button, etc. work in
certain Floating-Windows, even though they are redefined by the
Accelerator.
[Note]
<StarView> unfortunatly does not provide the possibility to define
such events 'from the side'.
*/
{
}
inline SfxViewFrame* SfxViewShell::GetViewFrame() const
/* [Description]
This method returns a pointer to the <SfxViewFrame> Instance in which
this SfxViewShell is displayed. This is the instance that was passed
on in the constructor. It is guaranteed that the returned pointer
points on the valid SfxViewFrame instance.
[Cross-reference]
<SfxShell::GetFrame()const>
*/
{
return pFrame;
}
#endif // INCLUDED_SFX2_VIEWSH_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
