Isis 3 Programmer Reference
Isis::ControlDisplayProperties Class Reference

This is the GUI communication mechanism for cubes. More...

#include <ControlDisplayProperties.h>

Inheritance diagram for Isis::ControlDisplayProperties:
Inheritance graph
Collaboration diagram for Isis::ControlDisplayProperties:
Collaboration graph

Classes

class  XmlHandler
 

Public Types

enum  Property { None = 0, Color = 1, Selected = 2, ShowLabel = 16 }
 This is a list of properties and actions that are possible. More...
 

Public Slots

void setColor (QColor newColor)
 Change the color associated with this cube. More...
 
void setShowLabel (bool)
 Change the visibility of the display name associated with this cube. More...
 
void setSelected (bool)
 Change the selected state associated with this cube. More...
 

Signals

void propertyChanged (ControlDisplayProperties *)
 
void supportAdded (Property)
 
void propertyChanged (DisplayProperties *)
 
void supportAdded (int)
 

Public Member Functions

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

Static Public Member Functions

static QColor randomColor ()
 Creates and returns a random color for the intial color of the footprint polygon. More...
 

Protected Member Functions

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

Private Slots

void toggleShowLabel ()
 Change the visibility of the display name. More...
 

Private Member Functions

 ControlDisplayProperties (const ControlDisplayProperties &)
 
ControlDisplayPropertiesoperator= (const ControlDisplayProperties &)
 
void setValue (Property prop, QVariant value)
 This is the generic mutator for properties. More...
 

Static Private Member Functions

static QList< ControlDisplayProperties * > senderToData (QObject *sender)
 This is for the slots that have a list of display properties as associated data. More...
 

Private Attributes

Property m_propertiesUsed
 This indicated whether any widgets with this DisplayProperties is using a particular property. More...
 
QMap< int, QVariant > * m_propertyValues
 This is a map from Property to value – the reason I use an int is so Qt knows how to serialize this QMap into binary data. More...
 

Detailed Description

This is the GUI communication mechanism for cubes.

This class is the connector between various GUI interfaces for cubes. We use this to communicate shared properties that various widgets need to know/should react to in a generic way.

This is how this class is supposed to "connect" widgets:

widgetA widgetB widgetC | | | ---—DisplayProperties ----—

When a user selects a cube in widgetA, widgetB and widgetC now have a chance to also select the same cube. This applies to all shared properties. Some of the properties are actions - such as zoomFit. This also allows a widget with no zooming (such as a list) to have an option to zoom (if any of the widgets support it*) and have that option work. There is no state associated with zoomFit - it's an action connected to a signal.

The proper way to detect a cube going away is to connect to the destroyed signal (from the parent QObject). Once that is emitted you cannot call any methods on this object.

Author
2012-06-12 Ken Edmundson
History:
2012-06-12 Ken Edmundson - Creation.

Definition at line 73 of file ControlDisplayProperties.h.

Member Enumeration Documentation

◆ Property

This is a list of properties and actions that are possible.

Enumerator
None 

Null display property for bit-flag purposes.

Color 

The color of the control net, default randomized (QColor)

Selected 

The selection state of this control net (bool)

ShowLabel 

True if the control net should show its display name (bool)

Definition at line 79 of file ControlDisplayProperties.h.

Constructor & Destructor Documentation

◆ ControlDisplayProperties()

Isis::ControlDisplayProperties::ControlDisplayProperties ( QString  displayName,
QObject parent = NULL 
)

ControlDisplayProperties constructor.

This sets default values and constructs the object *.

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

Definition at line 26 of file ControlDisplayProperties.cpp.

References m_propertiesUsed, m_propertyValues, None, randomColor(), setSelected(), setShowLabel(), and setValue().

◆ ~ControlDisplayProperties()

Isis::ControlDisplayProperties::~ControlDisplayProperties ( )
virtual

destructor

Definition at line 53 of file ControlDisplayProperties.cpp.

Member Function Documentation

◆ addSupport() [1/2]

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

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

Parameters
propThe property you are adding support for

Definition at line 100 of file DisplayProperties.cpp.

References Isis::DisplayProperties::m_propertiesUsed, and Isis::DisplayProperties::supports().

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

◆ addSupport() [2/2]

void Isis::ControlDisplayProperties::addSupport ( Property  prop)

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

Parameters
propThe property you are adding support for

Definition at line 63 of file ControlDisplayProperties.cpp.

References m_propertiesUsed, and supports().

◆ displayName()

◆ getValue() [1/2]

◆ getValue() [2/2]

QVariant Isis::ControlDisplayProperties::getValue ( Property  prop) const

Get a property's associated data.

Parameters
propThe property

Definition at line 87 of file ControlDisplayProperties.cpp.

References m_propertyValues.

Referenced by toggleShowLabel().

◆ randomColor()

QColor Isis::ControlDisplayProperties::randomColor ( )
static

Creates and returns a random color for the intial color of the footprint polygon.

Definition at line 96 of file ControlDisplayProperties.cpp.

Referenced by ControlDisplayProperties().

◆ senderToData()

QList< ControlDisplayProperties * > Isis::ControlDisplayProperties::senderToData ( QObject senderObj)
staticprivate

This is for the slots that have a list of display properties as associated data.

This gets that list out of the data.

Definition at line 233 of file ControlDisplayProperties.cpp.

Referenced by toggleShowLabel().

◆ setColor

void Isis::ControlDisplayProperties::setColor ( QColor  newColor)
slot

Change the color associated with this cube.

Definition at line 135 of file ControlDisplayProperties.cpp.

References setValue().

◆ setDisplayName()

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

Sets display name.

Parameters
displayNameDisplay name of the object.

Definition at line 89 of file DisplayProperties.cpp.

References Isis::DisplayProperties::displayName(), and Isis::DisplayProperties::m_displayName.

◆ setSelected

void Isis::ControlDisplayProperties::setSelected ( bool  newValue)
slot

Change the selected state associated with this cube.

Definition at line 143 of file ControlDisplayProperties.cpp.

References Selected, and setValue().

Referenced by ControlDisplayProperties().

◆ setShowLabel

void Isis::ControlDisplayProperties::setShowLabel ( bool  newValue)
slot

Change the visibility of the display name associated with this cube.

Definition at line 151 of file ControlDisplayProperties.cpp.

References setValue(), and ShowLabel.

Referenced by ControlDisplayProperties(), and toggleShowLabel().

◆ setValue() [1/2]

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

◆ setValue() [2/2]

void Isis::ControlDisplayProperties::setValue ( Property  prop,
QVariant  value 
)
private

This is the generic mutator for properties.

Given a value, this will change it and emit propertyChanged if its different and supported.

Definition at line 218 of file ControlDisplayProperties.cpp.

References m_propertyValues, and supports().

Referenced by ControlDisplayProperties(), setColor(), setSelected(), and setShowLabel().

◆ supports() [1/2]

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

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

Returns
True if the property has support, false otherwise

Definition at line 114 of file DisplayProperties.cpp.

References Isis::DisplayProperties::m_propertiesUsed.

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

◆ supports() [2/2]

bool Isis::ControlDisplayProperties::supports ( Property  prop)

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

Returns
True if the property has support, false otherwise

Definition at line 77 of file ControlDisplayProperties.cpp.

References m_propertiesUsed.

Referenced by addSupport(), and setValue().

◆ toggleShowLabel

void Isis::ControlDisplayProperties::toggleShowLabel ( )
privateslot

Change the visibility of the display name.

This should only be connected to by an action with a list of displays as its data. This synchronizes all of the values where at least one is guaranteed to be toggled.

Definition at line 161 of file ControlDisplayProperties.cpp.

References getValue(), senderToData(), setShowLabel(), and ShowLabel.

◆ toPvl()

PvlObject Isis::DisplayProperties::toPvl ( ) const
inherited

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.

Definition at line 60 of file DisplayProperties.cpp.

References Isis::DisplayProperties::displayName().

Member Data Documentation

◆ m_propertiesUsed

Property Isis::ControlDisplayProperties::m_propertiesUsed
private

This indicated whether any widgets with this DisplayProperties is using a particular property.

This helps others who can set but not display know whether they should give the option to set.

Definition at line 156 of file ControlDisplayProperties.h.

Referenced by addSupport(), ControlDisplayProperties(), and supports().

◆ m_propertyValues

QMap<int, QVariant>* Isis::ControlDisplayProperties::m_propertyValues
private

This is a map from Property to value – the reason I use an int is so Qt knows how to serialize this QMap into binary data.

Definition at line 162 of file ControlDisplayProperties.h.

Referenced by ControlDisplayProperties(), getValue(), and setValue().


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