Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 : #ifndef INCLUDED_SVX_SDR_CONTACT_VIEWCONTACT_HXX
21 : #define INCLUDED_SVX_SDR_CONTACT_VIEWCONTACT_HXX
22 :
23 : #include <sal/types.h>
24 : #include <svx/svxdllapi.h>
25 : #include <drawinglayer/primitive2d/baseprimitive2d.hxx>
26 :
27 : class SetOfByte;
28 : class SdrPage;
29 : class SdrObject;
30 :
31 : namespace sdr { namespace contact {
32 :
33 : class ObjectContact;
34 : class ViewObjectContact;
35 :
36 : class SVX_DLLPUBLIC ViewContact
37 : {
38 : private:
39 : // make ViewObjectContact a friend to exclusively allow it to use
40 : // AddViewObjectContact/RemoveViewObjectContact
41 : friend class ViewObjectContact;
42 :
43 : // List of ViewObjectContacts. This contains all VOCs which were constructed
44 : // with this VC. Since the VOCs remember a reference to this VC, this list needs
45 : // to be kept and is used e.g. at destructor to destroy all VOCs.
46 : // Registering and de-registering is done in the VOC constructors/destructors.
47 : std::vector< ViewObjectContact* > maViewObjectContactVector;
48 :
49 : // Primitive2DSequence of the ViewContact. This contains all necessary information
50 : // for the graphical visualisation and needs to be supported by all VCs which
51 : // can be visualized.
52 : drawinglayer::primitive2d::Primitive2DSequence mxViewIndependentPrimitive2DSequence;
53 :
54 : // A new ViewObjectContact was created and shall be remembered.
55 : void AddViewObjectContact(ViewObjectContact& rVOContact);
56 :
57 : // A ViewObjectContact was deleted and shall be forgotten.
58 : void RemoveViewObjectContact(ViewObjectContact& rVOContact);
59 :
60 : // internal tooling to delete VOCs
61 : void deleteAllVOCs();
62 :
63 : protected:
64 : // Interface to allow derivates to travel over the registered VOC's
65 46 : sal_uInt32 getViewObjectContactCount() const { return maViewObjectContactVector.size(); }
66 0 : ViewObjectContact* getViewObjectContact(sal_uInt32 a) const { return maViewObjectContactVector[a]; }
67 :
68 : // Create a Object-Specific ViewObjectContact, set ViewContact and
69 : // ObjectContact. Always needs to return something. Default is to create
70 : // a standard ViewObjectContact containing the given ObjectContact and *this
71 : virtual ViewObjectContact& CreateObjectSpecificViewObjectContact(ObjectContact& rObjectContact);
72 :
73 : // This method is responsible for creating the graphical visualisation data derived ONLY from
74 : // the model data. It will be stored/buffered in mxViewIndependentPrimitive2DSequence. The default implementation
75 : // creates a yellow replacement rectangle (1000, 1000, 5000, 3000) to visualize missing
76 : // implementations. All implementations have to provide basic geometry here, this is the central
77 : // visualisation method and will also be used for BoundRect computations in the long run.
78 : // This means it's always an error when the default implementation is called and thus gets
79 : // asserted there
80 : virtual drawinglayer::primitive2d::Primitive2DSequence createViewIndependentPrimitive2DSequence() const;
81 :
82 : // method for flushing View Independent Primitive2DSequence for VOC implementations
83 111 : void flushViewIndependentPrimitive2DSequence() { mxViewIndependentPrimitive2DSequence.realloc(0); }
84 :
85 : // basic constructor. Since this is a base class only, it shall
86 : // never be called directly
87 : ViewContact();
88 :
89 : public:
90 : // basic destructor with needed cleanups
91 : virtual ~ViewContact();
92 :
93 : // get a Object-specific ViewObjectContact for a specific
94 : // ObjectContact (->View). Always needs to return something.
95 : ViewObjectContact& GetViewObjectContact(ObjectContact& rObjectContact);
96 :
97 : // Test if this ViewContact has ViewObjectContacts at all. This can
98 : // be used to test if this ViewContact is visualized ATM or not
99 : bool HasViewObjectContacts(bool bExcludePreviews = false) const;
100 :
101 : // Check if this primitive is animated in any OC (View) which means it has
102 : // generated a PrimitiveAnimation in it's VOC
103 : bool isAnimatedInAnyViewObjectContact() const;
104 :
105 : // Access to possible sub-hierarchy and parent. GetObjectCount() default is 0L
106 : // and GetViewContact default pops up an assert since it's an error if
107 : // GetObjectCount has a result != 0 and it's not overridden.
108 : virtual sal_uInt32 GetObjectCount() const;
109 : virtual ViewContact& GetViewContact(sal_uInt32 nIndex) const;
110 : virtual ViewContact* GetParentContact() const;
111 :
112 : // React on insertion of a child into DRawHierarchy starting
113 : // from this object
114 : void ActionChildInserted(ViewContact& rChild);
115 :
116 : // React on changes of the object of this ViewContact
117 : virtual void ActionChanged();
118 :
119 : // access to SdrObject and/or SdrPage. May return 0L like the default
120 : // implementations do. Override as needed.
121 : virtual SdrObject* TryToGetSdrObject() const;
122 : virtual SdrPage* TryToGetSdrPage() const;
123 :
124 : // access to the local primitive. This will ensure that the primitive is
125 : // current in comparing the local one with a fresh created incarnation
126 : drawinglayer::primitive2d::Primitive2DSequence getViewIndependentPrimitive2DSequence() const;
127 :
128 : // add Gluepoints (if available)
129 : virtual drawinglayer::primitive2d::Primitive2DSequence createGluePointPrimitive2DSequence() const;
130 :
131 : // allow embedding if needed (e.g. for SdrObjects, evtl. Name, Title and description get added). This
132 : // is a helper normally used from getViewIndependentPrimitive2DSequence(), but there is one exception
133 : // for 3D scenes
134 : virtual drawinglayer::primitive2d::Primitive2DSequence embedToObjectSpecificInformation(const drawinglayer::primitive2d::Primitive2DSequence& rSource) const;
135 :
136 : virtual basegfx::B2DRange getRange( const drawinglayer::geometry::ViewInformation2D& rViewInfo2D ) const;
137 :
138 : // delete all existing VOCs including DrawHierarchy which will invalidate all
139 : // visualisations, too. Used mostly at object removal from DrawHierarchy to
140 : // delete all existing VOCs by purpose, but can also be used for other purposes.
141 : // It is always possible to delete the VOCs, these are re-created on demand
142 : void flushViewObjectContacts(bool bWithHierarchy = true);
143 : };
144 :
145 : }}
146 :
147 :
148 :
149 : #endif // INCLUDED_SVX_SDR_CONTACT_VIEWCONTACT_HXX
150 :
151 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
