ProcessViewBrowser-ServerProgramming
Functions
Construction

Functions

int pvStartDefinition (PARAM *p, int num_objects)
 
int pvQWidget (PARAM *p, int id, int parent)
 
int pvQLayoutVbox (PARAM *p, int id, int parent)
 
int pvQLayoutHbox (PARAM *p, int id, int parent)
 
int pvQLayoutGrid (PARAM *p, int id, int parent)
 
int pvQLabel (PARAM *p, int id, int parent)
 
int pvQComboBox (PARAM *p, int id, int parent, int editable, int policy)
 
int pvQLineEdit (PARAM *p, int id, int parent)
 
int pvQPushButton (PARAM *p, int id, int parent)
 
int pvQLCDNumber (PARAM *p, int id, int parent, int numDigits, int segmentStyle, int mode)
 
int pvQSlider (PARAM *p, int id, int parent, int minValue, int maxValue, int pageStep, int value, int orientation)
 
int pvQButtonGroup (PARAM *p, int id, int parent, int columns, int orientation, const char *title)
 
int pvQRadioButton (PARAM *p, int id, int parent)
 
int pvQCheckBox (PARAM *p, int id, int parent)
 
int pvQFrame (PARAM *p, int id, int parent, int shape, int shadow, int line_width, int margin)
 
int pvQDraw (PARAM *p, int id, int parent)
 
int pvQImage (PARAM *p, int id, int parent, const char *imagename, int *w=NULL, int *h=NULL, int *depth=NULL)
 
int pvQGL (PARAM *p, int id, int parent)
 
int pvQTabWidget (PARAM *p, int id, int parent)
 
int pvQToolBox (PARAM *p, int id, int parent)
 
int pvQGroupBox (PARAM *p, int id, int parent, int columns, int orientation, const char *title)
 
int pvQListBox (PARAM *p, int id, int parent)
 
int pvQTable (PARAM *p, int id, int parent, int rows, int columns)
 
int pvQSpinBox (PARAM *p, int id, int parent, int min, int max, int step)
 
int pvQDial (PARAM *p, int id, int parent, int min, int max, int page_step, int value)
 
int pvQProgressBar (PARAM *p, int id, int parent, int total_steps, int orientation=Horizontal)
 
int pvQMultiLineEdit (PARAM *p, int id, int parent, int editable, int max_lines)
 
int pvQTextBrowser (PARAM *p, int id, int parent)
 
int pvQListView (PARAM *p, int id, int parent)
 
int pvQIconView (PARAM *p, int id, int parent)
 
int pvQVtkTclWidget (PARAM *p, int id, int parent)
 
int pvQwtPlotWidget (PARAM *p, int id, int parent, int nCurves, int nMarker)
 
int pvQwtScale (PARAM *p, int id, int parent, int pos)
 
int pvQwtThermo (PARAM *p, int id, int parent)
 
int pvQwtKnob (PARAM *p, int id, int parent)
 
int pvQwtCounter (PARAM *p, int id, int parent)
 
int pvQwtWheel (PARAM *p, int id, int parent)
 
int pvQwtSlider (PARAM *p, int id, int parent)
 
int pvQwtDial (PARAM *p, int id, int parent)
 
int pvQwtCompass (PARAM *p, int id, int parent)
 
int pvQwtAnalogClock (PARAM *p, int id, int parent)
 
int pvQDateEdit (PARAM *p, int id, int parent)
 
int pvQTimeEdit (PARAM *p, int id, int parent)
 
int pvQDateTimeEdit (PARAM *p, int id, int parent)
 
int pvQCustomWidget (PARAM *p, int id, int parent, const char *name, const char *arg=NULL)
 
int pvEndDefinition (PARAM *p)
 
int pvAddWidgetOrLayout (PARAM *p, int id, int item, int row, int col)
 
int pvAddStretch (PARAM *p, int id, int param)
 
int pvTabOrder (PARAM *p, int id1, int id2)
 
int pvDeleteWidget (PARAM *p, int id)
 

Detailed Description

This function is intended for script languages.
It will translate text to different languages.
See pvSelectLanguage()
C/C++ pvservers may use the pvtr(txt) macro instead.

These are the construction routines for the widgets. Normally you need not to use them because these calls are generated by ui2pvc.

Function Documentation

◆ pvAddStretch()

int pvAddStretch ( PARAM p,
int  id,
int  param 
)
add stretch to layout

◆ pvAddWidgetOrLayout()

int pvAddWidgetOrLayout ( PARAM p,
int  id,
int  item,
int  row,
int  col 
)
add widget or layout to layout.

◆ pvDeleteWidget()

int pvDeleteWidget ( PARAM p,
int  id 
)
delete widget and it's children.

◆ pvEndDefinition()

int pvEndDefinition ( PARAM p)
Call this function when you are finished with the definition of your mask.

◆ pvQButtonGroup()

int pvQButtonGroup ( PARAM p,
int  id,
int  parent,
int  columns,
int  orientation,
const char *  title 
)

◆ pvQCheckBox()

int pvQCheckBox ( PARAM p,
int  id,
int  parent 
)

◆ pvQComboBox()

int pvQComboBox ( PARAM p,
int  id,
int  parent,
int  editable,
int  policy 
)

◆ pvQCustomWidget()

int pvQCustomWidget ( PARAM p,
int  id,
int  parent,
const char *  name,
const char *  arg = NULL 
)
create a QCustomWidget provided by a plugin.
name := "/library/widgettype<:arg>" defined by the whats_this property in the designer.
        library is the name without the platform dependend extension (.so, .dll, .dylib).
        The library_filename will be PVB_WIDGET_PLUGINDIR/library.platform_extension.
        PVB_WIDGET_PLUGINDIR is defined in the pvbrowser ini file.
arg  := argument for the widget constructor defined by the whats_this property in the designer.
Functions that apply to this widget:
pvSetWhatsThis()
pvWhatsThisPrintf()
pvToolTip()
pvSetGeometry()
pvSetMinSize()
pvSetMaxSize()
pvMove();
pvResize();
pvHide();
pvShow();
pvSetStyleSheet()
pvPrintfStyleSheet();
pvSetPaletteBackgroundColor()
pvSetPaletteForegroundColor()
pvSetFontColor()
pvSetFont()
pvSetEnabled()
pvSetFocus()
pvCopyToClipboard()
pvSaveAsBmp()
pvSetWidgetProperty()

◆ pvQDateEdit()

int pvQDateEdit ( PARAM p,
int  id,
int  parent 
)

◆ pvQDateTimeEdit()

int pvQDateTimeEdit ( PARAM p,
int  id,
int  parent 
)

◆ pvQDial()

int pvQDial ( PARAM p,
int  id,
int  parent,
int  min,
int  max,
int  page_step,
int  value 
)

◆ pvQDraw()

int pvQDraw ( PARAM p,
int  id,
int  parent 
)

◆ pvQFrame()

int pvQFrame ( PARAM p,
int  id,
int  parent,
int  shape,
int  shadow,
int  line_width,
int  margin 
)

◆ pvQGL()

int pvQGL ( PARAM p,
int  id,
int  parent 
)

◆ pvQGroupBox()

int pvQGroupBox ( PARAM p,
int  id,
int  parent,
int  columns,
int  orientation,
const char *  title 
)

◆ pvQIconView()

int pvQIconView ( PARAM p,
int  id,
int  parent 
)

◆ pvQImage()

int pvQImage ( PARAM p,
int  id,
int  parent,
const char *  imagename,
int *  w = NULL,
int *  h = NULL,
int *  depth = NULL 
)
Creates a new QImage. See also pvQWidget().
If you specify the name of a 8bpp bmp file:
w = width of image will be returned   (w must be a multiple of 2)
h = height of image will be returned  (h must be a multiple of 2)
depth = number of bits per pixel (currently only 8 is supported)
A color of red=1 green=1 blue=1 will be treated as transparent
If you specify any other file format:
1) The format must be supported by Qt
2) you have to download the file to the client first
   see: int pvDownloadFile(PARAM *p, const char *filename);
w = 0
h = 0
depth = 0
will be returned
Using Qt Designer:
Insert a QFrame
set paletteBackgroundPixmap in the Property Editor pane and select a graphics file
set whatsThis=filename in the Property Editor pane
Functions that apply to this widget:
pvSetWhatsThis()
pvWhatsThisPrintf()
pvToolTip()
pvSetGeometry()
pvSetMinSize()
pvSetMaxSize()
pvMove();
pvResize();
pvHide();
pvShow();
pvSetStyleSheet()
pvPrintfStyleSheet();
pvSetPaletteBackgroundColor()
pvSetPaletteForegroundColor()
pvSetFontColor()
pvSetFont()
pvSetEnabled()
pvSetFocus()
pvCopyToClipboard()
pvSaveAsBmp()
pvSetImage()
pvSetBufferedJpgImage()
pvPassThroughOneJpegFrame()
pvSendJpegFrame()
 

◆ pvQLabel()

int pvQLabel ( PARAM p,
int  id,
int  parent 
)

◆ pvQLayoutGrid()

int pvQLayoutGrid ( PARAM p,
int  id,
int  parent 
)
Layout Grid

◆ pvQLayoutHbox()

int pvQLayoutHbox ( PARAM p,
int  id,
int  parent 
)
Layout Hbox

◆ pvQLayoutVbox()

int pvQLayoutVbox ( PARAM p,
int  id,
int  parent 
)
Layout Vbox

◆ pvQLCDNumber()

int pvQLCDNumber ( PARAM p,
int  id,
int  parent,
int  numDigits,
int  segmentStyle,
int  mode 
)

◆ pvQLineEdit()

int pvQLineEdit ( PARAM p,
int  id,
int  parent 
)

◆ pvQListBox()

int pvQListBox ( PARAM p,
int  id,
int  parent 
)

◆ pvQListView()

int pvQListView ( PARAM p,
int  id,
int  parent 
)

◆ pvQMultiLineEdit()

int pvQMultiLineEdit ( PARAM p,
int  id,
int  parent,
int  editable,
int  max_lines 
)

◆ pvQProgressBar()

int pvQProgressBar ( PARAM p,
int  id,
int  parent,
int  total_steps,
int  orientation = Horizontal 
)

◆ pvQPushButton()

int pvQPushButton ( PARAM p,
int  id,
int  parent 
)

◆ pvQRadioButton()

int pvQRadioButton ( PARAM p,
int  id,
int  parent 
)

◆ pvQSlider()

int pvQSlider ( PARAM p,
int  id,
int  parent,
int  minValue,
int  maxValue,
int  pageStep,
int  value,
int  orientation 
)

◆ pvQSpinBox()

int pvQSpinBox ( PARAM p,
int  id,
int  parent,
int  min,
int  max,
int  step 
)

◆ pvQTable()

int pvQTable ( PARAM p,
int  id,
int  parent,
int  rows,
int  columns 
)

◆ pvQTabWidget()

int pvQTabWidget ( PARAM p,
int  id,
int  parent 
)

◆ pvQTextBrowser()

int pvQTextBrowser ( PARAM p,
int  id,
int  parent 
)

◆ pvQTimeEdit()

int pvQTimeEdit ( PARAM p,
int  id,
int  parent 
)

◆ pvQToolBox()

int pvQToolBox ( PARAM p,
int  id,
int  parent 
)

◆ pvQVtkTclWidget()

int pvQVtkTclWidget ( PARAM p,
int  id,
int  parent 
)
Creates a new QVtkTclWidget . See also pvQWidget().
You can use this widget to use VTK for 3D Graphics.
Use pvVtkTcl()          to send single Tcl commands.
Use pvVtkTclPrintf()    to send single Tcl commands (use like printf).
Use pvVtkTclScript()    to send Tcl programs.
The constructor also runs the Tcl commands:
package require vtk
package require vtkinteraction
package require vtktesting
vtkRenderer renderer4
vtkRenderer renderer3
vtkRenderer renderer2
vtkRenderer renderer
renderer4 is connected to your widget !!!
renderer3 is connected to your widget !!!
renderer2 is connected to your widget !!!
renderer  is connected to your widget !!!
The destructor also runs the Tcl command:
vtkCommand DeleteAllObjects

◆ pvQWidget()

int pvQWidget ( PARAM p,
int  id,
int  parent 
)
Creates a new QWidget. It's id can be used to identify it. It's parent widget is parent.
You can set one widget on top of another widget if you set parent to the parent widgets id.
When parent == 0 the widget will be set on the background screen (ID_MAIN_WIDGET).
QWidget draws nothing, but it is useful to group objects hierarchically.
Functions that apply to this widget:
pvToolTip()
pvSetGeometry()
pvSetMinSize()
pvSetMaxSize()
pvMove();
pvResize();
pvHide();
pvShow();
pvSetStyleSheet()
pvPrintfStyleSheet();
pvSetPaletteBackgroundColor()
pvSetPaletteForegroundColor()
pvSetFontColor()
pvSetFont()
pvSetEnabled()
pvSetFocus()
pvCopyToClipboard()
pvSaveAsBmp()

◆ pvQwtAnalogClock()

int pvQwtAnalogClock ( PARAM p,
int  id,
int  parent 
)
Call this function to create a QwtAnalogClock.
See Module: QwtAnalog Clock 

◆ pvQwtCompass()

int pvQwtCompass ( PARAM p,
int  id,
int  parent 
)
Call this function to create a QwtCompass.
See Module: QwtCompass 

◆ pvQwtCounter()

int pvQwtCounter ( PARAM p,
int  id,
int  parent 
)
Call this function to create a QwtCounter.
See Module: QwtCounter 

◆ pvQwtDial()

int pvQwtDial ( PARAM p,
int  id,
int  parent 
)
Call this function to create a QwtDial.
See Module: QwtDial 

◆ pvQwtKnob()

int pvQwtKnob ( PARAM p,
int  id,
int  parent 
)
Call this function to create a QwtKnob.
See Module: QwtKnob

◆ pvQwtPlotWidget()

int pvQwtPlotWidget ( PARAM p,
int  id,
int  parent,
int  nCurves,
int  nMarker 
)
Call this function to create a QWT Plot Widget.
nCurves = Max Number of Curves in Plot
nMarker = Max Number of Markers in Plot
See Module: QwtPlotWidget 

◆ pvQwtScale()

int pvQwtScale ( PARAM p,
int  id,
int  parent,
int  pos 
)
Call this function to create a QwtScale.
See Module: QwtScale 

◆ pvQwtSlider()

int pvQwtSlider ( PARAM p,
int  id,
int  parent 
)
Call this function to create a QwtSlider.
See Module: QwtSlider 

◆ pvQwtThermo()

int pvQwtThermo ( PARAM p,
int  id,
int  parent 
)
Call this function to create a QwtThermo.
See Module: QwtThermo 

◆ pvQwtWheel()

int pvQwtWheel ( PARAM p,
int  id,
int  parent 
)
Call this function to create a QwtWheel.
See Module: QwtWheel 

◆ pvStartDefinition()

int pvStartDefinition ( PARAM p,
int  num_objects 
)
Call this function first when you want to define a new mask.
Your enum for the mask should always contain ID_END_OF_WIDGETS as the last element.
Example:
pvStartDefinition(p,ID_END_OF_WIDGETS);
You can allocate space for additional widgets after ID_END_OF_WIDGETS by setting 
p->num_additional_widgets = number;

◆ pvTabOrder()

int pvTabOrder ( PARAM p,
int  id1,
int  id2 
)
set TAB order.