All Frameworks Class Hierarchy This Framework Indexes Previous Next

Dialog CATDlgControl

Usage: you must use this class as is. You should never derive it.

public class CATDlgControl

Base class for dialog controls.
Role: This class is the control base class to share unit and contextual menu management. Its derived classes can be :

for the controls : , , , , , , , , ,

and for the indicators: , , .

The parent of an instance of a class that derives from CATDlgControl must be an instance of a class that derives from , , and . Some controls can have a or a as parent.
This class can not be instantiated.

Method Index

o GetContextualMenu(): Returns the contextual menu of the control if any.
o GetMagnitude(): Returns the magnitude to be used for the value displayed.
o GetPrecision(): Returns the precision to be used for the value displayed.
o GetUnit(): Returns the unit to be used for the value displayed.
o SetIconBitmap(unsigned char*,int,int): Associates a monochrome icon to a Dialog control object.
o SetMagnitude(CATDlgMagnitude): Sets the magnitude to be used for the value displayed.
o SetPrecision(int,CATBoolean): Sets the precision to be used for the value displayed.
o SetUnit(CATDlgUnit): Sets the unit to be used for the value displayed.

o CATDlgMagnitude: Possible magnitude for controls.
o CATDlgUnit: Possible units for control.

Methods

o GetContextualMenu

public GetContextualMenu(

)

Returns the contextual menu of the control if any.

o GetMagnitude

public GetMagnitude(

)

Returns the magnitude to be used for the value displayed.

o GetPrecision

public GetPrecision(

)

Returns the precision to be used for the value displayed.

o GetUnit

public GetUnit(

)

Returns the unit to be used for the value displayed.

o SetIconBitmap

public SetIconBitmap(	const	`iBitmap`,
		`iWidth`,
		`iHeight`)

Associates a monochrome icon to a Dialog control object. Once defined such an icon overrides any definition done by SetIconName or by name in a resource file. This method is relevant for CATDlgPushButton, CATDlgCheckButtons and CATDlgRadioButtons objects ONLY.

Parameters:

iBitmap: The monochrome bitmap representing the icon. The length expected is (iWidth+7)/8 * iHeight. Providing a NULL value removes a previous definition.
iWidth: The width of the icon.
iHeight: The height of the icon.

o SetMagnitude

public SetMagnitude( iMagnitude)

Sets the magnitude to be used for the value displayed.

Parameters:

iMagnitude: The magnitude to set.

o SetPrecision

public SetPrecision(		`iPrecision`,
		`iDecimalPrecision`	`=FALSE`)

Sets the precision to be used for the value displayed.

Parameters:

iPrecision

The precision to set.

iDecimalPrecision

Legal values:

TRUE: the precision gives the number of digits to appear after the decimal point character.
FALSE: the precision gives the number of significative digits. (default)

o SetUnit

public SetUnit( iUnit)

Sets the unit to be used for the value displayed.

Parameters:

iUnit: The unit to set.

Enumerated Types

o CATDlgMagnitude

enum CATDlgMagnitude {
  AbsoluteViscosity,
  Acceleration,
  Angle,
  Area,
  VolumicMass,
  DissolvedSolidFraction,
  Energy,
  Force,
  HeatCapacity,
  Inertia,
  KinematicViscosity,
  Length,
  LinearMass,
  LineicForce,
  Mass,
  MassicFlow,
  MolecularWeight,
  Moment,
  Pressure,
  AngularStiffness,
  Slope,
  Speed,
  SpecificHeatCapacity,
  Stress,
  SurfacicTension,
  Temperature,
  ThermalConductivity,
  TimeMagnitude,
  LinearStiffness,
  Volume,
  VolumetricFlow,
  SolidAngle,
  Scalar,
  VolumicForce,
  AngularVelocity,
  AngularAcceleration,
  Dilatation,
  Frequency,
  SurfacicMass
}

Possible magnitude for controls.

Parameters:

AbsoluteViscosity
Acceleration
Angle
Area
VolumicMass
DissolvedSolidFraction
Energy
Force
HeatCapacity
Inertia
KinematicViscosity
Length
LinearMass
LineicForce
Mass
MassicFlow
MolecularWeight
Moment
Pressure
AngularStiffness
Slope
Speed
SpecificHeatCapacity
Stress
SurfacicTension
Temperature
ThermalConductivity
TimeMagnitude
LinearStiffness
Volume
VolumetricFlow
SolidAngle
Scalar
VolumicForce
AngularVelocity
AngularAcceleration
Dilatation
Frequency
SurfacicMass

o CATDlgUnit

enum CATDlgUnit {
  Decapoise,
  Poise,
  Centipoise,
  Millipoise,
  Micropoise,
  LbfSecondPerSqFt,
  LbfSecondPerSqIn,
  PoundPerSecondFoot,
  MeterPerSquareSecond,
  FootPerSquareSecond,
  InchPerSquareSecond,
  Radian,
  Degree,
  ArcMinute,
  ArcSecond,
  Grade,
  SquareMeter,
  SquareMillimeter,
  SquareCentimeter,
  SquareInch,
  SquareFoot,
  KilogramPerM3,
  PoundPerCubicFoot,
  PoundPerCubicInch,
  Fraction,
  Percentage,
  PartPerMillion,
  Joule,
  WattXHour,
  BritishThermalUnit,
  PoundforceXFoot,
  Newton,
  Poundforce,
  JoulePerKelvin,
  BtuPerFahrenheit,
  Meter4,
  Millimeter4,
  Centimeter4,
  Inch4,
  Foot4,
  SquareMeterPerSecond,
  Stoke,
  SquareFootPerSecond,
  Meter,
  Micrometer,
  Millimeter,
  Centimeter,
  Kilometer,
  Inch,
  Foot,
  FeetInchFraction64,
  FeetInchFraction16,
  FeetInchDecimal,
  KilogramPerMeter,
  PoundPerFoot,
  PoundPerInch,
  NewtonPerMeter,
  PoundforcePerFoot,
  PoundforcePerInch,
  Kilogram,
  Gram,
  Ton,
  Pound,
  KilogramPerSecond,
  PoundPerHour,
  KilogramPerHour,
  PoundPerMinute,
  KilogramPerMole,
  GramPerMole,
  NewtonXMeter,
  PoundforceXInch,
  NewtonXMillimeter,
  NewtonPerSquareMeter,
  Pascal,
  LbforcePerSquareInch,
  NewtonMeterPerRadian,
  NewtonMMPerMradian,
  PoundforceInchPerRad,
  SlopeRatio,
  SlopePercentage,
  SlopeInCmPerM,
  SlopeInMMPerM,
  SlopeInInchPerFoot,
  MeterPerSecond,
  FootPerSecond,
  MilePerHour,
  KilometerPerHour,
  FootPerMinute,
  FootPerHour,
  JoulePerKgKelvin,
  BtuPerLbFahren,
  NewtonPerSqMeter,
  LbforcePerSqInch,
  KilogramPerSqSecond,
  DynePerCentimeter,
  Kelvindegree,
  Celsius,
  Fahrenheit,
  JoulePerMSecKelvin,
  BtuFtPerHrFt2Fahren,
  Second,
  Hour,
  NewtonperMeter,
  NewtonperMillimeter,
  PoundforceperFoot,
  PoundforceperInch,
  CubicMeter,
  CubicMillimeter,
  CubicCentimeter,
  CubicInch,
  CubicFoot,
  Liter,
  CubicMeterPerSecond,
  CubicMeterPerHour,
  CubicFootPerHour,
  USGallonPerMinute,
  BarrelPerHour,
  BarrelPerDay,
  CubicFootPerMinute,
  LiterPerSecond,
  Steradian,
  Number,
  NewtonPerCubicMeter,
  LbforcePerCubicInch,
  RadianPerSecond,
  DegreePerSecond,
  GradePerSecond,
  RadianPerSquareSecond,
  DegreePerSquareSecond,
  GradePerSquareSecond,
  PerFahrenheit,
  PerCelsius,
  Herz,
  KilogramPerSquareMeter,
  PoundPerSquareInch
}

Possible units for control.

Parameters:

Decapoise,Poise,Centipoise,Millipoise,Micropoise,LbfSecondPerSqFt,LbfSecondPerSqIn,PoundPerSecondFoot: Absolute viscosity units.
MeterPerSquareSecond,FootPerSquareSecond,InchPerSquareSecond: Acceleration units.
Radian,Degree,Grade: Angle units.
SquareMeter,SquareMillimeter,SquareCentimeter,SquareInch,SquareFoot: Area units.
KilogramPerM3,PoundPerCubicFoot,PoundPerCubicInch: Volumic mass units.
Fraction,Percentage,PartPerMillion: Dissolved solid fraction units.
Joule,WattXHour,BritishThermalUnit,PoundforceXFoot: Energy units.
Newton,Poundforce: Force units.
JoulePerKelvin,BtuPerFahrenheit: Heat capacity units.
Meter4,Millimeter4,Centimeter4,Inch4,Foot4: Inertia units.
SquareMeterPerSecond,Stoke,SquareFootPerSecond: Kinematic viscosity units.
Meter,Micrometer,Millimeter,Centimeter,Kilometer,Inch,Foot,FeetInchFraction64,FeetInchFraction16,FeetInchDecimal: Length units.
KilogramPerMeter,PoundPerFoot,PoundPerInch: Linear mass units.
NewtonPerMeter,PoundforcePerFoot,PoundforcePerInch: Lineic force units.
Kilogram,Gram,Ton,Pound: Mass units.
KilogramPerSecond,PoundPerHour,KilogramPerHour,PoundPerMinute: Massic flow units.
KilogramPerMole,GramPerMole: Molecular weight units.
NewtonXMeter,PoundforceXInch,NewtonXMillimeter: Moment units.
NewtonPerSquareMeter,Pascal,LbforcePerSquareInch: Pressure units.
NewtonMeterPerRadian,NewtonMMPerMradian,PoundforceInchPerRad: Angular stiffness units.
SlopeRatio,SlopePercentage,SlopeInCmPerM,SlopeInMMPerM,SlopeInInchPerFoot: Slope units.
MeterPerSecond,FootPerSecond,MilePerHour,KilometerPerHour,FootPerMinute,FootPerHour: Speed units.
JoulePerKgKelvin,BtuPerLbFahren: Specific heat capacity units.
NewtonPerSqMeter,LbforcePerSqInch: Stress units.
KilogramPerSqSecond,DynePerCentimeter: Surfacic tension units.
Kelvindegree,Celsius,Fahrenheit: Temperature units.
JoulePerMSecKelvin,BtuFtPerHrFt2Fahren: Thermal conductivity units.
Second,Hour: Time units.
NewtonperMeter,NewtonperMillimeter,PoundforceperFoot,PoundforceperInch: Linear stiffness units.
CubicMeter,CubicMillimeter,CubicCentimeter,CubicInch,CubicFoot,Liter: Volume units.
CubicMeterPerSecond,CubicMeterPerHour,CubicFootPerHour,USGallonPerMinute,BarrelPerHour,BarrelPerDay,CubicFootPerMinute,LiterPerSecond: Volumetric flow units.
Steradian: Solid angle units.
Number: Scalar units.
NewtonPerCubicMeter,LbforcePerCubicInch: VolumicForce units.
RadianPerSecond,DegreePerSecond,GradePerSecond: AngularVelocity units.
RadianPerSquareSecond,DegreePerSquareSecond,GradePerSquareSecond: AngularAcceleration units.
PerFahrenheit,PerCelsius: Dilatation units.
Herz: Frequency units.
KilogramPerSquareMeter,PoundPerSquareInch: SurfacicMass units.

This object is included in the file: CATDlgControl.h
If needed, your Imakefile.mk should include the module: DI0PANV2

Dialog writeClassCharacteristic(); CATDlgControl

Method Index

Enumerated Type Index

Methods

Enumerated Types

Dialog CATDlgControl