KDChartCustomBox.h

Go to the documentation of this file.

/*
   KDChart - a multi-platform charting engine
   */
 
/****************************************************************************
 ** Copyright (C) 2001-2003 Klarälvdalens Datakonsult AB.  All rights reserved.
 **
 ** This file is part of the KDChart library.
 **
 ** This file may be distributed and/or modified under the terms of the
 ** GNU General Public License version 2 as published by the Free Software
 ** Foundation and appearing in the file LICENSE.GPL included in the
 ** packaging of this file.
 **
 ** Licensees holding valid commercial KDChart licenses may use this file in
 ** accordance with the KDChart Commercial License Agreement provided with
 ** the Software.
 **
 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 **
 ** See http://www.klaralvdalens-datakonsult.se/?page=products for
 **   information about KDChart Commercial License Agreements.
 **
 ** Contact info@klaralvdalens-datakonsult.se if any conditions of this
 ** licensing are not clear to you.
 **
 **********************************************************************/
#ifndef __KDCHARTCUSTOMBOX_H__
#define __KDCHARTCUSTOMBOX_H__
 
#include <tqobject.h>
#include <tqtextstream.h>
#include <tqfont.h>
#include <tqdom.h>
#include "KDChartGlobal.h"
#include "KDChartEnums.h"
#include "KDChartTextPiece.h"
 
 
class KDFrame;
 
// needed because there was no AlignAuto before TQt 3.0
#define KDCHART_AlignAuto 0
 


class KDCHART_EXPORT KDChartCustomBox :public TQObject
{
    TQ_OBJECT
  
    friend class KDChartPainter;
    friend class KDChartParams;
 
public:

    KDChartCustomBox() :
        _rotation( 0 ),
        _fontSize( -10 ),
        _fontScaleGlobal( true ),
        _deltaX( 0 ),
        _deltaY( 0 ),
        _width(  0 ),
        _height( 0 ),
        _color( TQt::black ),
        _paper( TQt::NoBrush ),
        _anchorArea(  KDChartEnums::AreaInnermost ),
        _anchorPos(   KDChartEnums::PosTopLeft ),
        _anchorAlign( TQt::AlignTop + TQt::AlignLeft ),
        _dataRow( 0 ),
        _dataCol( 0 ),
        _data3rd( 0 ),
        _deltaAlign( KDCHART_AlignAuto ),
        _deltaScaleGlobal( true ),
        _anchorBeingCalculated( false ),
        _parentAxisArea( -1 )
    {
        const KDChartTextPiece piece( 0, "", TQFont( "helvetica", 8, TQFont::Normal, false ) );
        _content.deepCopy( &piece );
    }

    KDChartCustomBox( const KDChartTextPiece & content,
                      int fontSize,
                      bool fontScaleGlobal = true ) :
        _rotation( 0 ),
        _fontSize( fontSize ),
        _fontScaleGlobal( fontScaleGlobal ),
        _deltaX( 0 ),
        _deltaY( 0 ),
        _width(  0 ),
        _height( 0 ),
        _color( TQt::black ),
        _paper( TQt::NoBrush ),
        _anchorArea(  KDChartEnums::AreaInnermost ),
        _anchorPos(   KDChartEnums::PosTopLeft ),
        _anchorAlign( TQt::AlignTop + TQt::AlignLeft ),
        _dataRow( 0 ),
        _dataCol( 0 ),
        _data3rd( 0 ),
        _deltaAlign( KDCHART_AlignAuto ),
        _deltaScaleGlobal( true ),
        _anchorBeingCalculated( false ),
         _parentAxisArea( -1 )
    {
        _content.deepCopy( &content );
    }
 

    KDChartCustomBox( const KDChartTextPiece & content,
                      int fontSize,
                      bool fontScaleGlobal,
                      int deltaX,
                      int deltaY,
                      int width,
                      int height,
                      const TQColor & color = TQColor( TQt::black   ),
                      const TQBrush & paper = TQBrush( TQt::NoBrush ),
                      uint area                           = KDChartEnums::AreaInnermost,
                      KDChartEnums::PositionFlag position = KDChartEnums::PosTopLeft,
                      uint align                          = TQt::AlignTop + TQt::AlignLeft,
                      uint dataRow = 0,
                      uint dataCol = 0,
                      uint data3rd = 0,
                      uint deltaAlign = KDCHART_AlignAuto,
                      bool deltaScaleGlobal = true,
                      int parentAxis = -1 )
        : _rotation( 0 ),
          _fontSize( fontSize ),
          _fontScaleGlobal( fontScaleGlobal ),
          _deltaX( deltaX ),
          _deltaY( deltaY ),
          _width( width ),
          _height( height ),
          _color( color ),
          _paper( paper ),
          _anchorArea( area ),
          _anchorPos( position ),
          _anchorAlign( align ),
          _dataRow( dataRow ),
          _dataCol( dataCol ),
          _data3rd( data3rd ),
          _deltaAlign( deltaAlign ),
          _deltaScaleGlobal( deltaScaleGlobal ),
          _anchorBeingCalculated( false ),
          _parentAxisArea(  parentAxis )
    {
        _content.deepCopy( &content );
    }
 

    KDChartCustomBox( int rotation,
                      const KDChartTextPiece & content,
                      int fontSize,
                      bool fontScaleGlobal,
                      int deltaX,
                      int deltaY,
                      int width,
                      int height,
                      const TQColor & color = TQColor( TQt::black   ),
                      const TQBrush & paper = TQBrush( TQt::NoBrush ),
                      uint area                           = KDChartEnums::AreaInnermost,
                      KDChartEnums::PositionFlag position = KDChartEnums::PosTopLeft,
                      uint align                          = TQt::AlignTop + TQt::AlignLeft,
                      uint dataRow = 0,
                      uint dataCol = 0,
                      uint data3rd = 0,
                      uint deltaAlign = KDCHART_AlignAuto,
                      bool deltaScaleGlobal = true,
                      int parentAxis = -1 )
        : _rotation( rotation ),
          _fontSize( fontSize ),
          _fontScaleGlobal( fontScaleGlobal ),
          _deltaX( deltaX ),
          _deltaY( deltaY ),
          _width( width ),
          _height( height ),
          _color( color ),
          _paper( paper ),
          _anchorArea( area ),
          _anchorPos( position ),
          _anchorAlign( align ),
          _dataRow( dataRow ),
          _dataCol( dataCol ),
          _data3rd( data3rd ),
          _deltaAlign( deltaAlign ),
          _deltaScaleGlobal( deltaScaleGlobal ),
          _anchorBeingCalculated( false ),
          _parentAxisArea(  parentAxis )
    {
        _content.deepCopy( &content );
    }
 

    static void createCustomBoxNode( TQDomDocument& document,
                                     TQDomNode& parent,
                                     const TQString& elementName,
                                     const KDChartCustomBox* custombox );

    static bool readCustomBoxNode( const TQDomElement& element,
                                   KDChartCustomBox& custombox );
 
public slots: // PENDING(blackie) merge slots sections.
 
    float trueFontSize( double areaWidthP1000,
                        double areaHeightP1000,
                        int rectHeight ) const;
    int trueFontLineSpacing( double areaWidthP1000,
                             double areaHeightP1000,
                             int rectHeight ) const;
    int trueRectAlignX(const TQRect& rect) const;
    int trueRectAlignY(const TQRect& rect) const;
    void getTrueShift( double areaWidthP1000,
                       double areaHeightP1000,
                       int rectHeight,
                       int& dX,
                       int& dY )const;
 

    TQRect trueRect( TQPainter * painter,
       TQPoint anchor, double areaWidthP1000, double areaHeightP1000 ) const ;

    virtual TQRect trueRect( TQPoint anchor,
                            double areaWidthP1000,
                            double areaHeightP1000 ) const ;

    virtual void paint( TQPainter* painter,
                        TQPoint anchor,
                        double areaWidthP1000,
                        double areaHeightP1000,
                        const KDFrame* frame     = 0,
                        const TQRect&   frameRect = TQRect(),
                        const TQColor * color = 0,
                        const TQBrush * paper = 0 ) const ;

    void setRotation( int rotation )
    {
        _rotation = rotation;
    }

    void setContent( const KDChartTextPiece & content )
    {
        _content.deepCopy( &content );
    }

    void setFontSize( int fontSize, bool fontScaleGlobal )
    {
        _fontSize        = fontSize;
        _fontScaleGlobal = fontScaleGlobal;
    }

    void setAnchorArea( uint area )
    {
        _anchorArea = area;
    }

    void setAnchorPosition( KDChartEnums::PositionFlag position )
    {
        // Note if you change the parameters here, then you must also change them in wrappers/KDChartCustomBoxWrapper.h
        _anchorPos = position;
    }

    void setAnchorAlign( uint align )
    {
        _anchorAlign = align;
    }

    void setDataRow( uint dataRow )
    {
        _dataRow = dataRow;
    }

    void setDataCol( uint dataCol )
    {
        _dataCol = dataCol;
    }

    void setData3rd( uint data3rd )
    {
        _data3rd = data3rd;
    }

    void setDistanceAndSize( int deltaX,
                             int deltaY,
                             int width,
                             int height,
                             uint deltaAlign = KDCHART_AlignAuto,
                             bool deltaScaleGlobal = true )
    {
        _deltaX = deltaX;
        _deltaY = deltaY;
        _width = width;
        _height = height;
        _deltaAlign = deltaAlign;
        _deltaScaleGlobal = deltaScaleGlobal;
    }

    void setDistance( int deltaX,
                      int deltaY,
                      uint align = KDCHART_AlignAuto,
                      bool deltaScaleGlobal = true )
    {
        _deltaX = deltaX;
        _deltaY = deltaY;
        _deltaAlign = align;
        _deltaScaleGlobal = deltaScaleGlobal;
    }

    void setDeltaAlign( uint align,
                        bool deltaScaleGlobal = true )
    {
        _deltaAlign = align;
        _deltaScaleGlobal = deltaScaleGlobal;
    }

    void setDeltaScale( bool deltaScaleGlobal )
    {
        _deltaScaleGlobal = deltaScaleGlobal;
    }

    void setSize( int width, int height )
    {
        _width = width;
        _height = height;
    }

    void setColor( TQColor color )
    {
        _color = color;
    }

    void setPaper( const TQBrush & paper )
    {
        _paper = paper;
    }

    int rotation() const
    {
        return _rotation;
    }

    const KDChartTextPiece & content() const
    {
        return _content;
    }

    int fontSize() const
    {
        return _fontSize;
    }

    bool fontScaleGlobal() const
    {
        return _fontScaleGlobal;
    }

    uint anchorArea() const
    {
        return _anchorArea;
    }

    KDChartEnums::PositionFlag anchorPosition() const
    {
        return _anchorPos;
    }

    uint anchorAlign() const
    {
        return _anchorAlign;
    }

    uint dataRow() const
    {
        return _dataRow;
    }

    uint dataCol() const
    {
        return _dataCol;
    }

    uint data3rd() const
    {
        return _data3rd;
    }

    int deltaX() const
    {
        return _deltaX;
    }

    int deltaY() const
    {
        return _deltaY;
    }

    uint deltaAlign() const
    {
        return _deltaAlign;
    }

    bool deltaScaleGlobal() const
    {
        return _deltaScaleGlobal;
    }

    int width() const
    {
        return _width;
    }

    int height() const
    {
        return _height;
    }

    TQColor color() const
    {
        return _color;
    }

    const TQBrush & paper() const
    {
        return _paper;
    }
 
public:
    virtual ~KDChartCustomBox();

    void deepCopy( const KDChartCustomBox* source );
 

    const KDChartCustomBox* clone() const;
 
private:
    KDChartCustomBox( const KDChartCustomBox& ) : TQObject(0) {}
 
protected:
    void setInternalFlagAnchorBeingCalculated( bool flag ) const
    {
        KDChartCustomBox* that = const_cast<KDChartCustomBox*>(this);
        that->_anchorBeingCalculated = flag;
    }

    bool anchorBeingCalculated() const
    {
        return _anchorBeingCalculated;
    }
 
    void setParentAxisArea( int parentAxis ) const
    {
        KDChartCustomBox* that = const_cast<KDChartCustomBox*>(this);
        that->_parentAxisArea = parentAxis;
    }
 
    int parentAxisArea() const
    {
        return _parentAxisArea;
    }
 
private:
    int              _rotation;
    KDChartTextPiece _content;
    int              _fontSize;
    bool             _fontScaleGlobal;
    // Values to be transformed into a real rect at painting time.
    // If greater 0, values are exact, if less than 0, values are in per-mille
    // of the size of the drawing area.
    int _deltaX;
    int _deltaY;
    int _width;
    int _height;
 
    TQColor _color;
    TQBrush _paper;
 
    uint                       _anchorArea;
    KDChartEnums::PositionFlag _anchorPos;
    uint                       _anchorAlign;
    uint _dataRow;
    uint _dataCol;
    uint _data3rd;
    uint                       _deltaAlign;
    bool                       _deltaScaleGlobal;
    //
    // The following flag is NOT to be saved/restored in a file.
    //
    // Being a TEMPORARY flag preventing circular recursion
    // it must be set to   f a l s e
    // after loading a KDChartCustomBox from a file.
    bool _anchorBeingCalculated;
    int                        _parentAxisArea;
};
 

//TQTextStream& operator<<( TQTextStream& s, const KDChartCustomBox& p );
 

//TQTextStream& operator>>( TQTextStream& s, KDChartCustomBox& p );
 
 
#endif