 |
Isis Developer Reference
|
|
Isis Developer Reference
|
List of GuiCameras saved as QSharedPointers. More...
#include <GuiCameraList.h>
Signals | |
| void | countChanged (int newCount) |
| Emitted when the number of GuiCameras in the list changes. | |
Public Member Functions | |
| GuiCameraList (QString name, QString path, QObject *parent=NULL) | |
| Create an gui camera list from a gui camera list name and path (does not read GuiCamera objects). | |
| GuiCameraList (QObject *parent=NULL) | |
| Create a blank gui camera list. | |
| GuiCameraList (QList< GuiCameraQsp >, QObject *parent=NULL) | |
| Create a gui camera list from a list of GuiCamera's. | |
| GuiCameraList (Project *project, XmlStackedHandlerReader *xmlReader, QObject *parent=NULL) | |
| Create an image list from XML. | |
| GuiCameraList (const GuiCameraList &) | |
| Copy constructor. | |
| ~GuiCameraList () | |
| Create a gui camera list from a list of gui camera file names. | |
| void | append (GuiCameraQsp const &value) |
| Appends a single GuiCamera to the list. | |
| void | append (const QList< GuiCameraQsp > &value) |
| Appends another GuiCameraList to the list. | |
| void | clear () |
| Clears the list. | |
| iterator | erase (iterator pos) |
| Removes the GuiCamera associated with an iterator. | |
| iterator | erase (iterator begin, iterator end) |
| Removes all GuiCameras from begin up to, but not inclusing end. | |
| void | insert (int i, GuiCameraQsp const &value) |
| Inserts a GuiCamera into the list at a given index. | |
| iterator | insert (iterator before, GuiCameraQsp const &value) |
| Inserts a GuiCamera in front of the GuiCamera associated with an iterator. | |
| void | prepend (GuiCameraQsp const &value) |
| Inserts a GuiCamera at the beginning of the list. | |
| void | push_back (GuiCameraQsp const &value) |
| Inserts a GuiCamera at the end of the list. | |
| void | push_front (GuiCameraQsp const &value) |
| Inserts a GuiCamera at the front of the list. | |
| int | removeAll (GuiCameraQsp const &value) |
| Removes all occurances of a GuiCamera from the list. | |
| void | removeAt (int i) |
| Removes the GuiCamera at a specific index. | |
| void | removeFirst () |
| Removes the first GuiCamera in the list. | |
| void | removeLast () |
| Removes the last GuiCamera in the list. | |
| bool | removeOne (GuiCameraQsp const &value) |
| Removes the first occurance of a GuiCamera from the list. | |
| void | swap (QList< GuiCameraQsp > &other) |
| Swaps the list with another GuiCameraList. | |
| GuiCameraQsp | takeAt (int i) |
| Removes and returns the GuiCamera at a specific index. | |
| GuiCameraQsp | takeFirst () |
| Removes and returns the first GuiCamera in the list. | |
| GuiCameraQsp | takeLast () |
| Removes and returns the last GuiCamera in the list. | |
| GuiCameraList & | operator+= (const QList< GuiCameraQsp > &other) |
| Appends another GuiCameraList to the list and returns a reference to this. | |
| GuiCameraList & | operator+= (GuiCameraQsp const &other) |
| Appends a GuiCamera to the list and returns a reference to this. | |
| GuiCameraList & | operator<< (const QList< GuiCameraQsp > &other) |
| Appends another GuiVameraList to the list and returns a reference to this. | |
| GuiCameraList & | operator<< (GuiCameraQsp const &other) |
| Appends a GuiCamera to the list and returns a reference to this. | |
| GuiCameraList & | operator= (const QList< GuiCameraQsp > &rhs) |
| Assigns a list of GuiCameras to the list. | |
| GuiCameraList & | operator= (const GuiCameraList &rhs) |
| Assignment operator. | |
| QList< QAction * > | supportedActions (Project *project=NULL) |
| bool | allSupport (GuiCameraDisplayProperties::Property prop) |
| void | setName (QString newName) |
| Gets a list of pre-connected actions that have to do with display, such as color, alpha, outline, fill, etc. | |
| void | setPath (QString newPath) |
| Set the relative path (from the project root) to this gui camera list's folder. | |
| QString | name () const |
| Get the human-readable name of this gui cameray list. | |
| QString | path () const |
| Get the path to these gui camera objects in the list (relative to project root). | |
| void | save (QXmlStreamWriter &stream, const Project *project, FileName newProjectRoot) const |
| Delete all of the contained GuiCamera objects from disk (see GuiCamera::deleteFromDisk()) | |
List of GuiCameras saved as QSharedPointers.
Overrides many QList methods in order to emit signals about that status of the list.
List of GuiCameras.
| Isis::GuiCameraList::GuiCameraList | ( | QString | name, |
| QString | path, | ||
| QObject * | parent = NULL ) |
Create an gui camera list from a gui camera list name and path (does not read GuiCamera objects).
| name | The GuiCameraList's name (i.e. import1, import2, ...) |
| path | The GuiCameraList's folder name (i.e. import1, import2, ...) |
| parent | The Qt-relationship parent |
|
explicit |
Create a blank gui camera list.
| parent | The Qt-relationship parent |
|
explicit |
|
explicit |
Create an image list from XML.
| project | The project with the gui camera list |
| xmlReader | The XML reader currently at an <GuiCameraList > tag. |
| parent | The Qt-relationship parent |
| Isis::GuiCameraList::GuiCameraList | ( | const GuiCameraList & | src | ) |
Copy constructor.
| other | The GuiCameraList to copy |
| Isis::GuiCameraList::~GuiCameraList | ( | ) |
Create a gui camera list from a list of gui camera file names.
This is slow (serial) and not recommended. Destructor. This does not free the GuiCamera objects from memory.
| bool Isis::GuiCameraList::allSupport | ( | GuiCameraDisplayProperties::Property | prop | ) |
| void Isis::GuiCameraList::append | ( | const QList< GuiCameraQsp > & | value | ) |
Appends another GuiCameraList to the list.
| value | The GuiCameraList to be appened |
References countChanged().
| void Isis::GuiCameraList::append | ( | GuiCameraQsp const & | value | ) |
Appends a single GuiCamera to the list.
| value | The GuiCamera to be appened |
References countChanged().
Referenced by Isis::Project::addCamera(), and GuiCameraList().
| void Isis::GuiCameraList::clear | ( | ) |
Clears the list.
References countChanged().
Referenced by Isis::Project::clear().
|
signal |
Emitted when the number of GuiCameras in the list changes.
Not currently connected to anything.
Referenced by append(), append(), clear(), erase(), erase(), insert(), insert(), operator+=(), operator+=(), operator<<(), operator<<(), operator=(), operator=(), prepend(), push_back(), push_front(), removeAll(), removeAt(), removeFirst(), removeLast(), removeOne(), swap(), takeAt(), takeFirst(), and takeLast().
| QList< GuiCameraQsp >::iterator Isis::GuiCameraList::erase | ( | iterator | begin, |
| iterator | end ) |
Removes all GuiCameras from begin up to, but not inclusing end.
Returns an iterator associated with GuiCamera that was associated with end.
| begin | An iterator associated with the first GuiCamera to be removed |
| end | An iterator associated with the GuiCamera after the last GuiCamera to be removed |
References countChanged().
| QList< GuiCameraQsp >::iterator Isis::GuiCameraList::erase | ( | iterator | pos | ) |
Removes the GuiCamera associated with an iterator.
Returns an iterator associated with the next GuiCamera in the list.
| pos | An iterator associated with the GuiCamera to be erased |
References countChanged().
| void Isis::GuiCameraList::insert | ( | int | i, |
| GuiCameraQsp const & | value ) |
Inserts a GuiCamera into the list at a given index.
References countChanged().
| QList< GuiCameraQsp >::iterator Isis::GuiCameraList::insert | ( | iterator | before, |
| GuiCameraQsp const & | value ) |
Inserts a GuiCamera in front of the GuiCamera associated with an iterator.
Returns an iterator associated with the inserted GuiCamera.
| before | An iterator associated with the GuiCamera that value will be inserted in front of |
| value | The GuiCamera to be inserted. |
References countChanged().
| QString Isis::GuiCameraList::name | ( | ) | const |
Get the human-readable name of this gui cameray list.
Referenced by GuiCameraList().
| GuiCameraList & Isis::GuiCameraList::operator+= | ( | const QList< GuiCameraQsp > & | other | ) |
Appends another GuiCameraList to the list and returns a reference to this.
| other | The GuiCameraList to be appended |
References countChanged().
| GuiCameraList & Isis::GuiCameraList::operator+= | ( | GuiCameraQsp const & | other | ) |
Appends a GuiCamera to the list and returns a reference to this.
| other | The GuiCamera to be appended |
References countChanged().
| GuiCameraList & Isis::GuiCameraList::operator<< | ( | const QList< GuiCameraQsp > & | other | ) |
Appends another GuiVameraList to the list and returns a reference to this.
| other | The GuiCameraList to be appened |
References countChanged().
| GuiCameraList & Isis::GuiCameraList::operator<< | ( | GuiCameraQsp const & | other | ) |
Appends a GuiCamera to the list and returns a reference to this.
| other | The GuiCamera to be appended |
References countChanged().
| GuiCameraList & Isis::GuiCameraList::operator= | ( | const GuiCameraList & | rhs | ) |
Assignment operator.
| rhs | The right hand side of the '=' operator |
References countChanged().
| GuiCameraList & Isis::GuiCameraList::operator= | ( | const QList< GuiCameraQsp > & | rhs | ) |
Assigns a list of GuiCameras to the list.
Does not modify m_name or m_path.
| rhs | the list being assigned from |
References countChanged().
| QString Isis::GuiCameraList::path | ( | ) | const |
Get the path to these gui camera objects in the list (relative to project root).
This only applies to a gui camera list from the project.
Referenced by GuiCameraList().
| void Isis::GuiCameraList::prepend | ( | GuiCameraQsp const & | value | ) |
Inserts a GuiCamera at the beginning of the list.
| value | The GuiCamera to be inserted. |
References countChanged().
| void Isis::GuiCameraList::push_back | ( | GuiCameraQsp const & | value | ) |
Inserts a GuiCamera at the end of the list.
Equivalent to append.
| value | The GuiCamera to be inserted. |
References countChanged().
| void Isis::GuiCameraList::push_front | ( | GuiCameraQsp const & | value | ) |
Inserts a GuiCamera at the front of the list.
Equivalent to prepend.
| value | The GuiCamera to be inserted. |
References countChanged().
| int Isis::GuiCameraList::removeAll | ( | GuiCameraQsp const & | value | ) |
Removes all occurances of a GuiCamera from the list.
Returns the number removed.
| value | The GuiCamera to be removed |
References countChanged().
| void Isis::GuiCameraList::removeAt | ( | int | i | ) |
Removes the GuiCamera at a specific index.
| i | The index of the GuiCamera to be removed |
References countChanged().
| void Isis::GuiCameraList::removeFirst | ( | ) |
Removes the first GuiCamera in the list.
References countChanged().
| void Isis::GuiCameraList::removeLast | ( | ) |
Removes the last GuiCamera in the list.
References countChanged().
| bool Isis::GuiCameraList::removeOne | ( | GuiCameraQsp const & | value | ) |
Removes the first occurance of a GuiCamera from the list.
Returns whether or not it succeeded.
| value | The GuiCamera to be removed |
References countChanged().
| void Isis::GuiCameraList::save | ( | QXmlStreamWriter & | stream, |
| const Project * | project, | ||
| FileName | newProjectRoot ) const |
Delete all of the contained GuiCamera objects from disk (see GuiCamera::deleteFromDisk())
Convert this gui camera list into XML format for saving/restoring capabilities. Not currently implemented
This writes:
<GuiCameraList name="..." path="...">
to the given xml stream, and creates a 'targets.xml' inside the folder with the target body objects. Inside the images.xml, this writes:
<targets>
...
</targets>
| void Isis::GuiCameraList::setName | ( | QString | newName | ) |
Gets a list of pre-connected actions that have to do with display, such as color, alpha, outline, fill, etc.
Returns true if all of the given displays support the property
| prop | The property we're testing for support for |
| displays | The displays we're doing the test on Set the human-readable name of this gui camera list. This is really only useful for project gui camera lists (not anonymous temporary ones). |
| newName | The name to give this gui camera list |
| void Isis::GuiCameraList::setPath | ( | QString | newPath | ) |
Set the relative path (from the project root) to this gui camera list's folder.
This is really only useful for project gui camera lists (not anonymous temporary ones).
| newPath | The path to the gui camera objects in this gui camera list |
| void Isis::GuiCameraList::swap | ( | QList< GuiCameraQsp > & | other | ) |
Swaps the list with another GuiCameraList.
| other | The GuiCameraList to swap with |
References countChanged().
| GuiCameraQsp Isis::GuiCameraList::takeAt | ( | int | i | ) |
Removes and returns the GuiCamera at a specific index.
| i | The index of GuiCamera to be removed |
References countChanged().
| GuiCameraQsp Isis::GuiCameraList::takeFirst | ( | ) |
Removes and returns the first GuiCamera in the list.
References countChanged().
| GuiCameraQsp Isis::GuiCameraList::takeLast | ( | ) |
Removes and returns the last GuiCamera in the list.
References countChanged().