BALL::VIEW::DatasetController Class Reference
Controller base class for one type of Dataset A DatasetController provides all neccessary means to manage and manipulate a kind of data in the DatasetControl. More...#include <dataset.h>
Public Slots |
|
| bool | write () |
| Show a file dialog for writing the
selected Dataset. |
|
| bool | open () |
| Show a file dialog to open a data
file. |
|
| virtual bool | deleteDatasets () |
| Delete all Datasets. |
|
| virtual bool | deleteDataset () |
| Delete the currently highlighted
Dataset. |
|
Public Member Functions |
|
| DatasetController (DatasetController &dc) | |
| void | setDatasetControl (DatasetControl *dc) |
| DatasetControl * | getDatasetControl () |
| virtual bool | handle (DatasetMessage *msg) |
| Message handling. |
|
| virtual bool | insertDataset (Dataset *set) |
| virtual bool | deleteDataset (Dataset *set) |
| virtual bool | createMenuEntries () |
| Create menu entries for this data
type. |
|
| virtual QMenu * | buildContextMenu (QTreeWidgetItem *item) |
| Create a context menu for this data
type. |
|
| vector< Dataset * > | getDatasets () |
| Get all Datasets of this type in the
DatasetControl. |
|
| vector< Dataset * > | getSelectedDatasets () |
| Get all selected Datasets of this
type in the
DatasetControl. |
|
| Dataset * | getSelectedDataset () |
| Get one selected Datasets of this
type in the
DatasetControl. |
|
| bool | hasDataset (Dataset *set) |
| Test if a Dataset is registered in this
controller. |
|
| bool | hasItem (QTreeWidgetItem *item) |
| Test if a given QTreeWidgetItem
corresponds to a registered Dataset. |
|
| Dataset * | getDataset (QTreeWidgetItem *item) |
| Get the Dataset for a
QTreeWidgetItem. |
|
| String | getType () |
| Get the String type identifier for
this data type. |
|
| virtual void | checkMenu (MainControl &mc) |
| Check the menu entries for this data
type. |
|
| vector< String > | getSupportedFileFormats () |
| Return a vector with all supported
file formats. |
|
Protected Member Functions |
|
| void | setStatusbarText (const String &text, bool important=false) |
| virtual bool | write (Dataset *, String, String) |
| virtual Dataset * | open (String, String) |
| String | getFileTypes_ () |
| String | getNameFromFileName_ (String filename) |
| QAction * | insertMenuEntry_ (Position pid, const String &name, const char *slot, const String &description="", QKeySequence accel=QKeySequence()) |
| virtual void | deleteDataset_ (Dataset *) |
| In the derived class: cast to
concrete type and delete the data! |
|
Protected Attributes |
|
| String | type_ |
| vector< String > | file_formats_ |
| DatasetControl * | control_ |
| vector< QAction * > | actions_ |
| HashSet< QAction * > | actions_for_one_set_ |
|
HashMap<
QTreeWidgetItem *, Dataset * > |
item_to_dataset_ |
|
HashMap< Dataset *, QTreeWidgetItem * > |
dataset_to_item_ |
Friends |
|
| class | DatasetControl |
Detailed Description
Controller base class for one type of Dataset A DatasetController provides all neccessary means to manage and manipulate a kind of data in the DatasetControl.The class has the following features:
- It can be registered at a DatasetControl with the method DatasetControl::registerController.
- It knows about its supported file formats, and can open them when requested. (see getSupportedFileFormats())
- It will then automatically call createMenuEntries and thus create the menu entries. Derived classes can add further entries, by overloading this method.
- The DatasetControl provides a context menu for the Datasets. Its entries are created in DatasetController::buildContextMenu.
- Since DatasetController is derived from Embeddable, access to individual instances (also to derived classes) is possible through getInstance().
- When a DatasetController is deleted, it deletes all Datasets and their data.
- getData
- buildContextMenu
- creatMenuEntries
- open
- write
- deleteDataset_
- add a static String member type
- assign file_formats_ in the derived classes constructor
- See also:
- DatasetControl
Member Function Documentation
| virtual QMenu* BALL::VIEW::DatasetController::buildContextMenu | ( | QTreeWidgetItem * | item | ) | [virtual] |
Create a context menu for this data type.
Initial support for deleting and saving entries is included. Overload this method for providing further entries.
Reimplemented in BALL::VIEW::RegularData3DController, BALL::VIEW::TrajectoryController, BALL::VIEW::DockResultController, BALL::VIEW::VectorGridController, and BALL::VIEW::RaytraceableGridController.
| virtual void BALL::VIEW::DatasetController::checkMenu | ( | MainControl & | mc | ) | [virtual] |
Check the menu entries for this data type.
If the MainControl is currently busy, all entries are disabled. If multiple entries are selected, it is tested, if an QAction is included in actions_for_one_set_. If true, this QAction is disabled. Overload this method for more sophisticated behaviour.
| virtual bool BALL::VIEW::DatasetController::createMenuEntries | ( | ) | [virtual] |
Create menu entries for this data type.
Initial support for open file menu entry is included. Overload this method for providing further entries.
Reimplemented in BALL::VIEW::RegularData3DController, BALL::VIEW::TrajectoryController, BALL::VIEW::DockResultController, BALL::VIEW::VectorGridController, and BALL::VIEW::RaytraceableGridController.
| Dataset* BALL::VIEW::DatasetController::getSelectedDataset | ( | ) |
Get one selected Datasets of this type in the DatasetControl.
If multiple entries are selected in the DatasetControl, 0 is returned.
| vector<String> BALL::VIEW::DatasetController::getSupportedFileFormats | ( | ) |
Return a vector with all supported file formats.
Set the member file_formats_ in the constructor of the derived class. The methods open(...) and write(...) must be overloaded such that they know how to handle the supported file formats.
| virtual bool BALL::VIEW::DatasetController::handle | ( | DatasetMessage * | msg | ) | [virtual] |
Message handling.
If a DatasetControl receives a DatasetMessage, it queries the data type and calls this method in the corresponding DatasetController. This method has intial support for DatasetMessage::ADD and DatasetMessage::REMOVE. For these cases, it calls insertDataset or respectively deleteDataset.
| bool BALL::VIEW::DatasetController::open | ( | ) | [slot] |
Show a file dialog to open a data file.
Calls open(String, String). Overload this method to support multiple file formats.
