include/vcl/mapmod.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
  20 #ifndef INCLUDED_VCL_MAPMOD_HXX
  21 #define INCLUDED_VCL_MAPMOD_HXX
  22
  23 #include <vcl/dllapi.h>
  24 #include <tools/mapunit.hxx>
  25 #include <o3tl/cow_wrapper.hxx>
  26
  27 #include <ostream>
  28
  29 class Point;
  30 class Fraction;
  31 class SvStream;
  32
  33 class SAL_WARN_UNUSED VCL_DLLPUBLIC MapMode
  34 {
  35     friend class        OutputDevice;
  36
  37 public:
  38     struct SAL_DLLPRIVATE ImplMapMode;
  39
  40     MapMode();
  41     MapMode( const MapMode& rMapMode );
  42     explicit MapMode( MapUnit eUnit );
  43     MapMode( MapUnit eUnit, const Point& rLogicOrg,
  44         const Fraction& rScaleX, const Fraction& rScaleY );
  45     ~MapMode();
  46
  47     void            SetMapUnit( MapUnit eUnit );
  48     MapUnit         GetMapUnit() const;
  49
  50     void            SetOrigin( const Point& rOrigin );
  51     const Point&    GetOrigin() const;
  52
  53     void            SetScaleX( const Fraction& rScaleX );
  54     const Fraction& GetScaleX() const;
  55     void            SetScaleY( const Fraction& rScaleY );
  56     const Fraction& GetScaleY() const;
  57
  58     MapMode&        operator=( const MapMode& rMapMode );
  59     MapMode&        operator=( MapMode&& rMapMode );
  60     bool            operator==( const MapMode& rMapMode ) const;
  61     bool            operator!=( const MapMode& rMapMode ) const
  62     {
  63         return !(MapMode::operator==( rMapMode ));
  64     }
  65     bool            IsDefault() const;
  66
  67     // Compute value usable as hash.
  68     size_t          GetHashValue() const;
  69
  70     // tdf#117984 needs to be thread-safe due to being used e.g. in Bitmaps
  71     // vcl::ScopedBitmapAccess in parallelized 3D renderer
  72     typedef o3tl::cow_wrapper< ImplMapMode, o3tl::ThreadSafeRefCountingPolicy > ImplType;
  73
  74     // If only the map unit is set.
  75     bool IsSimple() const;
  76
  77 private:
  78     ImplType        mpImplMapMode;
  79 };
  80
  81 template<typename charT, typename traits>
  82 inline std::basic_ostream<charT, traits> & operator <<(
  83     std::basic_ostream<charT, traits> & rStream, const MapMode& rMode)
  84 {
  85     rStream << "MapMode(" << static_cast<unsigned>(rMode.GetMapUnit()) << ",(" << rMode.GetScaleX() << "," << rMode.GetScaleY() << ")@(" << rMode.GetOrigin() << "))";
  86     return rStream;
  87 }
  88
  89 bool TooLargeScaleForMapMode(const Fraction& rScale, int nDPI);
  90
  91 #endif // INCLUDED_VCL_MAPMOD_HXX
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */