ScaleAutomatism.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 .
 */
#pragma once
 
#include <com/sun/star/chart2/ScaleData.hpp>
 
#include <tools/date.hxx>
 
namespace chart { struct ExplicitIncrementData; }
namespace chart { struct ExplicitScaleData; }
 
namespace chart
{
 
class ScaleAutomatism
{
public:
    explicit            ScaleAutomatism(
                            const css::chart2::ScaleData& rSourceScale, const Date& rNullDate );
 
    void                expandValueRange( double fMinimum, double fMaximum );
    void                resetValueRange();
 
    void                setAutoScalingOptions(
                            bool bExpandBorderToIncrementRhythm,
                            bool bExpandIfValuesCloseToBorder,
                            bool bExpandWideValuesToZero,
                            bool bExpandNarrowValuesTowardZero );
 
    void                setMaximumAutoMainIncrementCount( sal_Int32 nMaximumAutoMainIncrementCount );
 
    void setAutomaticTimeResolution( sal_Int32 nTimeResolution );
 
    void                calculateExplicitScaleAndIncrement(
                            ExplicitScaleData& rExplicitScale,
                            ExplicitIncrementData& rExplicitIncrement ) const;
 
    const css::chart2::ScaleData& getScale() const { return m_aSourceScale;}
    const Date& getNullDate() const { return m_aNullDate;}
 
private:
    void                calculateExplicitIncrementAndScaleForCategory(
                            ExplicitScaleData& rExplicitScale,
                            ExplicitIncrementData& rExplicitIncrement,
                            bool bAutoMinimum, bool bAutoMaximum ) const;
 
    void                calculateExplicitIncrementAndScaleForLogarithmic(
                            ExplicitScaleData& rExplicitScale,
                            ExplicitIncrementData& rExplicitIncrement,
                            bool bAutoMinimum, bool bAutoMaximum ) const;
 
    void                calculateExplicitIncrementAndScaleForLinear(
                            ExplicitScaleData& rExplicitScale,
                            ExplicitIncrementData& rExplicitIncrement,
                            bool bAutoMinimum, bool bAutoMaximum ) const;
 
    void                calculateExplicitIncrementAndScaleForDateTimeAxis(
                            ExplicitScaleData& rExplicitScale,
                            ExplicitIncrementData& rExplicitIncrement,
                            bool bAutoMinimum, bool bAutoMaximum ) const;
 
private:
    css::chart2::ScaleData             m_aSourceScale;
 
    double              m_fValueMinimum;                    
    double              m_fValueMaximum;                    
    sal_Int32           m_nMaximumAutoMainIncrementCount;   
    bool                m_bExpandBorderToIncrementRhythm;   
    bool                m_bExpandIfValuesCloseToBorder;     
    bool                m_bExpandWideValuesToZero;          
    bool                m_bExpandNarrowValuesTowardZero;    
    sal_Int32           m_nTimeResolution;// a constant out of css::chart::TimeUnit
 
    Date                m_aNullDate;
};
 
} //namespace chart
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */