sw/inc/flypos.hxx

   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 #ifndef INCLUDED_SW_INC_FLYPOS_HXX
  20 #define INCLUDED_SW_INC_FLYPOS_HXX
  21
  22 #include "swdllapi.h"
  23 #include <memory>
  24 #include <set>
  25
  26 class SwFrameFormat;
  27 class SwNodeIndex;
  28
  29 /// For querying current flys in document.
  30 class SAL_DLLPUBLIC_RTTI SwPosFlyFrame final
  31 {
  32     const SwFrameFormat* m_pFrameFormat;    ///< FlyFrameFormat
  33     SwNodeIndex* m_pNodeIndex;        ///< Index for node is sufficient.
  34     sal_uInt32 m_nOrdNum;
  35 public:
  36     SwPosFlyFrame( const SwNodeIndex& , const SwFrameFormat*, sal_uInt16 nArrPos );
  37     virtual ~SwPosFlyFrame(); ///< Virtual for Writer (DLL !!)
  38
  39     const SwFrameFormat& GetFormat() const { return *m_pFrameFormat; }
  40     const SwNodeIndex& GetNdIndex() const { return *m_pNodeIndex; }
  41     sal_uInt32 GetOrdNum() const { return m_nOrdNum; }
  42 };
  43
  44 // define needed classes to safely handle an array of allocated SwPosFlyFrame(s).
  45 // SwPosFlyFrames can be handled by value (as return value), only refcounts to
  46 // contained SwPosFlyFrame* will be copied. When releasing the last SwPosFlyFramePtr
  47 // instance the allocated instance will be freed. The array is sorted by
  48 // GetNdIndex by using a std::set container.
  49 typedef std::shared_ptr< SwPosFlyFrame > SwPosFlyFramePtr;
  50 struct SwPosFlyFrameCmp { bool operator()(const SwPosFlyFramePtr& rA, const SwPosFlyFramePtr& rB) const; };
  51 typedef std::set< SwPosFlyFramePtr, SwPosFlyFrameCmp > SwPosFlyFrames;
  52
  53 #endif // INCLUDED_SW_INC_FLYPOS_HXX
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */