include/svtools/borderline.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 #pragma once
  21
  22 #include <svtools/svtdllapi.h>
  23 #include <o3tl/typed_flags_set.hxx>
  24 #include <o3tl/hash_combine.hxx>
  25 #include <tools/long.hxx>
  26
  27 /**
  28     Class computing border widths shared between Line style listbox and the
  29     SvxBorderLine implementation.
  30
  31     This class doesn't know anything about units: it all depends on the different
  32     values set. A border is composed of 2 lines separated by a gap. The computed
  33     widths are the ones of each line and the gap and they can either be fix or vary.
  34
  35     The #m_nflags member will define which widths will vary (value 0 means that all
  36     widths are fixed). The available flags are:
  37      - CHANGE_LINE1
  38      - CHANGE_LINE2
  39      - CHANGE_DIST
  40
  41     For each line, the rate member is used as a multiplication factor is the width
  42     isn't fixed. Otherwise it is the width in the unit expected by the client code.
  43  */
  44 enum class BorderWidthImplFlags
  45 {
  46     FIXED           = 0,
  47     CHANGE_LINE1    = 1,
  48     CHANGE_LINE2    = 2,
  49     CHANGE_DIST     = 4,
  50 };
  51 namespace o3tl
  52 {
  53     template<> struct typed_flags<BorderWidthImplFlags> : is_typed_flags<BorderWidthImplFlags, 0x07> {};
  54 }
  55 class SVT_DLLPUBLIC BorderWidthImpl
  56 {
  57     BorderWidthImplFlags m_nFlags;
  58     double m_nRate1;
  59     double m_nRate2;
  60     double m_nRateGap;
  61
  62 public:
  63
  64     BorderWidthImpl( BorderWidthImplFlags nFlags = BorderWidthImplFlags::CHANGE_LINE1, double nRate1 = 0.0,
  65             double nRate2 = 0.0, double nRateGap = 0.0 );
  66
  67     bool operator== ( const BorderWidthImpl& r ) const;
  68
  69     tools::Long GetLine1 ( tools::Long nWidth ) const;
  70     tools::Long GetLine2( tools::Long nWidth ) const;
  71     tools::Long GetGap( tools::Long nWidth ) const;
  72
  73     tools::Long GuessWidth( tools::Long nLine1, tools::Long nLine2, tools::Long nGap );
  74
  75     bool IsEmpty( ) const { return (0 == m_nRate1) && (0 == m_nRate2); }
  76     bool IsDouble( ) const { return (0 != m_nRate1) && (0 != m_nRate2);  }
  77
  78 };
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */