diff options
Diffstat (limited to 'include/svx/framelink.hxx')
| -rw-r--r-- | include/svx/framelink.hxx | 205 |
1 files changed, 205 insertions, 0 deletions
diff --git a/include/svx/framelink.hxx b/include/svx/framelink.hxx new file mode 100644 index 000000000..ec94bda63 --- /dev/null +++ b/include/svx/framelink.hxx @@ -0,0 +1,205 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef INCLUDED_SVX_FRAMELINK_HXX +#define INCLUDED_SVX_FRAMELINK_HXX + +#include <sal/types.h> +#include <tools/color.hxx> +#include <svx/svxdllapi.h> +#include <editeng/borderline.hxx> + +#include <memory> + +namespace svx { +namespace frame { + + +// Enums + + +/** Specifies how the reference points for frame borders are used. + */ +enum class RefMode +{ + /** Frame borders are drawn centered to the reference points. */ + Centered, + + /** The reference points specify the begin of the frame border width. + + The result is that horizontal lines are drawn below, and vertical lines + are drawn right of the reference points. + */ + Begin, + + /** The reference points specify the end of the frame border width. + + The result is that horizontal lines are drawn above, and vertical lines + are drawn left of the reference points. + */ + End +}; + + +// Classes + + +/** Contains the widths of primary and secondary line of a frame style. + + In the following, "frame style" is a complete style of one frame border, + i.e. the double line at the left side of the frame. A "line" is always a + trivial single line, i.e. the first line of a double frame style. + + The following states of the members of this struct are valid: + + mnPrim mnDist mnSecn frame style + ------------------------------------------------- + 0 0 0 invisible + >0 0 0 single + >0 >0 >0 double + + The behaviour of the member functions for other states is not defined. + + Per definition the primary line in double frame styles is: + - The top line for horizontal frame borders. + - The left line for vertical frame borders. + - The bottom-left line for top-left to bottom-right diagonal frame borders. + - The top-left line for bottom-left to top-right diagonal frame borders. + + The following picture shows the upper end of a vertical double frame + border. + + |<---------------- GetWidth() ----------------->| + | | + |<----- mnPrim ----->||<- mnDist ->||<- mnSecn >| + | || || | + ###################### ############# + ###################### ############# + ###################### ############# + ###################### ############# + ###################### | ############# + ###################### | ############# + | + |<- middle of the frame border + */ +class SAL_WARN_UNUSED SVXCORE_DLLPUBLIC Style +{ +private: + class implStyle + { + private: + friend class Style; + + Color maColorPrim; + Color maColorSecn; + Color maColorGap; + bool mbUseGapColor; + RefMode meRefMode; /// Reference point handling for this frame border. + double mfPrim; /// Width of primary (single, left, or top) line. + double mfDist; /// Distance between primary and secondary line. + double mfSecn; /// Width of secondary (right or bottom) line. + double mfPatternScale; /// Scale used for line pattern spacing. + SvxBorderLineStyle mnType; + bool mbWordTableCell; + + public: + /** Constructs an invisible frame style. */ + explicit implStyle() : + maColorPrim(), + maColorSecn(), + maColorGap(), + mbUseGapColor(false), + meRefMode(RefMode::Centered), + mfPrim(0.0), + mfDist(0.0), + mfSecn(0.0), + mfPatternScale(1.0), + mnType(SvxBorderLineStyle::SOLID), + mbWordTableCell(false) + {} + }; + + /// the impl class holding the data + std::shared_ptr< implStyle > maImplStyle; + + /// call to set maImplStyle on demand + void implEnsureImplStyle(); + +public: + /** Constructs an invisible frame style. */ + explicit Style(); + /** Constructs a frame style with passed line widths. */ + explicit Style( double nP, double nD, double nS, SvxBorderLineStyle nType, double fScale ); + /** Constructs a frame style with passed color and line widths. */ + explicit Style( const Color& rColorPrim, const Color& rColorSecn, const Color& rColorGap, bool bUseGapColor, double nP, double nD, double nS, SvxBorderLineStyle nType, double fScale ); + /** Constructs a frame style from the passed SvxBorderLine struct. */ + explicit Style( const editeng::SvxBorderLine* pBorder, double fScale ); + + RefMode GetRefMode() const { if(!maImplStyle) return RefMode::Centered; return maImplStyle->meRefMode; } + Color GetColorPrim() const { if(!maImplStyle) return Color(); return maImplStyle->maColorPrim; } + Color GetColorSecn() const { if(!maImplStyle) return Color(); return maImplStyle->maColorSecn; } + Color GetColorGap() const { if(!maImplStyle) return Color(); return maImplStyle->maColorGap; } + bool UseGapColor() const { if(!maImplStyle) return false; return maImplStyle->mbUseGapColor; } + double Prim() const { if(!maImplStyle) return 0.0; return maImplStyle->mfPrim; } + double Dist() const { if(!maImplStyle) return 0.0; return maImplStyle->mfDist; } + double Secn() const { if(!maImplStyle) return 0.0; return maImplStyle->mfSecn; } + double PatternScale() const { if(!maImplStyle) return 1.0; return maImplStyle->mfPatternScale;} + SvxBorderLineStyle Type() const { if(!maImplStyle) return SvxBorderLineStyle::SOLID; return maImplStyle->mnType; } + + /// Check if this style is used - this depends on it having any width definition. + /// As can be seen in the definition comment above, Prim() *must* be non zero to have a width + bool IsUsed() const { if(!maImplStyle) return false; return 0.0 != maImplStyle->mfPrim; } + + /** Returns the total width of this frame style. */ + double GetWidth() const { if(!maImplStyle) return 0.0; implStyle* pTarget = maImplStyle.get(); return pTarget->mfPrim + pTarget->mfDist + pTarget->mfSecn; } + + /** Sets the frame style to invisible state. */ + void Clear(); + /** Sets the frame style to the passed line widths. */ + void Set( double nP, double nD, double nS ); + /** Sets the frame style to the passed line widths. */ + void Set( const Color& rColorPrim, const Color& rColorSecn, const Color& rColorGap, bool bUseGapColor, double nP, double nD, double nS ); + /** Sets the frame style to the passed SvxBorderLine struct. If nullptr, resets the style */ + void Set( const editeng::SvxBorderLine* pBorder, double fScale, sal_uInt16 nMaxWidth = SAL_MAX_UINT16 ); + + /** Sets a new reference point handling mode, does not modify other settings. */ + void SetRefMode( RefMode eRefMode ); + /** Sets a new color, does not modify other settings. */ + void SetColorPrim( const Color& rColor ); + void SetColorSecn( const Color& rColor ); + /** Sets whether to use dotted style for single hair lines. */ + void SetType( SvxBorderLineStyle nType ); + + /** Mirrors this style (exchanges primary and secondary), if it is a double frame style. */ + Style& MirrorSelf(); + + /** Enables the Word-compatible Style comparison code. */ + void SetWordTableCell(bool bWordTableCell); + + bool operator==( const Style& rOther) const; + bool operator<( const Style& rOther) const; +}; + +inline bool operator>( const Style& rL, const Style& rR ) { return rR.operator<(rL); } + +} +} + +#endif +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |