mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-26 00:02:08 -05:00
4f92277e47
git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@4234 c8812cc2-4d05-0410-92ff-de0c093fc19c
320 lines
11 KiB
C++
320 lines
11 KiB
C++
/***************************************************************************
|
|
plugin.cpp
|
|
Import tool for various worldmap analysis output files
|
|
Functions:
|
|
|
|
-------------------
|
|
begin : Jan 21, 2004
|
|
copyright : (C) 2004 by Tim Sutton
|
|
email : tim@linfiniti.com
|
|
|
|
***************************************************************************/
|
|
|
|
/***************************************************************************
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
***************************************************************************/
|
|
/* $Id$ */
|
|
|
|
// includes
|
|
|
|
#include <qgisapp.h>
|
|
#include <qgsmaplayer.h>
|
|
#include "plugin.h"
|
|
#include <qgsproject.h>
|
|
#include <qgsmapcanvas.h>
|
|
|
|
#include <q3toolbar.h>
|
|
#include <qmenubar.h>
|
|
#include <qmessagebox.h>
|
|
#include <q3popupmenu.h>
|
|
#include <qlineedit.h>
|
|
#include <qaction.h>
|
|
#include <qapplication.h>
|
|
#include <qcursor.h>
|
|
#include <qpixmap.h>
|
|
#include <qpainter.h>
|
|
#include <qfont.h>
|
|
#include <qrect.h>
|
|
#include <qbrush.h>
|
|
#include <q3button.h>
|
|
#include <qcheckbox.h>
|
|
#include <q3paintdevicemetrics.h>
|
|
#include <qglobal.h>
|
|
|
|
//non qt includes
|
|
#include <iostream>
|
|
|
|
//the gui subclass
|
|
#include "plugingui.h"
|
|
|
|
// xpm for creating the toolbar icon
|
|
#include "icon.xpm"
|
|
|
|
#ifdef WIN32
|
|
#define QGISEXTERN extern "C" __declspec( dllexport )
|
|
#else
|
|
#define QGISEXTERN extern "C"
|
|
#endif
|
|
|
|
static const char * const ident_ = "$Id$";
|
|
|
|
static const char * const name_ = "CopyrightLabel";
|
|
static const char * const description_ = "This plugin overlays copyright information on the rendered map.";
|
|
static const char * const version_ = "Version 0.1";
|
|
static const QgisPlugin::PLUGINTYPE type_ = QgisPlugin::UI;
|
|
|
|
|
|
/**
|
|
* Constructor for the plugin. The plugin is passed a pointer to the main app
|
|
* and an interface object that provides access to exposed functions in QGIS.
|
|
* @param qgis Pointer to the QGIS main window
|
|
* @param _qI Pointer to the QGIS interface object
|
|
*/
|
|
QgsCopyrightLabelPlugin::QgsCopyrightLabelPlugin(QgisApp * theQGisApp,
|
|
QgisIface * theQgisInterFace):
|
|
QgisPlugin(name_,description_,version_,type_),
|
|
qgisMainWindowPointer(theQGisApp),
|
|
qGisInterface(theQgisInterFace)
|
|
{}
|
|
|
|
QgsCopyrightLabelPlugin::~QgsCopyrightLabelPlugin()
|
|
{}
|
|
|
|
/*
|
|
* Initialize the GUI interface for the plugin
|
|
*/
|
|
void QgsCopyrightLabelPlugin::initGui()
|
|
{
|
|
Q3PopupMenu *pluginMenu = qGisInterface->getPluginMenu("&Decorations");
|
|
menuId = pluginMenu->insertItem(QIcon(icon),"&CopyrightLabel", this, SLOT(run()));
|
|
|
|
pluginMenu->setWhatsThis(menuId, "Creates a copyright label that is displayed on the map canvas.");
|
|
|
|
// Create the action for tool
|
|
#if QT_VERSION < 0x040000
|
|
myQActionPointer = new QAction("Copyright Label", QIcon(icon), "&Wmi",0, this, "run");
|
|
#else
|
|
myQActionPointer = new QAction(QIcon(icon), "Copyright Label", this);
|
|
#endif
|
|
myQActionPointer->setWhatsThis("Creates a copyright label that is displayed on the map canvas.");
|
|
// Connect the action to the run
|
|
connect(myQActionPointer, SIGNAL(activated()), this, SLOT(run()));
|
|
// This calls the renderer everytime the cnavas has drawn itself
|
|
connect(qGisInterface->getMapCanvas(), SIGNAL(renderComplete(QPainter *)), this, SLOT(renderLabel(QPainter *)));
|
|
//this resets this plugin up if a project is loaded
|
|
connect(qgisMainWindowPointer, SIGNAL(projectRead()), this, SLOT(projectRead()));
|
|
|
|
// Add the icon to the toolbar
|
|
qGisInterface->addToolBarIcon(myQActionPointer);
|
|
//initialise default values in the gui
|
|
projectRead();
|
|
}
|
|
|
|
void QgsCopyrightLabelPlugin::projectRead()
|
|
{
|
|
#ifdef QGISDEBUG
|
|
std::cout << "+++++++++ Copyright plugin - project read slot called...." << std::endl;
|
|
#endif //default text to start with - try to fetch it from qgsproject
|
|
|
|
|
|
mQFont.setFamily(QgsProject::instance()->readEntry("CopyrightLabel","/FontName","Arial"));
|
|
mQFont.setPointSize(QgsProject::instance()->readNumEntry("CopyrightLabel","/FontSize",14));
|
|
mLabelQString = QgsProject::instance()->readEntry("CopyrightLabel","/Label","(c) QGIS 2004");
|
|
mPlacement = QgsProject::instance()->readEntry("CopyrightLabel","/Placement","Bottom Right");
|
|
mEnable = QgsProject::instance()->readBoolEntry("CopyrightLabel","/Enabled",true);
|
|
// todo - read & store state of font color
|
|
mLabelQColor = QColor(Qt::black);
|
|
}
|
|
//method defined in interface
|
|
void QgsCopyrightLabelPlugin::help()
|
|
{
|
|
//implement me!
|
|
}
|
|
|
|
// Slot called when the buffer menu item is activated
|
|
void QgsCopyrightLabelPlugin::run()
|
|
{
|
|
QgsCopyrightLabelPluginGui *myPluginGui=new QgsCopyrightLabelPluginGui(qgisMainWindowPointer,"Copyright Label",true,0);
|
|
//listen for when the layer has been made so we can draw it
|
|
//connect(myPluginGui, SIGNAL(drawRasterLayer(QString)), this, SLOT(drawRasterLayer(QString)));
|
|
//connect(myPluginGui, SIGNAL(drawVectorLayer(QString,QString,QString)), this, SLOT(drawVectorLayer(QString,QString,QString)));
|
|
//refresh the canvas when the user presses ok
|
|
connect(myPluginGui, SIGNAL(refreshCanvas()), this, SLOT(refreshCanvas()));
|
|
connect(myPluginGui, SIGNAL(changeFont(QFont )), this, SLOT(setFont(QFont )));
|
|
connect(myPluginGui, SIGNAL(changeLabel(QString )), this, SLOT(setLabel(QString )));
|
|
connect(myPluginGui, SIGNAL(changeColor(QColor)), this, SLOT(setColor(QColor)));
|
|
connect(myPluginGui, SIGNAL(changePlacement(QString)), this, SLOT(setPlacement(QString)));
|
|
connect(myPluginGui, SIGNAL(enableCopyrightLabel(bool)), this, SLOT(setEnable(bool)));
|
|
myPluginGui->setText(mLabelQString);
|
|
myPluginGui->setPlacement(mPlacement);
|
|
myPluginGui->show();
|
|
}
|
|
//! Refresh the map display using the mapcanvas exported via the plugin interface
|
|
void QgsCopyrightLabelPlugin::refreshCanvas()
|
|
{
|
|
qGisInterface->getMapCanvas()->refresh();
|
|
}
|
|
|
|
void QgsCopyrightLabelPlugin::renderLabel(QPainter * theQPainter)
|
|
{
|
|
//Large IF statement to enable/disable copyright label
|
|
if (mEnable)
|
|
{
|
|
//@todo softcode this!myQSimpleText.height()
|
|
// need width/height of paint device
|
|
Q3PaintDeviceMetrics myMetrics( theQPainter->device() );
|
|
int myHeight = myMetrics.height();
|
|
int myWidth = myMetrics.width();
|
|
//hard coded cludge for getting a colorgroup. Needs to be replaced
|
|
Q3Button * myQButton =new Q3Button();
|
|
QColorGroup myQColorGroup = myQButton->colorGroup();
|
|
|
|
Q3SimpleRichText myQSimpleText(mLabelQString, mQFont);
|
|
myQSimpleText.setWidth( theQPainter, myWidth-10 );
|
|
|
|
//Get canvas dimensions
|
|
int myYOffset = myHeight;
|
|
int myXOffset = myWidth;
|
|
|
|
|
|
//Determine placement of label from form combo box
|
|
if (mPlacement==tr("Bottom Left"))
|
|
{
|
|
//Define bottom left hand corner start point
|
|
myYOffset = myYOffset - (myQSimpleText.height()+5);
|
|
myXOffset = 5;
|
|
}
|
|
else if (mPlacement==tr("Top Left"))
|
|
{
|
|
//Define top left hand corner start point
|
|
myYOffset = 5;
|
|
myXOffset = 5;
|
|
}
|
|
else if (mPlacement==tr("Top Right"))
|
|
{
|
|
//Define top right hand corner start point
|
|
myYOffset = 5;
|
|
myXOffset = myXOffset - (myQSimpleText.widthUsed()+5);
|
|
}
|
|
else // defaulting to bottom right
|
|
{
|
|
//Define bottom right hand corner start point
|
|
myYOffset = myYOffset - (myQSimpleText.height()+5);
|
|
myXOffset = myXOffset - (myQSimpleText.widthUsed()+5);
|
|
}
|
|
|
|
//Paint label to canvas
|
|
QRect myRect(myXOffset,myYOffset,myQSimpleText.widthUsed(),myQSimpleText.height());
|
|
myQSimpleText.draw (theQPainter, myXOffset, myYOffset, myRect, myQColorGroup);
|
|
|
|
}
|
|
}
|
|
// Unload the plugin by cleaning up the GUI
|
|
void QgsCopyrightLabelPlugin::unload()
|
|
{
|
|
// remove the GUI
|
|
qGisInterface->removePluginMenuItem("&Decorations",menuId);
|
|
qGisInterface->removeToolBarIcon(myQActionPointer);
|
|
// remove the copyright from the canvas
|
|
disconnect(qGisInterface->getMapCanvas(), SIGNAL(renderComplete(QPainter *)),
|
|
this, SLOT(renderLabel(QPainter *)));
|
|
refreshCanvas();
|
|
|
|
delete myQActionPointer;
|
|
}
|
|
|
|
|
|
//! change the copyright font
|
|
void QgsCopyrightLabelPlugin::setFont(QFont theQFont)
|
|
{
|
|
mQFont = theQFont;
|
|
//save state to the project file.....
|
|
QgsProject::instance()->writeEntry("CopyrightLabel","/FontName",theQFont.family());
|
|
//save state to the project file.....
|
|
QgsProject::instance()->writeEntry("CopyrightLabel","/FontSize", theQFont.pointSize() );
|
|
refreshCanvas();
|
|
}
|
|
//! change the copyright text
|
|
void QgsCopyrightLabelPlugin::setLabel(QString theLabelQString)
|
|
{
|
|
mLabelQString = theLabelQString;
|
|
QgsProject::instance()->writeEntry("CopyrightLabel","/Label", mLabelQString );
|
|
refreshCanvas();
|
|
}
|
|
//! change the copyright text colour
|
|
void QgsCopyrightLabelPlugin::setColor(QColor theQColor)
|
|
{
|
|
mLabelQColor = theQColor;
|
|
QgsProject::instance()->writeEntry("CopyrightLabel","/ColorRedPart", mLabelQColor.red());
|
|
QgsProject::instance()->writeEntry("CopyrightLabel","/ColorGreenPart", mLabelQColor.green());
|
|
QgsProject::instance()->writeEntry("CopyrightLabel","/ColorBluePart", mLabelQColor.blue());
|
|
refreshCanvas();
|
|
}
|
|
|
|
//! set placement of copyright label
|
|
void QgsCopyrightLabelPlugin::setPlacement(QString theQString)
|
|
{
|
|
mPlacement = theQString;
|
|
QgsProject::instance()->writeEntry("CopyrightLabel","/Placement", mPlacement);
|
|
refreshCanvas();
|
|
}
|
|
|
|
//! set whether copyright label is enabled
|
|
void QgsCopyrightLabelPlugin::setEnable(bool theBool)
|
|
{
|
|
mEnable = theBool;
|
|
QgsProject::instance()->writeEntry("CopyrightLabel","/Enabled", mEnable );
|
|
refreshCanvas();
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
* Required extern functions needed for every plugin
|
|
* These functions can be called prior to creating an instance
|
|
* of the plugin class
|
|
*/
|
|
// Class factory to return a new instance of the plugin class
|
|
QGISEXTERN QgisPlugin * classFactory(QgisApp * theQGisAppPointer, QgisIface * theQgisInterfacePointer)
|
|
{
|
|
return new QgsCopyrightLabelPlugin(theQGisAppPointer, theQgisInterfacePointer);
|
|
}
|
|
|
|
// Return the name of the plugin - note that we do not user class members as
|
|
// the class may not yet be insantiated when this method is called.
|
|
QGISEXTERN QString name()
|
|
{
|
|
return name_;
|
|
}
|
|
|
|
// Return the description
|
|
QGISEXTERN QString description()
|
|
{
|
|
return description_;
|
|
}
|
|
|
|
// Return the type (either UI or MapLayer plugin)
|
|
QGISEXTERN int type()
|
|
{
|
|
return type_;
|
|
}
|
|
|
|
// Return the version number for the plugin
|
|
QGISEXTERN QString version()
|
|
{
|
|
return version_;
|
|
}
|
|
|
|
// Delete ourself
|
|
QGISEXTERN void unload(QgisPlugin * thePluginPointer)
|
|
{
|
|
delete thePluginPointer;
|
|
}
|