Utils.h

Go to the documentation of this file.

/*  Copyright (C) 2001-2009 National Institute For Space Research (INPE) - Brazil.

    This file is part of the TerraLib - a Framework for building GIS enabled applications.

    TerraLib is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License,
    or (at your option) any later version.

    TerraLib is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with TerraLib. See COPYING. If not, write to
    TerraLib Team at <terralib-team@terralib.org>.
*/

/*!
  \file terralib/qt/widgets/charts/Utils.h

  \brief This file contains a set of utility chart functions
*/

#ifndef __TERRALIB_QT_WIDGETS_INTERNAL_CHARTUTILS_H
#define __TERRALIB_QT_WIDGETS_INTERNAL_CHARTUTILS_H

//TerraLib
#include "../Config.h"

//QWT
#include <qwt_text.h>
#include <qwt_symbol.h>

//STL
#include <vector>

namespace te
{
  // Forward declarations
  namespace color { class RGBAColor; }
  namespace se    { class Font; class Fill; class Stroke; class Mark; class Graphic;}
  namespace da    { class DataSet; class DataSetType; class ObjectId; }
  namespace dt    { class DateTime; }

  namespace qt
  {

    namespace widgets
    {      

    class Scatter;
    class Histogram;
    class ChartDisplayWidget;

    /*!
        \brief Scatter Creator

        \param dataset The dataset that will be used to populate the scatter's data
        \param dataType The dataType that will be used to recover the objectIds associated with the given dataset.
        \param propX The id of the property that contains the data of the x axis.
        \param propY The id of the property that contains the data of the y axis.

        \note It will traverse the data set, using the moveNext() method
        \note It will not take the ownership of the "dataset" pointer.
        \note It will not take the ownership of the "dataType" pointer.
        \note The caller will take the ownership of the returned scatter pointer.

        \return a new Scatter
    */
    TEQTWIDGETSEXPORT Scatter* createScatter(te::da::DataSet* dataset, te::da::DataSetType* dataType, int propX, int propY);

    /*!
        \brief Scatter Creator

        \param dataset The dataset that will be used to populate the scatter's data
        \param dataType The dataType that will be used to recover the objectIds associated with the given dataset.
        \param propX The id of the property that contains the data of the x axis.
        \param propY The id of the property that contains the data of the y axis.

        \note It will traverse the data set, using the moveNext() method
        \note It will not take the ownership of the "dataset" pointer.
        \note It will not take the ownership of the "dataType" pointer.
        \note The caller will take the ownership of the returned ChartDisplayWidget pointer.

    */
    TEQTWIDGETSEXPORT ChartDisplayWidget* createScatterDisplay(te::da::DataSet* dataset, te::da::DataSetType* dataType, int propX, int propY);

    /*!
        \brief Histogram Creator

        \param dataset The dataset that will be used to populate the histogram's data
        \param dataType The dataType that will be used to recover the objectIds associated with the given dataset.
        \param propId The id of the property that contains the data
        \param slices The desired number of intervals

        \note It will traverse the data set, using the moveNext() method
        \note It will not take the ownership of the "dataset" pointer.
        \note It will not take the ownership of the "dataType" pointer.
        \note The caller will take the ownership of the returned histogram pointer.

        \return a new Histogram
    */
    TEQTWIDGETSEXPORT Histogram* createHistogram(te::da::DataSet* dataset, te::da::DataSetType* dataType, int propId, int slices);

    /*!
        \brief Histogram Creator

        \param dataset The dataset that will be used to populate the histogram's data
        \param dataType The dataType that will be used to recover the objectIds associated with the given dataset.
        \param propId The id of the property that contains the data

        \note This version is used to create a histogram based on a set of labels (Strings), therefore there is no user-defined number of intervals, each unique label is an interval
        \note It will traverse the data set, using the moveNext() method
        \note It will not take the ownership of the "dataset" pointer.
        \note It will not take the ownership of the "dataType" pointer. 
        \note The caller will take the ownership of the returned histogram pointer.

        \return a new Histogram
    */
    TEQTWIDGETSEXPORT Histogram* createHistogram(te::da::DataSet* dataset, te::da::DataSetType* dataType, int propId);

    /*!
        \brief Histogram Creator

        \param dataset The dataset that will be used to populate the histogram's data
        \param dataType The dataType that will be used to recover the objectIds associated with the given dataset.
        \param propId The id of the property that contains the data
        \param slices The desired number of intervals, the default is 10 and this parameter is not used when the preperty is a string

        \note It will traverse the data set, using the moveNext() method
        \note It will not take the ownership of the "dataset" pointer.
        \note It will not take the ownership of the "dataType" pointer. 
        \note The caller will take the ownership of the returned ChartDisplayWidget pointer.

    */
    TEQTWIDGETSEXPORT ChartDisplayWidget* createHistogramDisplay(te::da::DataSet* dataset, te::da::DataSetType* dataType, int propId, int slices = 10);

    /*!
        \function Terralib2Qwt

        This function returns a default QwtText.

        \param title A text.
        
        \return A QwtText

        \note The caller will take the ownership of the returned pointer.
      */
      TEQTWIDGETSEXPORT QwtText* Terralib2Qwt(const std::string& title);
      
      
      /*!
        \function Terralib2Qwt

        This function translates TerraLib text styles into a QwtText.

        \param text A text
        \param color The text's color
        \param font The text's font
        \param backFill The text's background fill
        \param backStroke The text's background stroke
        
        \return A QwtText

        \note The caller will take the ownership of the returned pointer.
        \note It will not take the ownership of given "font", "backFill" and "backStroke"" pointers.
      */
      TEQTWIDGETSEXPORT QwtText* Terralib2Qwt(const std::string& text,  te::color::RGBAColor* color, 
                   te::se::Font*  font, te::se::Fill* backFill, 
                   te::se::Stroke* backStroke);

      /*!
        \function Mark2Symbol

        This function translates a terralib's Graphic object into a QWTSymbol object.

        \param graphic The graphic that will be used to generate the symbol.
        
        \return A QwtSymbol

        \note The caller will take the ownership of the returned pointer.
        \note It will not take the ownership of the Graphic pointer.
      */
      TEQTWIDGETSEXPORT QwtSymbol* Terralib2Qwt(te::se::Graphic* graphic);

    } // end namespace widgets
  }   // end namespace qt
}     // end namespace te

#endif  // __TERRALIB_QT_WIDGETS_INTERNAL_CHARTUTILS_H