Isis::ImageList Class Reference

#include <ImageList.h>

Inherits QObject, and QList< Image * >.

Classes
class	CopyImageDataFunctor
	This functor is used for copying the images between two projects quickly.
class	XmlHandler

Signals
void	countChanged (int newCount)

Public Member Functions
	ImageList (QString name, QString path, QObject *parent=NULL)
	Create an image list from an image list name and path (does not read Images).
	ImageList (QObject *parent=NULL)
	Create a blank image list.
	ImageList (QList< Image * >, QObject *parent=NULL)
	Create an image list from a list of images.
	ImageList (Project *project, XmlStackedHandlerReader *xmlReader, QObject *parent=NULL)
	Create an image list from XML.
	ImageList (QStringList &)
	Create an image list from a list of cube file names.
	ImageList (const ImageList &)
	Copy constructor.
	~ImageList ()
	Destructor.
void	append (Image *const &value)
void	append (const QList< Image * > &value)
void	clear ()
iterator	erase (iterator pos)
iterator	erase (iterator begin, iterator end)
void	insert (int i, Image *const &value)
iterator	insert (iterator before, Image *const &value)
void	prepend (Image *const &value)
void	push_back (Image *const &value)
void	push_front (Image *const &value)
int	removeAll (Image *const &value)
void	removeAt (int i)
void	removeFirst ()
void	removeLast ()
bool	removeOne (Image *const &value)
void	swap (QList< Image * > &other)
Image *	takeAt (int i)
Image *	takeFirst ()
Image *	takeLast ()
ImageList &	operator+= (const QList< Image * > &other)
ImageList &	operator+= (Image *const &other)
ImageList &	operator<< (const QList< Image * > &other)
ImageList &	operator<< (Image *const &other)
ImageList &	operator= (const QList< Image * > &rhs)
ImageList &	operator= (const ImageList &rhs)
	Assignment operator.
QList< QAction * >	supportedActions (Project *project=NULL)
	Gets a list of pre-connected actions that have to do with display, such as color, alpha, outline, fill, etc.
bool	allSupport (ImageDisplayProperties::Property prop)
	Returns true if all of the given displays support the property.
void	setName (QString newName)
	Set the human-readable name of this image list.
void	setPath (QString newPath)
	Set the relative path (from the project root) to this image list's folder.
QString	name () const
	Get the human-readable name of this image list.
QString	path () const
	Get the path to these images in the image list (relative to project root).
void	deleteFromDisk (Project *project)
	Delete all of the contained Images from disk (see Image::deleteFromDisk())
void	save (QXmlStreamWriter &stream, const Project *project, FileName newProjectRoot) const
	Convert this image list into XML format for saving/restoring capabilities.

Friends
class	ImageListActionWorkOrder

Detailed Description

Author

2012-??-?? ???

Constructor & Destructor Documentation

Isis::ImageList::ImageList	(	QString	name,
		QString	path,
		QObject *	parent = NULL
	)

Create an image list from an image list name and path (does not read Images).

Parameters

name	The ImageList's name (i.e. import1, import2, ...)
path	The ImageList's folder name (i.e. import1, import2, ...)
parent	The Qt-relationship parent

References name(), and path().

Isis::ImageList::ImageList ( QObject *  parent = NULL )

explicit

Create a blank image list.

Parameters

parent

The Qt-relationship parent

Isis::ImageList::ImageList ( QList< Image * >  images, QObject *  parent = NULL  )

explicit

Create an image list from a list of images.

Parameters

images	The list of images
parent	The Qt-relationship parent

References append().

Isis::ImageList::ImageList ( Project *  project, XmlStackedHandlerReader *  xmlReader, QObject *  parent = NULL  )

explicit

Create an image list from XML.

Parameters

project	The project with the image list
xmlReader	The XML reader currently at an <imageList> tag.
parent	The Qt-relationship parent

References Isis::XmlStackedHandlerReader::pushContentHandler().

Isis::ImageList::ImageList ( QStringList &  fileNames )

explicit

Create an image list from a list of cube file names.

This is slow (serial) and not recommended.

References append().

Isis::ImageList::ImageList

(

const ImageList &

other

)

Copy constructor.

Parameters

other

The ImageList to copy

Isis::ImageList::~ImageList

(

)

Destructor.

This does not free the Images from memory.

Member Function Documentation

bool Isis::ImageList::allSupport

(

ImageDisplayProperties::Property

prop

)

Returns true if all of the given displays support the property.

Parameters

prop	The property we're testing for support for
displays	The displays we're doing the test on

References Isis::Image::displayProperties(), and Isis::DisplayProperties::supports().

Referenced by supportedActions().

void Isis::ImageList::append

(

Image *const &

value

)

See Also

QList<Image *>::append()

References countChanged().

Referenced by append(), Isis::MosaicSceneItem::contextMenuEvent(), Isis::MosaicSceneWidget::contextMenuEvent(), ImageList(), Isis::MosaicSceneWidget::images(), Isis::ImageTreeWidget::imagesInView(), and Isis::Footprint2DViewWorkOrder::syncRedo().

void Isis::ImageList::append

(

const QList< Image * > &

value

)

See Also

QList<Image *>::append()

References append(), and countChanged().

void Isis::ImageList::clear

(

)

See Also

QList<Image *>::clear()

References countChanged().

void Isis::ImageList::countChanged ( int  newCount )

signal

Referenced by append(), clear(), erase(), insert(), operator+=(), operator<<(), operator=(), prepend(), push_back(), push_front(), removeAll(), removeAt(), removeFirst(), removeLast(), removeOne(), swap(), takeAt(), takeFirst(), and takeLast().

void Isis::ImageList::deleteFromDisk

(

Project *

project

)

Delete all of the contained Images from disk (see Image::deleteFromDisk())

References Isis::Image::deleteFromDisk(), and Isis::Project::imageDataRoot().

Referenced by Isis::Project::deleteAllProjectFiles().

QList< Image * >::iterator Isis::ImageList::erase

(

iterator

pos

)

See Also

QList<Image *>::erase()

References countChanged().

Referenced by erase().

QList< Image * >::iterator Isis::ImageList::erase	(	iterator	begin,
		iterator	end
	)

See Also

QList<Image *>::erase()

References countChanged(), and erase().

void Isis::ImageList::insert	(	int	i,
		Image *const &	value
	)

See Also

QList<Image *>::insert()

References countChanged().

Referenced by insert().

QList< Image * >::iterator Isis::ImageList::insert	(	iterator	before,
		Image *const &	value
	)

See Also

QList<Image *>::insert()

References countChanged(), and insert().

QString Isis::ImageList::name

(

)

const

Get the human-readable name of this image list.

Returns

The name of the image list (or an empty string if anonymous).

Referenced by Isis::ImageFileListWidget::addImages(), Isis::ExportImagesWorkOrder::execute(), Isis::CubeViewportViewWorkOrder::execute(), Isis::Footprint2DViewWorkOrder::execute(), Isis::ImageFileListViewWorkOrder::execute(), Isis::ImageGroupTreeWidgetItem::ImageGroupTreeWidgetItem(), ImageList(), Isis::Project::imageList(), and Isis::ImageTreeWidgetItem::imageListName().

ImageList & Isis::ImageList::operator+=

(

const QList< Image * > &

other

)

See Also

QList<Image *>::operator+=()

References countChanged().

Referenced by operator+=().

ImageList & Isis::ImageList::operator+=

(

Image *const &

other

)

See Also

QList<Image *>::operator+=()

References countChanged(), and operator+=().

ImageList & Isis::ImageList::operator<<

(

const QList< Image * > &

other

)

See Also

QList<Image *>::operator<<()

References Isis::operator<<().

Referenced by operator<<().

ImageList & Isis::ImageList::operator<<

(

Image *const &

other

)

See Also

QList<Image *>::operator<<()

References countChanged(), and operator<<().

ImageList & Isis::ImageList::operator=

(

const QList< Image * > &

rhs

)

See Also

QList<Image *>::operator=()

References countChanged().

Referenced by operator=().

ImageList & Isis::ImageList::operator=

(

const ImageList &

rhs

)

Assignment operator.

Parameters

rhs	The right hand side of the '=' operator

Returns

*this

References countChanged(), and operator=().

QString Isis::ImageList::path

(

)

const

Get the path to these images in the image list (relative to project root).

This only applies to an image list from the project.

Returns

The path to the images in the image list (or an empty string if unknown).

Referenced by ImageList().

void Isis::ImageList::prepend

(

Image *const &

value

)

See Also

QList<Image *>::prepend()

References countChanged().

void Isis::ImageList::push_back

(

Image *const &

value

)

See Also

QList<Image *>::push_back()

References countChanged().

void Isis::ImageList::push_front

(

Image *const &

value

)

See Also

QList<Image *>::push_front()

References countChanged().

int Isis::ImageList::removeAll

(

Image *const &

value

)

See Also

QList<Image *>::removeAll()

References countChanged().

void Isis::ImageList::removeAt

(

int

i

)

See Also

QList<Image *>::removeAt()

References countChanged().

void Isis::ImageList::removeFirst

(

)

See Also

QList<Image *>::removeFirst()

References countChanged().

void Isis::ImageList::removeLast

(

)

See Also

QList<Image *>::removeLast()

References countChanged().

bool Isis::ImageList::removeOne

(

Image *const &

value

)

See Also

QList<Image *>::removeOne()

References countChanged().

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

Convert this image list into XML format for saving/restoring capabilities.

This writes:

  <imageList name="..." path="...">

to the given xml stream, and creates an 'images.xml' inside the folder with the images. Inside the images.xml, this writes:

  <images>
    ...
  </images>

References _FILEINFO_, Isis::FileName::dir(), Isis::Project::imageDataRoot(), Isis::IException::Io, Isis::FileName::original(), Isis::FileName::path(), Isis::ReadWrite, Isis::Image::save(), and Isis::FileName::toString().

void Isis::ImageList::setName

(

QString

newName

)

Set the human-readable name of this image list.

This is really only useful for project image lists (not anonymous temporary ones).

Parameters

newName

The name to give this image list

void Isis::ImageList::setPath

(

QString

newPath

)

Set the relative path (from the project root) to this image list's folder.

This is really only useful for project image lists (not anonymous temporary ones).

Parameters

newPath

The path to the images in this image list

QList< QAction * > Isis::ImageList::supportedActions

(

Project *

project = NULL

)

Gets a list of pre-connected actions that have to do with display, such as color, alpha, outline, fill, etc.

References allSupport(), Isis::ImageListActionWorkOrder::ChangeColor, Isis::ImageListActionWorkOrder::ChangeTransparency, Isis::ImageDisplayProperties::Color, Isis::Image::displayProperties(), Isis::ImageListActionWorkOrder::RandomizeColor, Isis::ImageDisplayProperties::ShowDNs, Isis::ImageDisplayProperties::ShowFill, Isis::ImageDisplayProperties::ShowLabel, Isis::ImageDisplayProperties::ShowOutline, Isis::ImageListActionWorkOrder::ToggleShowCubeData, Isis::ImageListActionWorkOrder::ToggleShowFilled, Isis::ImageListActionWorkOrder::ToggleShowLabel, Isis::ImageListActionWorkOrder::ToggleShowOutline, Isis::ImageDisplayProperties::Zooming, and Isis::ImageDisplayProperties::ZOrdering.

Referenced by Isis::MosaicSceneItem::contextMenuEvent(), Isis::ImageTreeWidget::contextMenuEvent(), and Isis::MosaicSceneWidget::contextMenuEvent().

void Isis::ImageList::swap

(

QList< Image * > &

other

)

See Also

QList<Image *>::swap()

References countChanged().

Image * Isis::ImageList::takeAt

(

int

i

)

See Also

QList<Image *>::takeAt()

References countChanged().

Image * Isis::ImageList::takeFirst

(

)

See Also

QList<Image *>::takeFirst()

References countChanged().

Image * Isis::ImageList::takeLast

(

)

See Also

QList<Image *>::takeLast()

References countChanged().

Friends And Related Function Documentation

friend class ImageListActionWorkOrder

friend

---

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

• src/qisis/objs/ImageList/ImageList.h
• src/qisis/objs/ImageList/ImageList.cpp
• src/qisis/objs/ImageList/moc_ImageList.cpp