QVISH 0.1
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Wizt::qVInputContext Class Referenceabstract

Class describing the context information as provided by the QT GUI for implementing a widget for a certain input. More...

#include <qVInputContext.hpp>

Inheritance diagram for Wizt::qVInputContext:
Wizt::qVTimerWindowContainer Wizt::qVMainWindow

Public Types

enum  DataProcessingAction {
  Unknown , StartProcessing , PreProcessing , StartSecondPass ,
  StartThirdPass , Update , PostProcessing , FinishProcessing ,
  AppDefined = 1024 , FileNotFoundError = -10 , InconsistencyError = -11
}
 Values for notifyDataProcessing() call. More...
 

Public Member Functions

const WeakPtr< qVAqua > & getAqua () const
 
virtual WeakPtr< VObject > getCurrentObject () const =0
 
int getMinimumQuality () const
 Minimal quality that a VCreator must provide to be visible.
 
virtual void notifyChange (const VInputBase &theInput, const string &ChangeContextInfo={})
 To perform statistics, for instance, on which parameters are changed via the GUI.
 
virtual void notifyDataProcessing (int Action, const string &DataProcessor, const VNutrition::FileList_t &DataItems, const string &ActivityMessage=string()) const =0
 
virtual void notifyImportanceChange (const WeakPtr< VSlot > &) const =0
 
virtual void setCurrentObject (const WeakPtr< VObject > &vobj)=0
 Allows to set a specific object as the "current" one which will receive all attention from the GUI.
 
- Public Member Functions inherited from Wizt::qVTimerWindowContainer
void hideTimeWindow ()
 
bool setTimeWindow (qVTimerWindow *TimeWindow)
 
void showTimeWindow ()
 

Public Attributes

std::function< bool()> allowApplicationClose
 
QString qVParameterSettingsFilename
 Filename for local parameters.
 
- Public Attributes inherited from Wizt::qVTimerWindowContainer
QPointer< QSplitter > TimeViewerSplitter
 
QPointer< qVTimerWindowTimeWindow
 The Qt Window providing time-dependent parameterization of values.
 

Protected Member Functions

 qVInputContext (const QString &qVParameterSettingsFilename)
 

Protected Attributes

int MinimumQuality
 Minimal quality that a VCreator must provide to be visible.
 

Detailed Description

Class describing the context information as provided by the QT GUI for implementing a widget for a certain input.

This class is not refcounted, neither via MemCore nor via QT. Application code should reference objects of this type via references. An object of type qVInputContext is supposed to be valid as long as a main window exists (this class is actually a base class of the main window). If required, we might introduce a mechanism here to register cleanup calls during destruction of this class.

One possible way for client code to check for the validity of this object, i.e. of the main window being open, is by creating a weak pointer to the qVAqua object stored here. If that pointer dies, then the qVInputContext has been destructed.

Member Enumeration Documentation

◆ DataProcessingAction

Values for notifyDataProcessing() call.

Enumerator
AppDefined 

application-defined action types start with this offset

Member Function Documentation

◆ notifyDataProcessing()

virtual void Wizt::qVInputContext::notifyDataProcessing ( int  Action,
const string &  DataProcessor,
const VNutrition::FileList_t &  DataItems,
const string &  ActivityMessage = string() 
) const
pure virtual
Parameters
Actionany of DataProcessingAction

Implemented in Wizt::qVMainWindow.

◆ setCurrentObject()

virtual void Wizt::qVInputContext::setCurrentObject ( const WeakPtr< VObject > &  vobj)
pure virtual

Allows to set a specific object as the "current" one which will receive all attention from the GUI.

Implemented in Wizt::qVMainWindow.


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