Legend.h

Go to the documentation of this file.

//==============================================================================================
//  FILENAME    :   Legend.h
//  AUTHOR      :   Xin Liu
//  CREATION    :   5/20/08
//  Copyright (C) MicroStrategy, Inc. 2008
//==============================================================================================


#ifndef MSICHART_LEGEND_H
#define MSICHART_LEGEND_H

#include "GraphObjectManager.h"
#include "../Dataset.h"
#include "GraphCollectionObject.h"
#include "StraightLineObject.h"

namespace MsiChart
{
    enum EnumLegendLayout
    {
        LL_LegendFreeFloat,
        LL_LegendOnRightSide,
        LL_LegendOnLeftSide,
        LL_LegendBelowChart
    }; 

    enum EnumLegendType
    {
        LT_UNDEFINED,
        LT_ITEMD,
        LT_RANGE,
    };
    

    enum EnumLegendMarkersStyle
    {
        LMS_MarkerstoLeftofText,
        LMS_MarkerstoRightofText,
        LMS_TextCenteronMarkers,
        LMS_MarkersAboveText,
        LMS_MarkersBelowText
    };

    typedef enum
    {
        LegendRows,
        LegendLocked,
        LegendFancyWidthInset,
        LegendFancyHeightInset,
        LegendLegendElementWidth,
        LegendLegendElementHeight,
    }EnumLegendDetails;


    class Legend: public GraphObjectManager
    {
    public:
        typedef MSynch::SmartPtr<Legend> Ptr;

        Legend(const TripleId& irTripleId, GraphObjectManager* ipManager, Dataset::Ptr iDatasetPtr, Rect2D iArea);
        ~Legend();

        virtual void Draw();
        virtual void GenerateMapAndList();
        virtual void GetOptions(Int32 iPropertyId, CComVariant* opValue) const;
        virtual void GetOptions(Int32 iSeriesId, Int32 iPropertyId, CComVariant* opValue) const;

        virtual bool SetFormatLineOfLegendMarkerLine(FormatLine::Ptr iFormatLine, Int32 iSeriesId, bool iIsLineVertical = false);
        
        const Rect2D& GetLegendArea();

        virtual bool IsByGroup() const; //For grid chart
        
        virtual void UpdateFormatForLegendMarker(Int32 iIndex, FormatFill::Ptr iFormatFill, FormatLine::Ptr iFormatLine, bool iIsLineAssignedToLegnedMarkerLine = false, bool iIsLineVertical = false);

        void CalculateFrame(Int32 iWidthMargin, Int32 iHeightMargin, Rect2D& orArea);

        virtual Int32 GetItemCount(); 

        EnumLegendType GetType();


    protected:
        Dataset::Ptr mDatasetPtr;               
        Rect2D mLegendArea;                     
        Rect2D mArea;                           
        EnumLegendType mType;                   

        virtual Int32 hGetLegendPosition();         
    };

    inline EnumLegendType Legend::GetType()
    {
        return mType;
    }
}

#endif