QguWLinput Class Reference

This is the QguWLinput class. More...

#include <qgu.h>

List of all members.

Public Slots

void validateInput (const QString &)
 Method that validates the input string txt.
void sendTextChanged (const QString &)
 emits textChanged signal to trigger validation. Traps changes made by validator itself
Exceptions:
None 

void reValidate ()
 Method that validates the content of the line edit object.
void paste ()
 Slot that allows paste into contained QguLineEdit.
void setDropdownText_r ()
void setDropdownText_x ()
void setDropdownText_y ()
void setDropdownText_z ()
void setDropdownText_ld ()
void setDropdownText_td ()
void setDropdownText_pd ()
void setDropdownText_lr ()
void setDropdownText_tr ()
void setDropdownText_pr ()
void setDropdownText_dobj ()
void openArrayReduce ()
void openSliceT ()
void openSliceS ()
void openSliceV ()
void openSliceVP ()
void openSelectMetadata ()
void setDropdownTstart ()
void setDropdownTcentre ()
void setDropdownTend ()
void resetColour ()
void selectTivlSeqSubset ()
void selectTivlEvent ()

Signals

void hadDropEvent ()
 signal emitted drop received
void validated_alias (const QString &)
void validated_WL_OBJ (const QString &)
void validated_number (const QString &)
void validated_TEXT (const QString &)
void validated_OK ()
 Function signal that is emitted when any data being entered has been validated with success.
void validated_WARN ()
 Function signal that is emitted when text entered is incomplete, but valid so far.
void validated_NOT_OK ()
 Function signal that is emitted when text entered is not compatible with slot requirements.
void validated_EMPTY ()
 Function signal that is emitted when line input object does not contain any text.
void validated_INACTIVE ()
 Function signal that is emitted when the line input object is set inactive.
void textChanged (const QString &)
 signal emitted when input text changes
void componentSelected (const char *, const char *)
 signal emitted when dropdown component menu activated for time or vector
void TimeChosen ()
 signal emitted when dropdown component menu selected a time
void dropDetected (const char *)

Public Member Functions

 QguWLinput (QWidget *parent, const char *name)
 Constructor of QguWLinput class.
 ~QguWLinput ()
 Destructor of QguWLinput class
Exceptions:
None. 

QdObject_var getSlotObject ()
 Method that gets the QdObject from the WL on the basis of the name that is held within the line edit text.
void setColour (const QString validity)
 Method that sets the colour of the line edit object on the basis of the validity state of the content of this object.
void setText (QString txt)
 Method that sets the text in the input slot.
void setTextKeepComp (const QString &txt)
bool compatibleComp (QdObject_var dobj, const QString &comp, bool &nowVector)
void setAliasKeepComp (const QString &txt)
QString text ()
 Method that returns the text in the input slot.
QString textObject ()
 Method that returns the text in the input slot with component text removed.
double value ()
 Method that returns the double value in the input slot, if acceptNumber or acceptTime is true.
void setDouble (double value)
void setCursorPosition (int posn)
void setAlignment (int flag)
 Method that sets the text alignment in the underlying lineEdit.
void setMaxLength (int len)
 Method that sets the max text length in the underlying lineEdit.
bool edited ()
 Method that returns the edited flag from this slot.
void setEdited (bool hasBeenEdited)
 Method that sets the edited flag from this slot.
bool setDropdownActive (QdObject_var dobj, const bool toScalar, bool isVect, bool useTimeSlicer)
 This method shows/hides the dropDown arrow if dimension reduction is possible.
void setReadOnly (bool readOnly)
void clear ()
 passes clear to contained QLineEdit
Exceptions:
None 

bool hasFocus ()
void clearFocus ()
void setEnabled (bool enabled)
dimTripleStack parseArrayReduce ()
 Method that parses text in QguLineEdit and finds the array reduction requested.
dimTriple parseTimeSlice ()
 Method that parses text in QguLineEdit and finds the array reduction requested.
QguComp_e getComponent ()
Dim_var getSlotArrDim ()
void emitCmpSelected (const char *cmpTxt, const char *cmpType)
bool isTimeSelection ()
Q_POPUP_MENU * getDefaultPopup ()
Q_POPUP_MENU * getDefaultPopupSlice ()
Q_POPUP_MENU * getTrangePopup ()
Q_POPUP_MENU * getTivlPopup ()
Q_POPUP_MENU * getTivlPopupPlus ()
Q_POPUP_MENU * getTivlFromEvtTablePopup ()
Q_POPUP_MENU * getTivlSeqSlicePopup ()
Q_POPUP_MENU * getVectorPopup ()
Q_POPUP_MENU * getVectorPopupPlus ()
Q_POPUP_MENU * getVectorPopupSlice ()
Q_POPUP_MENU * getVectorPopupPlusSlice ()
Q_POPUP_MENU * getArrayPopup ()
Q_POPUP_MENU * getArrayPopupPlus ()

Public Attributes

QToolButton * dropDownArray
QguLineEditlineBox
QguListViewaliasList
Q_POPUP_MENU * defaultPopup
Q_POPUP_MENU * defaultPopupSlice
Q_POPUP_MENU * TivlPopup
Q_POPUP_MENU * TivlPopupPlus
Q_POPUP_MENU * TivlFromEvtTablePopup
Q_POPUP_MENU * TivlSlicePopup
Q_POPUP_MENU * TrangePopup
Q_POPUP_MENU * vectorPopup
Q_POPUP_MENU * vectorPopupPlus
Q_POPUP_MENU * vectorPopupSlice
Q_POPUP_MENU * vectorPopupPlusSlice
Q_POPUP_MENU * arrayPopup
Q_POPUP_MENU * arrayPopupPlus
bool reduce3Dto1
bool reduce3DtoScalar
bool active
 Public flag set to signify that this QguWLinput is active (accepts input).
bool acceptNumber
 Public flag, true implies QguWLinput accepts numerical input (using atof() from text input).
bool acceptInteger
 Public flag, true implies QguWLinput accepts integer input (using atoi() from text input).
bool acceptObject
 Public flag, true implies QguWLinput accepts QdObject_var input.
bool acceptObjectPlus
 Public flag, true implies QguWLinput accepts QdObject_var input permitting dimension reduction.
bool acceptObjectMinus
 Public flag, true implies QguWLinput accepts QdObject_var input only for dimension reduction.
bool acceptScalarObject
 Public flag, true implies QguWLinput accepts QdRScalar_var and QdRScalarSeq_var input.
bool acceptVectorObject
 Public flag, true implies QguWLinput accepts QdRMatrix_var and QdRMatrixSeq_var input that satisfies QuIsThreeVector.
bool acceptArrayObject
 Public flag, true implies QguWLinput accepts QdRMatrix_var and QdRMatrixSeq_var input.
bool acceptObjectPlus_TSonly
 Public flag, true implies QguWLinput accepts any input if it has TIME_TAGS xref.
bool acceptScalarObject_TSonly
 Public flag, true implies QguWLinput accepts QdRScalar_var and QdRScalarSeq_var input if it has TIME_TAGS xref.
bool acceptVectorObject_TSonly
 Public flag, true implies QguWLinput accepts QdRMatrix_var input if it has TIME_TAGS xref, that satisfies QuIsThreeVector,.
bool acceptArrayObject_TSonly
 Public flag, true implies QguWLinput accepts QdRMatrix_var input if it has TIME_TAGS xref.
bool acceptTTagObject
 Public flag, true implies QguWLinput accepts QdTimeSequenace_var or QdObject_var input with a TIME_TAGS xref.
bool acceptTIvlObject
 Public flag, true implies QguWLinput accepts QdTimeInterval_var input.
bool acceptTIvlSeqObject
 Public flag, true implies QguWLinput accepts QdTimeIntervalSeq_var input.
bool acceptDuration
 Public flag, true implies QguWLinput accepts number input to be used as time duration.
bool acceptTimeObject
 Public flag, true implies QguWLinput accepts QdTime_var input.
bool acceptText
 Public flag, true implies QguWLinput accepts any keyboard text input.
bool acceptTime
 Public flag, true implies QguWLinput accepts any valid ISO time text string input.
bool acceptAliasToScalar
 Public flag, true if slot accepts a name on the specified QguListView * aliasList. Restricted to Scalar.
bool acceptAliasToVector
 Public flag, true if slot accepts a name on the specified QguListView * aliasList. Restricted to Vector.
bool acceptAlias
 Public flag, true if slot accepts a name on the specified QguListView * aliasList.
bool acceptTimeSlice
 Public flag, true if slot accepts slice or average down to single time.
bool acceptTimeSubset
 Public flag, true if slot accepts slice, average down or subset on time.
bool refresh
 local flag to trap re-validation following a refresh of the input during validation. No infinite loop.
int with
 Public member defining how the list view is being saved (saved with/without data).
bool beenEdited
 flag to show a manual edit has taken place
QString ObjectName
 The WL context for the valid object or the alias name.
QString ObjectName_nil
 nil string used when input did not validate OK
QString objType
 the type of object resloved to, "text", "object", "number", "timeString"
QdObject_var nilObject
 nil object for use when invalid slot input text so that a .is)nil() object is returned
bool slotObjVector
 flag for current item is vector
bool slotObjArray
 flag for current item is array
bool userChoice
 flag to let initialisation of Time object without validation to time string
bool canEmitCmpSel
QPalette * WLI_palette

Friends

Vostreamoperator<< (Vostream &, QguWLinput &)
Vistreamoperator>> (Vistream &, QguWLinput &)


Detailed Description

This is the QguWLinput class.

This class specialises the QLineEdit widget which is a one-line text editor. Does so inside a box with optional drop down menu for sub-dimensions

A line edit allows the user to enter and edit a single line of plain text with a useful collection of editing functions, including undo and redo, cut and paste, and drag and drop

It inherits Q_H_GROUP_BOX which is a built-in QT3 class

Remarks:
{ This class includes Q_OBJECT which is a QT3 macro that is used in all sub-classes of QObject in order to benefit from the QT's Meta object system which are signals and slots mechanisms for inter-object communication, runtime type information and the dynamic property system }

Constructor & Destructor Documentation

QguWLinput::QguWLinput ( QWidget *  parent,
const char *  name 
)

Constructor of QguWLinput class.

Parameters:
parent of type QWidget
name of type const char *
Exceptions:
None 
Returns:
None

QguWLinput::~QguWLinput (  ) 

Destructor of QguWLinput class

Exceptions:
None. 

Returns:
None


Member Function Documentation

void QguWLinput::clear (  ) 

passes clear to contained QLineEdit

Exceptions:
None 

Returns:
None

void QguWLinput::clearFocus (  ) 

bool QguWLinput::compatibleComp ( QdObject_var  dobj,
const QString &  comp,
bool &  nowVector 
)

void QguWLinput::componentSelected ( const char *  ,
const char *   
) [signal]

signal emitted when dropdown component menu activated for time or vector

Parameters:
component of type const char *, flag of type const char * = "VECTOR" or "TIME"
Exceptions:
None 
Returns:
None

void QguWLinput::dropDetected ( const char *   )  [signal]

bool QguWLinput::edited (  ) 

Method that returns the edited flag from this slot.

Parameters:
None 
Exceptions:
None 
Returns:
edited of type bool

void QguWLinput::emitCmpSelected ( const char *  cmpTxt,
const char *  cmpType 
)

Q_POPUP_MENU * QguWLinput::getArrayPopup (  ) 

Q_POPUP_MENU * QguWLinput::getArrayPopupPlus (  ) 

QguComp_e QguWLinput::getComponent (  ) 

Q_POPUP_MENU * QguWLinput::getDefaultPopup (  ) 

Q_POPUP_MENU * QguWLinput::getDefaultPopupSlice (  ) 

Dim_var QguWLinput::getSlotArrDim (  ) 

QdObject_var QguWLinput::getSlotObject (  ) 

Method that gets the QdObject from the WL on the basis of the name that is held within the line edit text.

Will create an object from input text (not on WL, so volatile) if slot accepts non-object input. Will return a QdObject_var containing a dimension reduced object if pulldown is used to select dimension reduction

Parameters:
None 
Exceptions:
None 
Returns:
Returns QdObject_var, nil if conversion fails

Q_POPUP_MENU * QguWLinput::getTivlFromEvtTablePopup (  ) 

Q_POPUP_MENU * QguWLinput::getTivlPopup (  ) 

Q_POPUP_MENU * QguWLinput::getTivlPopupPlus (  ) 

Q_POPUP_MENU * QguWLinput::getTivlSeqSlicePopup (  ) 

Q_POPUP_MENU * QguWLinput::getTrangePopup (  ) 

Q_POPUP_MENU * QguWLinput::getVectorPopup (  ) 

Q_POPUP_MENU * QguWLinput::getVectorPopupPlus (  ) 

Q_POPUP_MENU * QguWLinput::getVectorPopupPlusSlice (  ) 

Q_POPUP_MENU * QguWLinput::getVectorPopupSlice (  ) 

void QguWLinput::hadDropEvent (  )  [signal]

signal emitted drop received

Parameters:
None 
Exceptions:
None 
Returns:
None

bool QguWLinput::hasFocus (  ) 

bool QguWLinput::isTimeSelection (  ) 

void QguWLinput::openArrayReduce (  )  [slot]

void QguWLinput::openSelectMetadata (  )  [slot]

void QguWLinput::openSliceS (  )  [slot]

void QguWLinput::openSliceT (  )  [slot]

void QguWLinput::openSliceV (  )  [slot]

void QguWLinput::openSliceVP (  )  [slot]

dimTripleStack QguWLinput::parseArrayReduce (  ) 

Method that parses text in QguLineEdit and finds the array reduction requested.

Parameters:
None 
Exceptions:
None 
Returns:
vector <dimTriple *>

dimTriple QguWLinput::parseTimeSlice (  ) 

Method that parses text in QguLineEdit and finds the array reduction requested.

Parameters:
None 
Exceptions:
None 
Returns:
vector <dimTriple *>

void QguWLinput::paste (  )  [slot]

Slot that allows paste into contained QguLineEdit.

Parameters:
None 
Exceptions:
None 
Returns:
none

void QguWLinput::resetColour (  )  [slot]

void QguWLinput::reValidate (  )  [slot]

Method that validates the content of the line edit object.

Parameters:
None 
Exceptions:
None 
Returns:
None

void QguWLinput::selectTivlEvent (  )  [slot]

void QguWLinput::selectTivlSeqSubset (  )  [slot]

void QguWLinput::sendTextChanged ( const QString &  txt  )  [slot]

emits textChanged signal to trigger validation. Traps changes made by validator itself

Exceptions:
None 

Returns:
None

void QguWLinput::setAliasKeepComp ( const QString &  txt  ) 

void QguWLinput::setAlignment ( int  flag  ) 

Method that sets the text alignment in the underlying lineEdit.

Parameters:
flag of type int
Exceptions:
None 
Returns:
None

void QguWLinput::setColour ( const QString  validity  ) 

Method that sets the colour of the line edit object on the basis of the validity state of the content of this object.

Parameters:
validity of type const QString
Exceptions:
None 
Returns:
None

void QguWLinput::setCursorPosition ( int  posn  ) 

void QguWLinput::setDouble ( double  value  ) 

bool QguWLinput::setDropdownActive ( QdObject_var  dobj,
const bool  toScalar,
bool  isVec,
bool  useTimeSlicer 
)

This method shows/hides the dropDown arrow if dimension reduction is possible.

Parameters:
dobj of type QdObject_var
toScalar flag of type bool
isVec flag of type bool
useTimeSlicer flag of type bool
Exceptions:
None 
Returns:
None

void QguWLinput::setDropdownTcentre (  )  [slot]

void QguWLinput::setDropdownTend (  )  [slot]

void QguWLinput::setDropdownText_dobj (  )  [slot]

void QguWLinput::setDropdownText_ld (  )  [slot]

void QguWLinput::setDropdownText_lr (  )  [slot]

void QguWLinput::setDropdownText_pd (  )  [slot]

void QguWLinput::setDropdownText_pr (  )  [slot]

void QguWLinput::setDropdownText_r (  )  [slot]

void QguWLinput::setDropdownText_td (  )  [slot]

void QguWLinput::setDropdownText_tr (  )  [slot]

void QguWLinput::setDropdownText_x (  )  [slot]

void QguWLinput::setDropdownText_y (  )  [slot]

void QguWLinput::setDropdownText_z (  )  [slot]

void QguWLinput::setDropdownTstart (  )  [slot]

void QguWLinput::setEdited ( bool  hasBeenEdited  ) 

Method that sets the edited flag from this slot.

Parameters:
hasBeenEdited of type bool
Exceptions:
None 
Returns:
None

void QguWLinput::setEnabled ( bool  enabled  ) 

void QguWLinput::setMaxLength ( int  len  ) 

Method that sets the max text length in the underlying lineEdit.

Parameters:
len of type int
Exceptions:
None 
Returns:
None

void QguWLinput::setReadOnly ( bool  readOnly  ) 

void QguWLinput::setText ( QString  txt  ) 

Method that sets the text in the input slot.

Parameters:
txt of type QString
Exceptions:
None 
Returns:
None

void QguWLinput::setTextKeepComp ( const QString &  txt  ) 

QString QguWLinput::text (  ) 

Method that returns the text in the input slot.

Parameters:
None 
Exceptions:
None 
Returns:
text of type QString

void QguWLinput::textChanged ( const QString &   )  [signal]

signal emitted when input text changes

Parameters:
txt of type QString
Exceptions:
None 
Returns:
None

QString QguWLinput::textObject (  ) 

Method that returns the text in the input slot with component text removed.

Parameters:
None 
Exceptions:
None 
Returns:
text of type QString

void QguWLinput::TimeChosen (  )  [signal]

signal emitted when dropdown component menu selected a time

Parameters:
None 
Exceptions:
None 
Returns:
None

void QguWLinput::validated_alias ( const QString &   )  [signal]

void QguWLinput::validated_EMPTY (  )  [signal]

Function signal that is emitted when line input object does not contain any text.

Parameters:
None 
Exceptions:
None 
Returns:
None

void QguWLinput::validated_INACTIVE (  )  [signal]

Function signal that is emitted when the line input object is set inactive.

Parameters:
None 
Exceptions:
None 
Returns:
None

void QguWLinput::validated_NOT_OK (  )  [signal]

Function signal that is emitted when text entered is not compatible with slot requirements.

Parameters:
None 
Exceptions:
None 
Returns:
None

void QguWLinput::validated_number ( const QString &   )  [signal]

void QguWLinput::validated_OK (  )  [signal]

Function signal that is emitted when any data being entered has been validated with success.

Parameters:
None 
Exceptions:
None 
Returns:
None

void QguWLinput::validated_TEXT ( const QString &   )  [signal]

void QguWLinput::validated_WARN (  )  [signal]

Function signal that is emitted when text entered is incomplete, but valid so far.

Parameters:
None 
Exceptions:
None 
Returns:
None

void QguWLinput::validated_WL_OBJ ( const QString &   )  [signal]

void QguWLinput::validateInput ( const QString &  txt  )  [slot]

Method that validates the input string txt.

Parameters:
txt of type const QString
Exceptions:
None 
Returns:
None

double QguWLinput::value (  ) 

Method that returns the double value in the input slot, if acceptNumber or acceptTime is true.

Parameters:
None 
Exceptions:
None 
Returns:
double


Friends And Related Function Documentation

Vostream& operator<< ( Vostream ,
QguWLinput  
) [friend]

Vistream& operator>> ( Vistream ,
QguWLinput  
) [friend]


Member Data Documentation

Public flag, true if slot accepts a name on the specified QguListView * aliasList.

Public flag, true if slot accepts a name on the specified QguListView * aliasList. Restricted to Scalar.

Public flag, true if slot accepts a name on the specified QguListView * aliasList. Restricted to Vector.

Public flag, true implies QguWLinput accepts QdRMatrix_var and QdRMatrixSeq_var input.

Public flag, true implies QguWLinput accepts QdRMatrix_var input if it has TIME_TAGS xref.

Public flag, true implies QguWLinput accepts number input to be used as time duration.

Public flag, true implies QguWLinput accepts integer input (using atoi() from text input).

Public flag, true implies QguWLinput accepts numerical input (using atof() from text input).

Public flag, true implies QguWLinput accepts QdObject_var input.

Public flag, true implies QguWLinput accepts QdObject_var input only for dimension reduction.

Public flag, true implies QguWLinput accepts QdObject_var input permitting dimension reduction.

Public flag, true implies QguWLinput accepts any input if it has TIME_TAGS xref.

Public flag, true implies QguWLinput accepts QdRScalar_var and QdRScalarSeq_var input.

Public flag, true implies QguWLinput accepts QdRScalar_var and QdRScalarSeq_var input if it has TIME_TAGS xref.

Public flag, true implies QguWLinput accepts any keyboard text input.

Public flag, true implies QguWLinput accepts any valid ISO time text string input.

Public flag, true implies QguWLinput accepts QdTime_var input.

Public flag, true if slot accepts slice or average down to single time.

Public flag, true if slot accepts slice, average down or subset on time.

Public flag, true implies QguWLinput accepts QdTimeInterval_var input.

Public flag, true implies QguWLinput accepts QdTimeIntervalSeq_var input.

Public flag, true implies QguWLinput accepts QdTimeSequenace_var or QdObject_var input with a TIME_TAGS xref.

Public flag, true implies QguWLinput accepts QdRMatrix_var and QdRMatrixSeq_var input that satisfies QuIsThreeVector.

Public flag, true implies QguWLinput accepts QdRMatrix_var input if it has TIME_TAGS xref, that satisfies QuIsThreeVector,.

Public flag set to signify that this QguWLinput is active (accepts input).

Q_POPUP_MENU* QguWLinput::arrayPopup

flag to show a manual edit has taken place

Q_POPUP_MENU* QguWLinput::defaultPopup

nil object for use when invalid slot input text so that a .is)nil() object is returned

The WL context for the valid object or the alias name.

nil string used when input did not validate OK

the type of object resloved to, "text", "object", "number", "timeString"

local flag to trap re-validation following a refresh of the input during validation. No infinite loop.

flag for current item is array

flag for current item is vector

Q_POPUP_MENU* QguWLinput::TivlPopup

Q_POPUP_MENU* QguWLinput::TrangePopup

flag to let initialisation of Time object without validation to time string

Q_POPUP_MENU* QguWLinput::vectorPopup

Public member defining how the list view is being saved (saved with/without data).


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

Generated on Tue Dec 9 16:55:37 2008 for QSAS by  doxygen 1.5.7