libqxrunner-dev 0.9.2-0ubuntu3 / usr / include / qxrunner / runnerwindow.h

/*!
 * \file  runnerwindow.h
 *
 * \brief Declares class RunnerWindow.
 */

#ifndef RUNNERWINDOW_H
#define RUNNERWINDOW_H

#include "ui_runnerwindow.h"

#include <QSemaphore>
#include <QLabel>

namespace Ui {
	class StatusWidget;
}

namespace QxRunner {

class AppSettings;
class StatusWidget;
class RunnerModel;
class RunnerProxyModel;
class ResultsModel;
class ResultsProxyModel;
class RunnerViewController;
class ResultsViewController;

/*!
 * \brief The RunnerWindow class defines the QxRunner main window.
 *
 * The RunnerWindow class presents a RunnerModel and its ResultsModel
 * in appropriate views to the user and provides commands for their
 * manipulation. Runner items can be executed. Their results can be
 * filtered and sorted.
 *
 * The current implementation doesn't expect that a previously set
 * model gets replaced by another one. Nevertheless the code tries
 * to catch up such a situation by smoothly removing a previous model.
 * But problems could arise for example when there are still items
*  executed in the thread of the model to be replaced.
 *
 * In minimal update mode only a subset of the item result data is
 * displayed during item execution. When all items have finished
 * all result data is shown at once.
 *
 * GUI internal synchronization is employed to prevent from user
 * interactions interfere with the ongoing item execution.
 *
 * \sa \ref main_window
 */

class RunnerWindow : public QMainWindow
{
    Q_OBJECT

friend class AppSettings;

public: // Operations

	/*!
	 * Constructs a runner window with the given \a parent and the
	 * specified widget \a flags.
	 */
	RunnerWindow(QWidget* parent = 0, Qt::WFlags flags = 0);

	/*!
	 * Destroys this runner window.
	 *
	 * \note
	 * Deleting the model provided for the main window is left to
	 * the owner of the model instance.
	 */
	~RunnerWindow();

	/*!
	 * Shows the main window adapted to the current model and settings.
	 */
	void show();

	/*!
	 * Sets the \a model for the main window to present. 
	 */
	void setModel(RunnerModel* model);

	/*!
	 * Returns the view which presents runner items.
	 */
	QTreeView* runnerView() const;

	/*!
	 * Returns the view which presents result items.
	 */
	QTreeView* resultsView() const;

	/*!
	 * Returns the runner model that contains the data that is
	 * available through the runner proxy model.
	 */
	RunnerModel* runnerModel() const;

	/*!
	 * Returns the proxy model that the runner view is presenting.
	 */
	RunnerProxyModel* runnerProxyModel() const;

	/*!
	 * Returns the results model that contains the data that is
	 * available through the results proxy model.
	 */
	ResultsModel* resultsModel() const;

	/*!
	 * Returns the proxy model that the results view is presenting.
	 */
	ResultsProxyModel* resultsProxyModel() const;

	/*!
	 * Returns true if the results view is visible, otherwise false.
	 */
	bool isResultsViewVisible() const;

private slots:

	/*!
	 * Displays the execution progress for \a numItems items.
	 */
	void displayProgress(int numItems) const;

	/*!
	 * Updates the GUI when all items have completed.
	 */
	void displayCompleted() const;

	/*!
	 * Displays the total number \a numItems of items.
	 */
	void displayNumTotal(int numItems) const;

	/*!
	 * Displays the number \a numItems of selected items.
	 */
	void displayNumSelected(int numItems) const;

	/*!
	 * Displays the number \a numItems of completed items.
	 */
	void displayNumCompleted(int numItems) const;

	/*!
	 * Displays the number \a numItems of items that completed
	 * successfully.
	 */
	void displayNumSuccess(int numItems) const;

	/*!
	 * Displays the number \a numItems of items that returned an
	 * info result.
	 */
	void displayNumInfos(int numItems) const;

	/*!
	 * Displays the number \a numItems of items that returned a
	 * warning result.
	 */
	void displayNumWarnings(int numItems) const;

	/*!
	 * Displays the number \a numItems of items that returned an
	 * error result.
	 */
	void displayNumErrors(int numItems) const;

	/*!
	 * Displays the number \a numItems of items that returned a
	 * fatal result.
	 */
	void displayNumFatals(int numItems) const;

	/*!
	 * Displays the number \a numItems of items that produced an
	 * unhandled error.
	 */
	void displayNumExceptions(int numItems) const;

	/*!
	 * Highlights the runner view row where the data of the runner
	 * item referred to by \a runnerItemIndex is displayed.
	 */
	void highlightRunningItem(const QModelIndex& runnerItemIndex) const;

	/*!
	 * Sets the filter in the results model. The filter is determinded
	 * from the enabled filter buttons.
	 */
	void setResultsFilter() const;

	/*!
	 * Highlights the results view row that corresponds to the runner
	 * proxy model selection in \a selected. \a deselected is ignored.
	 */
	void syncResultWithRunnerItem(const QItemSelection& selected,
                                  const QItemSelection& deselected) const;

	/*!
	 * Highlights the runner view row that corresponds to the results
	 * proxy model selection in \a selected. \a deselected is ignored.
	 */
	void syncRunnerItemWithResult(const QItemSelection& selected,
                                  const QItemSelection& deselected) const;

	/*!
	 * Ensures that the view which has the focus shows a focus rect
	 * in the row referred to by \a index.
	 */
	void ensureFocusRect(const QModelIndex& index);

	/*!
	 * Ensures that the highlighted row in every view is visible.
	 */
	void scrollToHighlightedRows() const;

	/*!
	 * Exectues the items in the model.
	 */
	void runItems();

	/*!
	 * Stops item execution. If first stopping attempt isn't successfull
	 * the StoppingDialog is shown.
	 */
	void stopItems();

	/*!
	 * Helper method needed to sync the results display with the results
	 * dock widget visibility. Ensures highlighted rows are visible.
	 */
	void showResults(bool show);

	/*!
	 * Shows the columns selection dialog.
	 */
	void showColumnsSelection();

	/*!
	 * Shows the settings dialog.
	 */
	void showSettings();

	/*!
	 * Shows the about dialog.
	 */
	void showAbout();

private: // Operations

	/*!
	 * Disables and modifies widgets and signals before running items.
	 */
	void disableControlsBeforeRunning();

	/*!
	 * Enables and modifies widgets and signals after item execution
	 * has finished.
	 */
	void enableControlsAfterRunning() const;

	/*!
	 * If \a enable is true the actions for item manipulation are
	 * enabled, otherwise disabled.
	 */
	void enableItemActions(bool enable) const;

	/*!
	 * If \a enable is true the filter buttons are enabled, otherwise
	 * disabled.
	 */
	void enableResultsFilter(bool enable) const;

	/*!
	 * If \a enable is true syncResultWithRunnerItem() is enabled,
	 * otherwise disabled.
	 */
	void enableRunnerItemSync(bool enable) const;

	/*!
	 * If \a enable is true syncRunnerItemWithResult() is enabled,
	 * otherwise disabled.
	 */
	void enableResultSync(bool enable) const;

	/*!
	 * Sets a suitable current index in the results view so the view
	 * has a focus rect and behaves 'normal' when it gets the focus.
	 */
	void ensureCurrentResult() const;

	/*!
	 * Disables or removes menu items adapted to the model.
	 */
	void adjustMenus() const;

	/*!
	 * Sets \a numItems as text in \a labelForText. If \a numItems
	 * is 0 the labels are hidden, otherwise made visible.
	 */
	void displayStatusNum(QLabel* labelForText,
                          QLabel* labelForPic, int numItems) const;

	/*!
	 * Returns true if the GUI and model are in minimal update mode,
	 * otherwise false.
	 */
	bool isMinimalUpdate() const;

	/*!
	 * Returns the status widget.
	 */
	Ui::StatusWidget* statusWidget() const;

	/*!
	 * Returns the runner view controller.
	 */
	RunnerViewController* runnerController() const;

	/*!
	 * Returns the results view controller.
	 */
	ResultsViewController* resultsController() const;

	/*!
	 * Writes settings to the INI file and ends the program. If items are
	 * running the user can choose to terminate 'the hard way'.
	 */
	void closeEvent(QCloseEvent* event);

	// Copy and assignment not supported.
	RunnerWindow(const RunnerWindow&);
	RunnerWindow& operator=(const RunnerWindow&);

private: // Attributes

	Ui::RunnerWindow ui;

	StatusWidget* m_statusWidget;

	QSemaphore m_sema;

	QBrush m_highlightBrush;

	RunnerViewController*  m_runnerViewController;
	ResultsViewController* m_resultsViewController;
};

} // namespace

#endif // RUNNERWINDOW_H