kstars
#include <imageexporter.h>

Public Slots | |
| bool | exportImage (QString url) | 
| Legend * | getLegend () | 
| void | includeLegend (bool include) | 
| void | setLegendAlpha (int alpha) | 
| void | setLegendProperties (Legend::LEGEND_TYPE type, Legend::LEGEND_ORIENTATION orientation, Legend::LEGEND_POSITION position, int alpha=160, bool include=true) | 
| void | setRasterOutputSize (const QSize *size) | 
Public Member Functions | |
| ImageExporter (QObject *parent) | |
| ~ImageExporter () | |
| QString | getLastErrorMessage () const | 
Detailed Description
Backends for exporting a sky image, either raster or vector, with a legend.
Definition at line 35 of file imageexporter.h.
Constructor & Destructor Documentation
| ImageExporter::ImageExporter | ( | QObject * | parent | ) | 
Constructor.
Definition at line 32 of file imageexporter.cpp.
| ImageExporter::~ImageExporter | ( | ) | 
Destructor.
Definition at line 262 of file imageexporter.cpp.
Member Function Documentation
      
  | 
  slot | 
Exports an image with the defined settings.
- Parameters
 - 
  
url URL of the exported image  
- Returns
 - false if the URL was a network location and uploading to the network location failed
 
- Note
 - This method calls an SVG backend instead if the file extension is svg. Otherwise, it draws raster.
 
Definition at line 182 of file imageexporter.cpp.
      
  | 
  inline | 
- Returns
 - last error message
 
Definition at line 54 of file imageexporter.h.
      
  | 
  inlineslot | 
- Returns
 - a pointer to the legend used
 
Definition at line 97 of file imageexporter.h.
      
  | 
  inlineslot | 
Include legend?
- Parameters
 - 
  
include The legend will be included if the flag is set to true  
Definition at line 79 of file imageexporter.h.
      
  | 
  slot | 
Set legend transparency.
- Parameters
 - 
  
alpha Transparency level  
Definition at line 275 of file imageexporter.cpp.
      
  | 
  slot | 
Set the legend properties.
- Parameters
 - 
  
type Legend type. (See enum LEGEND_TYPE in legend.h) orientation Legend orientation. (See LEGEND_ORIENTATION in legend.h) position Legend position. (See LEGEND_POSITION in legend.h) alpha Legend alpha (transparency). Default value is 160. include Include the legend?  
Definition at line 246 of file imageexporter.cpp.
      
  | 
  slot | 
Set the size of output raster images.
- Parameters
 - 
  
size a pointer to a QSize containing the size of images. If a null pointer is supplied, the SkyMap size is used.  
- Note
 - If size is larger than the skymap size, then the sky image is padded; if it is smaller, then it is cropped. No rescaling is done.
 
Definition at line 267 of file imageexporter.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:36:22 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.
    KDE API Reference