Version: 6.3.1
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Static Protected Member Functions | Private Types | Private Member Functions | Private Attributes

QDS_RadioBox Class Reference

#include <QDS_RadioBox.h>

Inheritance diagram for QDS_RadioBox:
Inheritance graph

Public Types

enum  DatumFlags {
  None = 0x00, Label = 0x01, Control = 0x02, Units = 0x04,
  NotFormat = 0x08, NotAccel = 0x10, UnitsWithLabel = 0x20, All = Label | Control | Units
}
 

Enum describes bit flags of the Qt datum view and behaviour.

More...

Public Slots

void setEnabled (bool)
 Enable/disable main control subwidget (QDS.Control).

Signals

void activated (int)
 The signal is emitted when any radio button is toggled.
void paramChanged ()
 The signal is emitted when the datum value is changed.
void paramChanged (QString &)

Public Member Functions

 QDS_RadioBox (const QString &, QWidget *=0, const int=Control, const QString &=QString())
 Constructor.
virtual ~QDS_RadioBox ()
 Destructor.
int count (bool=false) const
 Get number of buttons in radio box.
void values (QList< int > &, bool=false) const
 Get buttons identifiers.
int columns () const
void setColumns (const int)
bool state (const int) const
 Get visibility state of the button specified by id.
void setState (const bool, const int, const bool=true)
 Set the visibility state of the button specified by id.
void setState (const bool, const QList< int > &, const bool=true)
 Set the visibility state of buttons specified by ids.
void setValues (const QList< int > &, const QStringList &)
 Set the custom user buttons into the radio box.
void setValues (const QStringList &)
 Set the custom user buttons into the radio box.This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. User buttons like standard dictionary buttons will be added into the radio box. This function allows user to customize buttons.
QString id () const
 Get the datum ID.
int type () const
 Get the datum value type.
QString label () const
 Get the datum label text.
QString units () const
 Get the datum units text.
QString filter () const
 Get the datum filter string.
QString format () const
 Get the datum format string.
QString longDescription () const
 Get the datum long description.
QString shortDescription () const
 Get the datum short description.
QString defaultValue () const
 Get the datum default value.
QString minimumValue () const
 Get the datum minimum value.
QString maximumValue () const
 Get the datum maximum value.
QStringList options () const
 Get the datum options names.
QVariant option (const QString &) const
 Get datum option specified by name as QVariant.
QString optionString (const QString &) const
 Get datum option specified by name as string.
double optionDouble (const QString &) const
 Get datum option specified by name as double.
int optionInteger (const QString &) const
 Get datum option specified by name as integer.
virtual QVariant value () const
 Get the datum value as QVariant.
virtual QString stringValue () const
 Get the datum value as string.
virtual double doubleValue () const
 Get the datum value as double.
virtual int integerValue () const
 Get the datum value as integer.
QString text () const
 Get the text data from datum.
virtual bool isEmpty () const
 Check if the datum is empty.
virtual void reset ()
 Reset datum state and set default value as current.
virtual void clear ()
 Clear the control.
virtual void setValue (const QVariant &)
 Set datum value from QVariant object.
virtual void setStringValue (const QString &)
 Set datum value from string data.
virtual void setDoubleValue (const double)
 Set datum value from double data.
virtual void setIntegerValue (const int)
 Set datum value from integer data.
virtual bool isEnabled (const int=Control) const
 Get 'enabled' state of the specified subwidget.
virtual void setEnabled (const bool, const int)
 Enable/disable subwidgets specified by element.
void show (const int=All)
 Show subwidgets specified by element.
void hide (const int=All)
 Hide subwidgets specified by element.
virtual void setShown (const bool, const int=All)
 Show/hide subwidgets specified by flags.
QWidgetwidget (const int) const
 Get subwidget specified by element.
void setFocus ()
 Set the input focus to the control widget.
virtual bool isValid (const bool=true, const QString &=QString(), const QString &=QString()) const
 Check if input data is valid.
virtual QValidatorvalidator (const bool=false) const
 Create validator according to the datum type of value.
void addTo (QVBoxLayout *)
 Add widgets to the vertical box layout.
void addTo (QHBoxLayout *)
 Add widgets to the horizontal box layout.
void addTo (QGridLayout *, const int, const int, const bool=false)
 Add widgets to the grid layout.
virtual void setAlignment (const int, const int=Label)
 Set the aligment for QDS.Label and/or QDS.Units subwidgets.
virtual bool eventFilter (QObject *, QEvent *)
 Event filter.
 operator QWidget * () const
 Overloaded operator used to retrieve main subwidget named QDS.Control.
bool isCustomTr () const
 Return state of custom translation.
void enableCustomTr (const bool)
 Change state of custom translation.

Static Public Member Functions

static QString units (const QString &)
 Get displayable units string for specified data dictionary item.
static QString format (const QString &, const QString &, const bool=false)
 Format the specified string as dictionary item value.
static QString format (const int, const QString &, const bool=false)
 Format the specified integer as dictionary item value.
static QString format (const double, const QString &, const bool=false)
 Format the specified double as dictionary item value.
static QString unitsToText (const QString &)
 Convert units into text presentation.
static QString textToUnits (const QString &)
 Convert text presentation into internal units format.
static bool load (const QString &)
 Load datum definitions from XML file dictPath to the dictionary.
static QString unitSystemLabel (const QString &, const QString &=QString())
 Get the label of unit system sys.
static QString activeUnitSystem (const QString &=QString())
 Get the name of active unit system from the specified component comp.
static void setActiveUnitSystem (const QString &, const QString &=QString())
 Set the active unit system.
static QString toQString (const TCollection_AsciiString &)
 Convert the OpenCascade ASCII string to Qt string.
static QString toQString (const TCollection_ExtendedString &)
 Convert the OpenCascade Unicode string to Qt string.
static QString toQString (const Handle(TCollection_HAsciiString)&)
 Convert the OpenCascade ASCII string to Qt string.
static QString toQString (const Handle(TCollection_HExtendedString)&)
 Convert the OpenCascade Unicode string to Qt string.
static TCollection_AsciiString toAsciiString (const QString &)
 Convert the Qt string to OpenCascade ASCII string.
static TCollection_AsciiString toAsciiString (const TCollection_ExtendedString &)
 Convert the OpenCascade Unicode string to OpenCascade ASCII string.
static TCollection_AsciiString toAsciiString (const Handle(TCollection_HExtendedString)&)
 Convert the OpenCascade Unicode string to OpenCascade ASCII string.
static TCollection_ExtendedString toExtString (const QString &)
 Convert the Qt string to OpenCascade Unicode string.
static TCollection_ExtendedString toExtString (const TCollection_AsciiString &)
 Convert the OpenCascade ASCII string to OpenCascade Unicode string.

Protected Slots

virtual void onToggled (bool)
 Called when user toggles any radio button.
virtual void onParamChanged ()
 Called when datum value is changed.

Protected Member Functions

QButtonGroup * buttonGroup () const
 Get internal button group.
QGroupBoxgroupBox () const
 Get internal group box widget.
virtual QWidgetcreateControl (QWidget *)
 Get radio button group box widget.
void buttons (QList< QRadioButton * > &) const
 Get all the radio buttons from the radio box.
virtual QString getString () const
 Get string from the radio box.
virtual void setString (const QString &)
 Set the string value to the radio box widget.
virtual void unitSystemChanged (const QString &)
 Process notification about active units system changing.
QLabellabelWidget () const
 Get QDS.Label widget.
QLabelunitsWidget () const
 Get QDS.Units widget.
QWidgetcontrolWidget () const
 Get QDS.Control widget.
 Handle (DDS_DicItem) dicItem() const
void setDicItem (const Handle(DDS_DicItem)&)
 Set the dictionary item to the datum.
int flags () const
 Get datum flags.
void invalidateCache ()
 Reset the numeric value cache.
virtual QLabelcreateLabel (QWidget *)
 Create QDS.Label widget.
virtual QLabelcreateUnits (QWidget *)
 Create QDS.Units widget.
virtual bool validate (const QString &) const
 Validate the specified string.
QString prefix () const
 Get prefix string from format.
QString suffix () const
 Get suffix string from format.
virtual QString minValue () const
 Get minimum value.
virtual QString maxValue () const
 Get maximum value.
void initDatum () const
 Perform initialization if it needed.

Static Protected Member Functions

static QString format (const QString &, const int, const int)
 Format the given value according to the data dictionary item type.
static QString format (const QString &, const int, const double)
 Format the given value according to the data dictionary item type.
static QString format (const QString &, const int, const QString &)
 Format the given value according to the data dictionary item type.
static QString sprintf (const QString &, const int)
 Wrapper around the standard sprintf() function.
static QString sprintf (const QString &, const double)
 Wrapper around the standard sprintf() function.This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Process some non standard flags from format string.
static QString sprintf (const QString &, const QString &)
 Wrapper around the standard sprintf() function.This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Process some non standard flags from format string.
static void insertDatum (QDS_Datum *)
 Register given datum datum in the global list.
static void removeDatum (QDS_Datum *)
 Remove given datum datum from the global list.

Private Types

typedef QMap< int, QString > IdValueMap
typedef QMap< int, bool > IdStateMap

Private Member Functions

void updateRadioBox ()
 Update radio box.

Private Attributes

IdValueMap myValue
IdStateMap myState
QIntList myDataIds
QIntList myUserIds
QStringList myUserNames
QButtonGroup * myButtonGroup

Member Typedef Documentation

typedef QMap<int, QString> QDS_RadioBox.IdValueMap [private]
typedef QMap<int, bool> QDS_RadioBox.IdStateMap [private]

Member Enumeration Documentation

enum QDS::DatumFlags [inherited]
Enumerator:
None 

Non specified any flags (Default behaviour)

Label 

Create subwidget for datum label.

Control 

Create subwidget for datum input control.

Units 

Create subwidget for datum units of measure.

NotFormat 

Don't format initial value.

NotAccel 

Not support accelerators in datum label.

UnitsWithLabel 

Display units of measure in label like "<label_text> (<units_text>) instead separate text".

All 

Create all subwidgets.


Constructor & Destructor Documentation

QDS_RadioBox::QDS_RadioBox ( const QString &  id,
QWidget parent = 0,
const int  flags = Control,
const QString &  comp = QString() 
)

Create radio button box datum object with datum identifier id and parent widget parent.

Parameter flags defines behaviour of datum and set of created subwidgets. Default value of this parameter is QDS.All.

Parameter comp specifies the component name which will be used when searching the dictionary item.

Parameters:
iddatum identifier
parentparent widget
flagsdatum flags
compcomponent
QDS_RadioBox::~QDS_RadioBox ( ) [virtual]

Member Function Documentation

int QDS_RadioBox::count ( bool  total = false) const

If total is false, only visible buttons are taken into account; otherwise total number of buttons is returned

Parameters:
totalget number of visible buttons if true and total number of buttons if false
Returns:
requested number of items

References buttons(), and myValue.

void QDS_RadioBox::values ( QList< int > &  ids,
bool  total = false 
) const
Parameters:
idsreturned list of buttons IDs
totaltake into account only visible buttons if true and all buttons if false

References myDataIds, and myState.

int QDS_RadioBox.columns ( ) const
void QDS_RadioBox.setColumns ( const int  )
bool QDS_RadioBox::state ( const int  id) const
Parameters:
idbutton ID
Returns:
item visibility state

References myState.

void QDS_RadioBox::setState ( const bool  on,
const int  id,
const bool  append = true 
)

If id is -1 then specified state will be set to all buttons.

If append is set to true, keep current status for other buttons, otherwise status of other buttons is cleared.

Parameters:
onnew visibility state
idbutton ID
appendif true, keep original status for other buttons

References myState.

void QDS_RadioBox::setState ( const bool  on,
const QList< int > &  ids,
const bool  append = true 
)

If append is set to true, keep the current status for other buttons, otherwise status of other buttons is cleared.

Parameters:
onnew visibility state
idsbuttons IDs list
appendif true, keep original status for other buttons

References myState, and updateRadioBox().

void QDS_RadioBox::setValues ( const QList< int > &  ids,
const QStringList &  names 
)

User items like standard dictionary buttons will be added into the radio box. This function allows user to customize buttons.

Parameters:
idsbuttons IDs
namesbuttons names

References myUserIds, and myUserNames.

void QDS_RadioBox::setValues ( const QStringList &  names)

Uses (0, 1, 2 ... ) as buttons IDs.

Parameters:
namesbuttons names

References setValues().

void QDS_RadioBox::activated ( int  id) [signal]
Parameters:
idbutton ID
void QDS_RadioBox::onToggled ( bool  on) [protected, virtual, slot]
Parameters:
onnew radio button state

References getString(), QDS_Datum.onParamChanged(), and QDS_Datum.paramChanged().

QButtonGroup * QDS_RadioBox::buttonGroup ( ) const [protected]
Returns:
pointer to the QButtonGroup object

References myButtonGroup.

QGroupBox * QDS_RadioBox::groupBox ( ) const [protected]
Returns:
pointer to the QGroupBox widget

References QDS_Datum.controlWidget().

QWidget * QDS_RadioBox::createControl ( QWidget parent) [protected, virtual]
Returns:
internal group box widget

Implements QDS_Datum.

References myButtonGroup.

void QDS_RadioBox::buttons ( QList< QRadioButton * > &  lst) const [protected]
Parameters:
lstreturned list of radio buttons

References buttonGroup().

QString QDS_RadioBox::getString ( ) const [protected, virtual]

String which contains identifier of the currently selected button is returned.

Returns:
identifier of the current button converted to string

Implements QDS_Datum.

References buttonGroup().

void QDS_RadioBox::setString ( const QString &  txt) [protected, virtual]

Button with the identifier from specified string txt becomes selected in the radio box.

Parameters:
txtstring value

Implements QDS_Datum.

References activated(), buttonGroup(), buttons(), getString(), QDS_Datum.onParamChanged(), and QDS_Datum.paramChanged().

void QDS_RadioBox::unitSystemChanged ( const QString &  system) [protected, virtual]

Update radio box contents.

Parameters:
systemnew active units system

Reimplemented from QDS_Datum.

References groupBox(), QDS_Datum.Handle(), QDS_Datum.label(), myDataIds, myState, myUserIds, myUserNames, myValue, QDS.toQString(), and updateRadioBox().

void QDS_RadioBox::updateRadioBox ( ) [private]
QString QDS_Datum::id ( ) const [inherited]
Returns:
datum ID

References QDS_Datum.initDatum(), and QDS_Datum.myId.

int QDS_Datum::type ( ) const [inherited]
Returns:
datum value type

References QDS_Datum.initDatum(), and DDS_DicItem.Unknown.

QString QDS_Datum::label ( ) const [inherited]
QString QDS_Datum::units ( ) const [inherited]
Returns:
units text

References QDS_Datum.initDatum(), and QDS.toQString().

QString QDS_Datum::units ( const QString &  id) [static, inherited]
Parameters:
iddata dictionary item ID
Returns:
units string

References QDS_Datum.Handle(), QDS.toAsciiString(), QDS.toQString(), and QDS_Datum.unitsToText().

QString QDS_Datum::filter ( ) const [inherited]
Returns:
filter string

References QDS_Datum.initDatum(), and QDS.toQString().

QString QDS_Datum::format ( ) const [inherited]
Returns:
format string

References QDS_Datum.initDatum(), and QDS.toQString().

QString QDS_Datum::format ( const QString &  str,
const QString &  id,
const bool  convert = false 
) [static, inherited]
Parameters:
strstring value being formatted
iddata dictionary ID
convertif true, perform conversion from "SI" units system
Returns:
formatted value

References QDS_Datum.format(), QDS_Datum.Handle(), QDS.toAsciiString(), QDS.toQString(), and DDS_DicItem.Unknown.

QString QDS_Datum::format ( const int  num,
const QString &  id,
const bool  convert = false 
) [static, inherited]
Parameters:
numinteger value being formatted
iddata dictionary ID
convertif true, perform conversion from "SI" units system
Returns:
formatted value

References QDS_Datum.format(), QDS_Datum.Handle(), QDS.toAsciiString(), QDS.toQString(), and DDS_DicItem.Unknown.

QString QDS_Datum::format ( const double  num,
const QString &  id,
const bool  convert = false 
) [static, inherited]
Parameters:
numdouble value being formatted
iddata dictionary ID
convertif true, perform conversion from "SI" units system
Returns:
formatted value

References QDS_Datum.format(), QDS_Datum.Handle(), QDS.toAsciiString(), QDS.toQString(), and DDS_DicItem.Unknown.

QString QDS_Datum::format ( const QString &  aFormat,
const int  aType,
const int  aValue 
) [static, protected, inherited]
Parameters:
aFormatformat string
aTypedata dictionary item type
aValueinteger value being formatted
Returns:
formatted value

References DDS_DicItem.Float, DDS_DicItem.Integer, QDS_Datum.sprintf(), and DDS_DicItem.String.

QString QDS_Datum::format ( const QString &  aFormat,
const int  aType,
const double  aValue 
) [static, protected, inherited]
Parameters:
aFormatformat string
aTypedata dictionary item type
aValuedouble value being formatted
Returns:
formatted value

References DDS_DicItem.Float, DDS_DicItem.Integer, and DDS_DicItem.String.

QString QDS_Datum::format ( const QString &  aFormat,
const int  aType,
const QString &  aValue 
) [static, protected, inherited]
Parameters:
aFormatformat string
aTypedata dictionary item type
aValuestring value being formatted
Returns:
formatted value

References DDS_DicItem.Float, DDS_DicItem.Integer, QDS_Datum.sprintf(), and DDS_DicItem.String.

QString QDS_Datum::longDescription ( ) const [inherited]
Returns:
datum long description

References QDS_Datum.initDatum(), and QDS.toQString().

QString QDS_Datum::shortDescription ( ) const [inherited]
Returns:
datum short description

References QDS_Datum.initDatum(), and QDS.toQString().

QString QDS_Datum::defaultValue ( ) const [inherited]
QString QDS_Datum::minimumValue ( ) const [inherited]
QString QDS_Datum::maximumValue ( ) const [inherited]
QStringList QDS_Datum::options ( ) const [inherited]
Returns:
datum options

References QDS.toQString().

QVariant QDS_Datum::option ( const QString &  name) const [inherited]
Returns:
the option value or invalid QVariant if the option does not exist

References QDS.toAsciiString(), and QDS.toQString().

QString QDS_Datum::optionString ( const QString &  name) const [inherited]
Returns:
the option value or null QString if the option does not exist

References QDS.toAsciiString(), and QDS.toQString().

double QDS_Datum::optionDouble ( const QString &  name) const [inherited]
Returns:
the option value or 0 if the option does not exist

References QDS_Datum.option().

int QDS_Datum::optionInteger ( const QString &  name) const [inherited]
Returns:
the option value or 0 if the option does not exist

References QDS_Datum.option().

QVariant QDS_Datum::value ( ) const [virtual, inherited]
Returns:
datum value

References QDS_Datum.isEmpty(), and QDS_Datum.stringValue().

QString QDS_Datum::stringValue ( ) const [virtual, inherited]
Returns:
datum value converted to string

References QDS_Datum.getString(), QDS_Datum.initDatum(), QDS_Datum.mySourceValue, and QDS_Datum.myTargetValue.

double QDS_Datum::doubleValue ( ) const [virtual, inherited]

The value is converted according to the measure units in the active units system to measure units in "SI" units system.

Returns:
datum value converted to double

Reimplemented in QDS_ComboBox.

References QDS_Datum.getString(), QDS_Datum.initDatum(), QDS_Datum.mySourceValue, and QDS_Datum.myTargetValue.

int QDS_Datum::integerValue ( ) const [virtual, inherited]

The value is converted according to the measure units in the active units system to measure units in "SI" units system.

Returns:
datum value converted to integer

Reimplemented in QDS_ComboBox.

References QDS_Datum.getString(), QDS_Datum.initDatum(), QDS_Datum.mySourceValue, and QDS_Datum.myTargetValue.

QString QDS_Datum::text ( ) const [inherited]

Text consists of label, string value and units.

Returns:
datum text data

References QDS_Datum.initDatum(), QDS_Datum.label(), QDS_Datum.stringValue(), and QDS_Datum.units().

bool QDS_Datum::isEmpty ( ) const [virtual, inherited]
Returns:
false if datum control has value entered

References QDS_Datum.stringValue().

void QDS_Datum::reset ( ) [virtual, inherited]
void QDS_Datum::clear ( ) [virtual, inherited]
void QDS_Datum::setValue ( const QVariant &  val) [virtual, inherited]
Parameters:
valnew value

References QDS_Datum.clear(), and QDS_Datum.setStringValue().

void QDS_Datum::setStringValue ( const QString &  txt) [virtual, inherited]
void QDS_Datum::setDoubleValue ( const double  num) [virtual, inherited]

The value is converted from measure units in "SI" units system to the measure units in the active units system. Format the value using datum format internal if it is required.

Parameters:
numnew value

Reimplemented in QDS_ComboBox.

References QDS_Datum.flags(), QDS_Datum.format(), QDS_Datum.getString(), QDS_Datum.initDatum(), QDS_Datum.mySourceValue, QDS_Datum.myTargetValue, QDS.NotFormat, QDS_Datum.onParamChanged(), QDS_Datum.paramChanged(), QDS_Datum.setString(), and QDS_Datum.type().

void QDS_Datum::setIntegerValue ( const int  num) [virtual, inherited]

The value is converted from measure units in "SI" units system to the measure units in the active units system. Format the value using datum format if it is required.

Parameters:
numnew value

Reimplemented in QDS_ComboBox.

References QDS_Datum.flags(), QDS_Datum.format(), QDS_Datum.getString(), QDS_Datum.initDatum(), QDS_Datum.mySourceValue, QDS_Datum.myTargetValue, QDS.NotFormat, QDS_Datum.onParamChanged(), QDS_Datum.paramChanged(), QDS_Datum.setString(), and QDS_Datum.type().

bool QDS_Datum::isEnabled ( const int  element = Control) const [virtual, inherited]
Parameters:
elementORed subwidget flags (QDS.DatumFlags)
Returns:
true if all subwidgets specified by element are enabled
See also:
setEnabled()

References QDS.Control, QDS_Datum.controlWidget(), QDS_Datum.initDatum(), QDS.Label, QDS_Datum.labelWidget(), QDS.Units, and QDS_Datum.unitsWidget().

void QDS_Datum::setEnabled ( const bool  on,
const int  element 
) [virtual, inherited]

Possible values of element: QDS.Label, QDS.Control, QDS.Units or their ORed combinations.

Parameters:
onnew 'enabled' state
elementORed subwidget flags (QDS.DatumFlags)
See also:
isEnabled()

References QDS.Control, QDS_Datum.controlWidget(), QDS_Datum.initDatum(), QDS.Label, QDS_Datum.labelWidget(), QDS.Units, and QDS_Datum.unitsWidget().

void QDS_Datum::setEnabled ( bool  on) [slot, inherited]
Parameters:
onnew 'enabled' state

References QDS.Control, and QDS_Datum.setEnabled().

void QDS_Datum::show ( const int  element = All) [inherited]

Possible values of element: QDS.Label, QDS.Control, QDS.Units or their ORed combinations.

Parameters:
elementORed subwidget flags (QDS.DatumFlags)
See also:
hide(), setShown()

References QDS_Datum.setShown().

void QDS_Datum::hide ( const int  element = All) [inherited]

Possible values of element: QDS.Label, QDS.Control, QDS.Units or their ORed combinations.

Parameters:
elementORed subwidget flags (QDS.DatumFlags)
See also:
show(), setShown()

References QDS_Datum.setShown().

void QDS_Datum::setShown ( const bool  visible,
const int  flags = All 
) [virtual, inherited]

Possible values of flags: QDS.Label, QDS.Control, QDS.Units or their ORed combinations.

Parameters:
visiblenew 'visibility' state
flagsORed subwidget flags (QDS.DatumFlags)
See also:
show(), hide()

References QDS_Datum.initDatum(), QDS.Units, and QDS_Datum.widget().

QWidget * QDS_Datum::widget ( const int  element) const [inherited]

Possible values of element: QDS.Label, QDS.Control, QDS.Units.

Parameters:
elementsubwidget
Returns:
widget

References QDS_Datum.initDatum(), and QDS_Datum.wrapper().

void QDS_Datum::setFocus ( ) [inherited]
bool QDS_Datum::isValid ( const bool  msgBox = true,
const QString &  extMsg = QString(),
const QString &  extLabel = QString() 
) const [virtual, inherited]

If data is invalid and msgBox is true, the warning message box is shown.

Parameters:
msgBoxif true, show warning message box if input is invalid
extMsgwarning message
extLabeloptional name of the variable (if QDS.Label control is not used)
Returns:
true if input data is valid

References QDS_Datum.controlWidget(), DDS_DicItem.Float, QDS_Datum.format(), QDS_Datum.getString(), QDS_Datum.initDatum(), DDS_DicItem.Integer, QDS_Datum.isDoubleFormat(), QDS_Datum.isEmpty(), QDS_Datum.label(), QDS_Datum.maxValue(), QDS_Datum.minValue(), DDS_DicItem.String, QDS.toQString(), QDS_Datum.type(), and QDS_Datum.validate().

QValidator * QDS_Datum::validator ( const bool  limits = false) const [virtual, inherited]
void QDS_Datum::addTo ( QVBoxLayout *  l) [inherited]
Parameters:
llayout

References QDS.Control, QDS_Datum.initDatum(), QDS.Label, QDS.Units, and QDS_Datum.wrapper().

void QDS_Datum::addTo ( QHBoxLayout *  l) [inherited]
void QDS_Datum::addTo ( QGridLayout *  theLay,
const int  theRow,
const int  theCol,
const bool  vertical = false 
) [inherited]
Parameters:
theLaylayout
theRowlayout row index
theCollayout column index
verticalif true subwidgets are layouted vertically, otherwise - horizontally

References QDS.Control, QDS_Datum.initDatum(), QDS.Label, QDS.Units, and QDS_Datum.wrapper().

void QDS_Datum::setAlignment ( const int  align,
const int  type = Label 
) [virtual, inherited]
Parameters:
alignalignment type (Qt.Alignment)
typeORed subwidget flags

Reimplemented in QDS_LineEdit.

References QDS_Datum.initDatum(), QDS.Label, QDS_Datum.labelWidget(), QDS.Units, and QDS_Datum.unitsWidget().

QString QDS_Datum::unitsToText ( const QString &  uni) [static, inherited]
Parameters:
uniunits to be converted
Returns:
text presentation of units (rich-text)
QString QDS_Datum::textToUnits ( const QString &  txt) [static, inherited]
Parameters:
txttext presentation of units (rich-text)
Returns:
units value
bool QDS_Datum::eventFilter ( QObject o,
QEvent e 
) [virtual, inherited]

Perform delayed initialisation. Reimplemented for internal reasons.

Parameters:
oevent reciever object
eevent
Returns:
true if event should be filtered

References QDS_Datum.initDatum().

QDS_Datum::operator QWidget * ( ) const [inherited]
Returns:
QDS.Control subwidget

References QDS.Control, and QDS_Datum.widget().

bool QDS_Datum::isCustomTr ( ) const [inherited]
Returns:
true if custom translation is enabled

References QDS_Datum.myTr.

void QDS_Datum::enableCustomTr ( const bool  on) [inherited]

Custom translation means that text labels of datums are translated with help of standard Qt mechanism of internationalization. In this case special records should be placed into *.ts files under context "QDS". For example, if label has name "myLabel", the corresponding translation should be written: <context> <name>QDS</name> <message> <source>myLabel</source> <translation>myLabel translation</translation> </message> ...

If custom translation mechanism is deactivated, then labels will be shown with text got from xml data dictionary file

By default, the custom translation is deactivated

Parameters:
on- if it is true, custom translation is activated, otherwise, deactivated

References QDS_Datum.label(), QDS_Datum.labelWidget(), and QDS_Datum.myTr.

void QDS_Datum::paramChanged ( ) [signal, inherited]
void QDS_Datum.paramChanged ( QString &  ) [signal, inherited]
void QDS_Datum::onParamChanged ( ) [protected, virtual, slot, inherited]

Reimplemented in QDS_CheckBox, and QDS_LineEdit.

QLabel * QDS_Datum::labelWidget ( ) const [protected, inherited]
Returns:
label widget

References QDS_Datum.initDatum(), and QDS_Datum.myLabel.

QLabel * QDS_Datum::unitsWidget ( ) const [protected, inherited]
Returns:
units widget

References QDS_Datum.initDatum(), and QDS_Datum.myUnits.

QWidget * QDS_Datum::controlWidget ( ) const [protected, inherited]
Returns:
control widget

References QDS_Datum.initDatum(), and QDS_Datum.myControl.

QDS_Datum.Handle ( DDS_DicItem  ) const [protected, inherited]
void QDS_Datum::setDicItem ( const Handle(DDS_DicItem)&  item) [protected, inherited]
Parameters:
itemhandle to data dictionary item
int QDS_Datum::flags ( ) const [protected, inherited]
Returns:
datum flags (QDS.DatumFlags)

References QDS_Datum.myFlags.

void QDS_Datum::invalidateCache ( ) [protected, inherited]
QLabel * QDS_Datum::createLabel ( QWidget parent) [protected, virtual, inherited]
Parameters:
parentparent widget
Returns:
label widget
QLabel * QDS_Datum::createUnits ( QWidget parent) [protected, virtual, inherited]
Parameters:
parentparent widget
Returns:
units widget
bool QDS_Datum::validate ( const QString &  txt) const [protected, virtual, inherited]
Parameters:
txtstring to be validated
Returns:
true if string contains valid data

References QDS_Datum.format(), QDS_Datum.isDoubleFormat(), DDS_DicItem.String, QDS_Datum.type(), DDS_DicItem.Unknown, and QDS_Datum.validator().

QString QDS_Datum::prefix ( ) const [protected, inherited]
Returns:
current implementation returns null string
QString QDS_Datum::suffix ( ) const [protected, inherited]
Returns:
current implementation returns null string
QString QDS_Datum::minValue ( ) const [protected, virtual, inherited]
Returns:
minimum value

References QDS_Datum.minimumValue(), QDS_Datum.prefix(), and QDS_Datum.suffix().

QString QDS_Datum::maxValue ( ) const [protected, virtual, inherited]
Returns:
maximum value

References QDS_Datum.maximumValue(), QDS_Datum.prefix(), and QDS_Datum.suffix().

QString QDS_Datum::sprintf ( const QString &  fmt,
const int  val 
) [static, protected, inherited]

Process some non standard flags from format string.

Parameters:
fmtstring format
valvalue
Returns:
formatted value

References QDS_Datum.canonicalFormat().

QString QDS_Datum::sprintf ( const QString &  fmt,
const double  val 
) [static, protected, inherited]
Parameters:
fmtstring format
valvalue
Returns:
formatted value

References QDS_Datum.canonicalFormat().

QString QDS_Datum::sprintf ( const QString &  fmt,
const QString &  val 
) [static, protected, inherited]
Parameters:
fmtstring format
valvalue
Returns:
formatted value

References QDS_Datum.canonicalFormat(), QDS_Datum.isDoubleFormat(), rx, and QDS_Datum.sprintf().

void QDS_Datum::initDatum ( ) const [protected, inherited]
bool QDS::load ( const QString &  dictPath) [static, inherited]
Returns:
true if loading is successed or false otherwise.

References QDS.toAsciiString().

QString QDS::unitSystemLabel ( const QString &  sys,
const QString &  comp = QString() 
) [static, inherited]

If component comp is specified and not empty then the function searches the given unit system in the specified component, otherwise all components will be searched.

Parameters:
sysunit system
compcomponent
Returns:
unit system lavel or empty string if unit system is not found

References Handle(), TCollection_AsciiString, QDS.toAsciiString(), and QDS.toQString().

QString QDS::activeUnitSystem ( const QString &  comp = QString()) [static, inherited]

If component is not specified or empty string, then the first found component will be used.

If component exists, then active unit system name is returned. Otherwise, empty string is returned.

Parameters:
compcomponent
Returns:
name of the active unit system

References Handle(), QDS.toAsciiString(), and QDS.toQString().

void QDS::setActiveUnitSystem ( const QString &  sys,
const QString &  comp = QString() 
) [static, inherited]

If not empty component name comp is specified, then the unit system will be activated in the given component, otherwise all components will be processed.

After the changing of active unit system function notifies about it all registered datums from processed components using method QDS_Datum.unitSystemChanged()

Parameters:
unitsystem to be set active
compcomponent

References QDS._datumList, QDS.activeUnitSystem(), Handle(), TCollection_AsciiString, QDS.toAsciiString(), and QDS_Datum.unitSystemChanged().

QString QDS::toQString ( const TCollection_AsciiString src) [static, inherited]
Parameters:
srcOCC ASCII string
Returns:
Qt string
QString QDS::toQString ( const TCollection_ExtendedString &  src) [static, inherited]
Parameters:
srcOCC Unicode string
Returns:
Qt string

References TCollection_AsciiString, and QDS.toQString().

QString QDS::toQString ( const Handle(TCollection_HAsciiString)&  src) [static, inherited]
Parameters:
srchandle to OCC ASCII string
Returns:
Qt string

References QDS.toQString().

QString QDS::toQString ( const Handle(TCollection_HExtendedString)&  src) [static, inherited]
Parameters:
srchandle to OCC Unicode string
Returns:
Qt string

References QDS.toQString().

TCollection_AsciiString QDS::toAsciiString ( const QString &  src) [static, inherited]
Parameters:
srcQt string
Returns:
OCC ASCII string

References TCollection_AsciiString.

TCollection_AsciiString QDS::toAsciiString ( const TCollection_ExtendedString &  src) [static, inherited]
Parameters:
srcOCC Unicode string
Returns:
OCC ASCII string

References TCollection_AsciiString.

TCollection_AsciiString QDS::toAsciiString ( const Handle(TCollection_HExtendedString)&  src) [static, inherited]
Parameters:
srchandle to OCC Unicode string
Returns:
OCC ASCII string

References TCollection_AsciiString, and QDS.toAsciiString().

TCollection_ExtendedString QDS::toExtString ( const QString &  src) [static, inherited]
Parameters:
srcQt string
Returns:
OCC Unicode string
TCollection_ExtendedString QDS::toExtString ( const TCollection_AsciiString src) [static, inherited]
Parameters:
srcOCC ASCII string
Returns:
OCC Unicode string
void QDS::insertDatum ( QDS_Datum datum) [static, protected, inherited]

This function is invoked automatically by QDS_Datum constructor.

Parameters:
datumdatum being registered

References QDS._datumList.

void QDS::removeDatum ( QDS_Datum datum) [static, protected, inherited]

This function is invoked automatically by QDS_Datum destructor.

Parameters:
datumdatum being unregistered

References QDS._datumList.


Field Documentation

QStringList QDS_RadioBox.myUserNames [private]
QButtonGroup* QDS_RadioBox.myButtonGroup [private]
Copyright © 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS