framelink.hxx

Go to the documentation of this file.

/* -*- 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::frame {


// Enums


enum class RefMode : sal_uInt8
{
    Centered,

    Begin,

    End
};


// Classes


class SAL_WARN_UNUSED SVXCORE_DLLPUBLIC Style
{
private:
    Color               maColorPrim;
    Color               maColorSecn;
    Color               maColorGap;
    double              mfPrim;     
    double              mfDist;     
    double              mfSecn;     
    double              mfPatternScale; 
    RefMode             meRefMode;  
    SvxBorderLineStyle  mnType;
    bool                mbWordTableCell : 1;
    bool                mbUseGapColor : 1;

public:
    explicit Style();
    explicit Style( double nP, double nD, double nS, SvxBorderLineStyle nType, double fScale );
    explicit Style( const Color& rColorPrim, const Color& rColorSecn, const Color& rColorGap, bool bUseGapColor, double nP, double nD, double nS, SvxBorderLineStyle nType, double fScale );
    explicit Style( const editeng::SvxBorderLine* pBorder, double fScale );

    RefMode GetRefMode() const { return meRefMode; }
    Color GetColorPrim() const { return maColorPrim; }
    Color GetColorSecn() const { return maColorSecn; }
    Color GetColorGap() const { return maColorGap; }
    bool UseGapColor() const { return mbUseGapColor; }
    double Prim() const { return mfPrim; }
    double Dist() const { return mfDist; }
    double Secn() const { return mfSecn; }
    double PatternScale() const { return mfPatternScale;}
    SvxBorderLineStyle Type() const { return mnType; }

    bool IsUsed() const { return 0.0 != mfPrim; }

    double GetWidth() const { return mfPrim + mfDist + mfSecn; }

    void Clear();
    void Set( double nP, double nD, double nS );
    void Set( const Color& rColorPrim, const Color& rColorSecn, const Color& rColorGap, bool bUseGapColor, double nP, double nD, double nS );
    void Set( const editeng::SvxBorderLine* pBorder, double fScale, sal_uInt16 nMaxWidth = SAL_MAX_UINT16 );

    void SetRefMode( RefMode eRefMode ) { meRefMode = eRefMode; }
    void SetColorPrim( const Color& rColor ) { maColorPrim = rColor; }
    void SetColorSecn( const Color& rColor ) { maColorSecn = rColor; }
    void SetType( SvxBorderLineStyle nType ) { mnType = nType; }

    Style& MirrorSelf();

    void SetWordTableCell(bool bWordTableCell) { mbWordTableCell = 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: */