sc/source/filter/inc/xcl97esc.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: xcl97esc.hxx,v $
  10  * $Revision: 1.13.14.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SC_XCL97ESC_HXX
  32 #define SC_XCL97ESC_HXX
  33
  34 #include <svx/escherex.hxx>
  35 #include <tools/table.hxx>
  36 #include <tools/stack.hxx>
  37 #include "xlescher.hxx"
  38 #include "xeroot.hxx"
  39
  40 // 0 = Export TBX form controls, 1 = Export OCX form controls.
  41 #define EXC_EXP_OCX_CTRL 0
  42
  43 namespace utl { class TempFile; }
  44
  45 // --- class XclEscherEx ---------------------------------------------
  46
  47 class SvStream;
  48 class XclObj;
  49 class XclEscherHostAppData;
  50 class XclEscherClientData;
  51 class XclEscherClientTextbox;
  52 #if EXC_EXP_OCX_CTRL
  53 class XclExpOcxControlObj;
  54 #else
  55 class XclExpTbxControlObj;
  56 #endif
  57 class XclExpShapeObj;
  58 class EscherExHostAppData;
  59 class ShapeInteractionHelper
  60 {
  61 public:
  62    static XclExpShapeObj* CreateShapeObj(const XclExpRoot& rRoot, const ::com::sun::star::uno::Reference<
  63                             ::com::sun::star::drawing::XShape >& xShape );
  64    static void PopulateShapeInteractionInfo( const XclExpRoot& rRoot, const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape >& xShape, EscherExHostAppData& rHostAppData );
  65 };
  66
  67 class XclEscherEx : public EscherEx, protected XclExpRoot
  68 {
  69 private:
  70         List                            aOffsetMap;
  71         Stack                           aStack;
  72         utl::TempFile*          pPicTempFile;
  73         SvStream*                       pPicStrm;
  74         XclObj*                         pCurrXclObj;
  75         XclEscherHostAppData*   pCurrAppData;
  76         XclEscherClientData*    pTheClientData; // always the same
  77         XclEscherClientTextbox* pAdditionalText;
  78         USHORT                                  nAdditionalText;
  79
  80             void                                DeleteCurrAppData();
  81
  82 public:
  83                                 XclEscherEx( const XclExpRoot& rRoot, SvStream& rStrm, UINT32 nDrawings );
  84     virtual                                             ~XclEscherEx();
  85
  86                                 /// maintains OffsetMap
  87     virtual     void                            InsertAtCurrentPos( UINT32 nBytes, BOOL bCont = FALSE );
  88
  89     virtual     SvStream*                       QueryPicStream();
  90     virtual     EscherExHostAppData*    StartShape( const com::sun::star::uno::Reference<
  91                                         com::sun::star::drawing::XShape>& rShape );
  92     virtual     void                            EndShape( UINT16 nShapeType, UINT32 nShapeID );
  93     virtual     EscherExHostAppData*    EnterAdditionalTextGroup();
  94
  95                                 /// appends stream offset to list and returns position in list
  96             ULONG                               AddCurrentOffsetToMap();
  97                                 /// replaces position in list with current stream offset
  98             void                                ReplaceCurrentOffsetInMap( ULONG nPos );
  99                                 /// returns stream offset for position in list
 100     inline      ULONG                           GetOffsetFromMap( ULONG nPos ) const;
 101                                 /// last position in list (count-1)
 102     inline      ULONG                           GetLastOffsetMapPos() const;
 103
 104                                 /// Flush and merge PicStream into EscherStream
 105             void                                EndDocument();
 106
 107 #if EXC_EXP_OCX_CTRL
 108     /** Creates an OCX form control OBJ record from the passed form control.
 109         @descr  Writes the form control data to the 'Ctls' stream. */
 110     XclExpOcxControlObj* CreateCtrlObj( ::com::sun::star::uno::Reference<
 111                             ::com::sun::star::drawing::XShape > xShape );
 112
 113 private:
 114     SotStorageStreamRef  mxCtlsStrm;         /// The 'Ctls' stream.
 115 #else
 116     /** Creates a TBX form control OBJ record from the passed form control. */
 117     XclExpTbxControlObj* CreateCtrlObj( ::com::sun::star::uno::Reference<
 118                             ::com::sun::star::drawing::XShape > xShape );
 119
 120 private:
 121     /** Tries to get the name of a Basic macro from a control. */
 122     void                ConvertTbxMacro(
 123                             XclExpTbxControlObj& rTbxCtrlObj,
 124                             ::com::sun::star::uno::Reference<
 125                                 ::com::sun::star::awt::XControlModel > xCtrlModel );
 126 #endif
 127 };
 128
 129
 130 inline ULONG XclEscherEx::GetOffsetFromMap( ULONG nPos ) const
 131 {
 132     return (ULONG) aOffsetMap.GetObject( nPos );
 133 }
 134
 135
 136 inline ULONG XclEscherEx::GetLastOffsetMapPos() const
 137 {
 138     return aOffsetMap.Count() - 1;
 139 }
 140
 141
 142 // --- class XclEscher -----------------------------------------------
 143
 144 struct RootData;
 145
 146 class XclEscher : protected XclExpRoot
 147 {
 148 private:
 149         utl::TempFile*          pTempFile;
 150         SvStream*                       pStrm;
 151         XclEscherEx*            pEx;
 152
 153 public:
 154                                 XclEscher( const XclExpRoot& rRoot, UINT32 nDrawings );
 155                                 ~XclEscher();
 156
 157     inline      XclEscherEx*            GetEx() const           { return pEx; }
 158     inline      SvStream&                       GetStrm() const         { return *pStrm; }
 159
 160     void                        AddSdrPage();
 161 };
 162
 163
 164 // --- class XclEscherHostAppData ------------------------------------
 165
 166 class XclEscherHostAppData : public EscherExHostAppData
 167 {
 168 private:
 169         BOOL                            bStackedGroup;
 170
 171 public:
 172                                 XclEscherHostAppData() : bStackedGroup( FALSE )
 173                                     {}
 174     inline      void                            SetStackedGroup( BOOL b )       { bStackedGroup = b; }
 175     inline      BOOL                            IsStackedGroup() const  { return bStackedGroup; }
 176 };
 177
 178
 179 // DFF client anchor ==========================================================
 180
 181 class Rectangle;
 182 class SdrObject;
 183 class ScAddress;
 184
 185 /** Represents the position (anchor) of an object in a Calc document. */
 186 class XclExpDffAnchor : public EscherExClientAnchor_Base, protected XclExpRoot
 187 {
 188 public:
 189     /** Constructs a dummy client anchor. */
 190     explicit                    XclExpDffAnchor( const XclExpRoot& rRoot, sal_uInt16 nFlags = 0 );
 191     /** Constructs a client anchor directly from an SdrObject. */
 192     explicit                    XclExpDffAnchor( const XclExpRoot& rRoot, const SdrObject& rSdrObj );
 193
 194     /** Sets the flags according to the passed SdrObject. */
 195     void                        SetFlags( const SdrObject& rSdrObj );
 196
 197     /** Called from SVX Escher exporter.
 198         @param rRect  The object anchor rectangle to be exported (in twips). */
 199     virtual     void                            WriteData( EscherEx& rEx, const Rectangle& rRect );
 200
 201     /** Writes the anchor structure with the current anchor position. */
 202     void                        WriteData( EscherEx& rEx ) const;
 203
 204 protected:  // for access in derived classes
 205     XclObjAnchor                maAnchor;       /// The client anchor data.
 206     sal_uInt16                  mnFlags;        /// Flags for DFF stream export.
 207 };
 208
 209 // ----------------------------------------------------------------------------
 210
 211 /** Represents the position (anchor) of a note object. */
 212 class XclExpDffNoteAnchor : public XclExpDffAnchor
 213 {
 214 public:
 215     explicit                    XclExpDffNoteAnchor( const XclExpRoot& rRoot, const Rectangle& rRect );
 216 };
 217
 218
 219 // ----------------------------------------------------------------------------
 220
 221 /** Represents the position (anchor) of a cell dropdown object. */
 222 class XclExpDffDropDownAnchor : public XclExpDffAnchor
 223 {
 224 public:
 225     explicit                    XclExpDffDropDownAnchor( const XclExpRoot& rRoot, const ScAddress& rScPos );
 226 };
 227
 228
 229 // ============================================================================
 230
 231 // --- class XclEscherClientData -------------------------------------
 232
 233 class XclEscherClientData : public EscherExClientRecord_Base
 234 {
 235 public:
 236                                 XclEscherClientData() {}
 237     virtual     void                            WriteData( EscherEx& rEx ) const;
 238 };
 239
 240
 241 // --- class XclEscherClientTextbox ----------------------------------
 242
 243 class SdrTextObj;
 244
 245 class XclEscherClientTextbox : public EscherExClientRecord_Base, protected XclExpRoot
 246 {
 247 private:
 248         const SdrTextObj&               rTextObj;
 249         XclObj*                                 pXclObj;
 250
 251 public:
 252                                 XclEscherClientTextbox(
 253                                     const XclExpRoot& rRoot,
 254                                     const SdrTextObj& rObj,
 255                                     XclObj* pObj
 256                                     );
 257
 258                                 //! ONLY for the AdditionalText mimic
 259     inline      void                            SetXclObj( XclObj* p )  { pXclObj = p; }
 260
 261     virtual     void                            WriteData( EscherEx& rEx ) const;
 262 };
 263
 264
 265
 266 #endif // _XCL97ESC_HXX