Isis Developer Reference
Isis::DisplayProperties Class Reference

#include <DisplayProperties.h>

Inheritance diagram for Isis::DisplayProperties:
Inheritance graph
Collaboration diagram for Isis::DisplayProperties:
Collaboration graph

Signals

void propertyChanged (DisplayProperties *)
 
void supportAdded (int)
 

Public Member Functions

 DisplayProperties (QString displayName, QObject *parent=NULL)
 DisplayProperties constructor.
 
 DisplayProperties (XmlStackedHandlerReader *xmlReader, QObject *parent=NULL)
 
virtual ~DisplayProperties ()
 destructor
 
void fromPvl (const PvlObject &pvl)
 
void save (QXmlStreamWriter &stream, const Project *project, FileName newProjectRoot) const
 Output format:
 
PvlObject toPvl () const
 Convert to Pvl for project files.
 
void addSupport (int property)
 Call this with every property you support, otherwise they will not communicate properly between widgets.
 
bool supports (int property)
 Support may come later, please make sure you are connected to the supportAdded signal.
 
QVariant getValue (int property) const
 Get a property's associated data.
 
void setDisplayName (QString displayName)
 Sets display name.
 
QString displayName () const
 Returns the display name.
 

Static Public Member Functions

static QColor randomColor ()
 

Protected Member Functions

void setValue (int prop, QVariant value)
 This is the generic mutator for properties.
 

Detailed Description

Author
2012-??-?? ???

Constructor & Destructor Documentation

◆ DisplayProperties() [1/2]

Isis::DisplayProperties::DisplayProperties ( QString displayName,
QObject * parent = NULL )

DisplayProperties constructor.

This sets default values and constructs the Cube *. You cannot have much more than 1K of these without calling closeCube().

Parameters
displayNameThe filename (fully expanded) of the object.
parentQt parent object (this is destroyed when parent is destroyed)

References displayName().

◆ DisplayProperties() [2/2]

Isis::DisplayProperties::DisplayProperties ( XmlStackedHandlerReader * xmlReader,
QObject * parent = NULL )

◆ ~DisplayProperties()

Isis::DisplayProperties::~DisplayProperties ( )
virtual

destructor

Member Function Documentation

◆ addSupport()

void Isis::DisplayProperties::addSupport ( int property)

Call this with every property you support, otherwise they will not communicate properly between widgets.

Parameters
propThe property you are adding support for

References supportAdded(), and supports().

Referenced by Isis::ImageTreeWidgetItem::ImageTreeWidgetItem(), and Isis::MosaicSceneItem::MosaicSceneItem().

◆ displayName()

◆ fromPvl()

void Isis::DisplayProperties::fromPvl ( const PvlObject & pvl)

◆ getValue()

QVariant Isis::DisplayProperties::getValue ( int property) const

◆ propertyChanged

void Isis::DisplayProperties::propertyChanged ( DisplayProperties * )
signal

Referenced by setValue().

◆ randomColor()

static QColor Isis::DisplayProperties::randomColor ( )
static

◆ save()

void Isis::DisplayProperties::save ( QXmlStreamWriter & stream,
const Project * project,
FileName newProjectRoot ) const

Output format:

<displayProperties displayName="..."> Hex-encoded data </displayProperties>

References displayName().

Referenced by Isis::Image::save().

◆ setDisplayName()

void Isis::DisplayProperties::setDisplayName ( QString displayName)

Sets display name.

Parameters
displayNameDisplay name of the object.

References displayName().

Referenced by fromPvl().

◆ setValue()

void Isis::DisplayProperties::setValue ( int property,
QVariant value )
protected

◆ supportAdded

void Isis::DisplayProperties::supportAdded ( int )
signal

Referenced by addSupport().

◆ supports()

bool Isis::DisplayProperties::supports ( int property)

Support may come later, please make sure you are connected to the supportAdded signal.

Returns
True if the property has support, false otherwise

Referenced by addSupport(), Isis::ImageList::allSupport(), and setValue().

◆ toPvl()

PvlObject Isis::DisplayProperties::toPvl ( ) const

Convert to Pvl for project files.

This stores all of the data associated with all of the properties (but not what is supported). This also stores the cube filename.

References displayName().

Referenced by Isis::Image::toPvl(), and Isis::Shape::toPvl().


The documentation for this class was generated from the following files: