Widgets

Table of contents

• CSS Widget
• caQtDM Widget
• Output-Independent Widgets
  • Arc
  • ByteMonitor
  • ChoiceButton
  • Ellipse
  • Form
  • Image
  • LED
  • Menu
  • MessageButton
  • Polygon
  • Polyline
  • Rectangle
  • RelatedDisplay
  • Scale
  • ShellCommand
  • Slider
  • Text
  • TextEntry
  • TextMonitor

CSS Widget

The list of recognized CSS Widgets is as follows: “ActionButton”, “Array”, “BooleanButton”, “CheckBox”, “ComboBox”, “DataBrowser”, “EmbeddedDisplay”, “FileSelector”, “LEDMultiState”, “Label”, “Meter”, “NavigationTabs”, “Picture”, “ProgressBar”, “RadioButton”, “ScaledSlider”, “Scrollbar”, “SlideButton”, “Spinner”, “StripChart”, “Symbol”, “Table”, “Tabs”, “Tank”, “TextSymbol”, “TextUpdate”, “Thermometer”, “ThreeDViewer”, “WebBrowser”, and “XYPlot”.

Attributes are set using the name of the function used by phoebusgen. For example, a label’s Auto Size field in CSS-Phoebus would be set with the auto_size attribute in Gestalt.

• Special Attributes

• Example

- !Label
    geometry: 5x0 x 120x20
    
    text: "Label {N}"
    transparent: false
    background: *header_blue
    foreground: Attention
    font: -Liberation Sans - bold - 12

caQtDM Widget

The list of recognized caQtDM Widgets is as follows: “caLabel”, “caLineEdit”, “caTextEntry”, “caMenu”, “caRelatedDisplay”, “caNumeric”, “caApplyNumeric”, “caSlider”, “caChoice”, “caTextEntry”, “caMessageButton”, “caToggleButton”, “caSpinbox”, “caByteController”, “caLabelVertical”, “caGraphics”, “caPolyLine”, “caImage”, “caInclude”, “caDoubleTabWidget”, “caClock”, “caLed”, “caLinearGauge”, “caMeter”, “caCircularGauge”, “caMultiLineString”, “caThermo”, “caCartesianPlot”, “caStripPlot”, “caByte”, “caTable”, “caWaveTable”, “caBitnames”, “caCamera”, “caCalc”, “caWaterfallPlot”, “caScan2D”, “caLineDraw”, “caShellCommand”, “caScriptButton”, “caMimeDisplay”.

Attributes are set with the same names used for the widget’s Qt properties.

• Special Attributes

caQtDM widgets don’t have any special attributes.

• Example

- !caMessageButton
    background: *edit_blue
    colorMode: caMessageButton::Static
    
    geometry: 126x140 x 24x24
    pressMessage: "1"
    channel: "$(P)$(M{N}).TWF"
    label: ">"

Output-Independent Widgets

Arc

A basic rectangle shape that can either be filled or an outline

Angles are defined in relation to the positive x axis. With 0 degrees following that axis, and angles proceeding in the counter-clockwise direction.

• Special Attributes

• Example

SimpleBox: !Arc
    geometry: 100x100
    border-width: 5
    
    start-angle: 45
    span: 180

ByteMonitor

A widget displaying the individual bits of a pv value

• Special Attributes

• Example

StatusBits: !ByteMonitor
    geometry: 165x12
    
    pv: "$(P)m1.MSTA"
    bits: 15

ChoiceButton

A widget representing a set of buttons that gets its options from an enumerable pv

• Special Attributes

• Example

OnOff: !ChoiceButton
    geometry: 215x20
    
    pv: "$(P)userCalcEnable.VAL"
    foreground: *black
    background: *edit_blue

Ellipse

A basic ellipse shape that can either be filled or an outline

• Special Attributes

• Example

SimpleBox: !Ellipse
    geometry: 100x100
    border-width: 5

Form

A special widget used to set values for the top-level window.

• Special Attributes

• Example

Form: !Form
    background: $123456
    margins: 5x5x5x5

Image

A widget that displays a given image file

• Special Attributes

• Example

ComplicatedStructure: !Image
    file: "/path/to/image/Beamline.png"

LED

A widget that changes color based upon the value of a given pv. Has one of three states, true, false, or undefined based upon a match with values given by the widget.

• Special Attributes

• Example

OnOff_Readback: !LED
    pv: "$(P)userCalcEnable.VAL"
    
    geometry: 24x24
    square: true

Menu

A widget representing a menu that gets its options from an enumerable pv

• Special Attributes

• Example

- !Menu
    foreground: *black
    background: *edit_blue
    geometry: 355x0 x 80x20
    pv: $(P){Instance}:EnableCallbacks

MessageButton

A widget representing a button that writes a value to a pv when pressed

• Special Attributes

• Example

- !MessageButton
    foreground: *black
    background: *edit_blue

    text: "Write Value"
    
    geometry: 10x200 x 100x20
    
    pv: "xxx:yyy:zzz"
    value: 1

Polygon

A closed shape consisting of a set of points that can either be filled or an outline

• Special Attributes

• Example

SimpleBox: !Polygon
    geometry: 100x100
    border-width: 5
    
    points: [ 10x10, 90x10, 90x90, 10x90 ]

Polyline

A set of contiguous line segments

• Special Attributes

• Example

Star: !PolyLine
    geometry: 40x40
    points: [ 20x0, 0x40, 40x10, 0x10, 40x40, 20x0 ]

Rectangle

A basic rectangle shape that can either be filled or an outline

• Special Attributes

• Example

SimpleBox: !Rectangle
    geometry: 100x100
    border-width: 5

RelatedDisplay

A widget representing a menu of other UI screens that can be opened by a user.

These other screens are detailed by the attribute links which is a list of dictionaries. Within each dictionary, the following values can be defined:

• label - The display name for the screen to open
• file - The filepath for the screen to open
• macros - Any macros to pass the screen when opening
• replace - Optional, Whether to replace the parent screen when opening, False by default

• Special Attributes

• Example

- !RelatedDisplay
    foreground: *black
    background: *edit_blue

    text: "Open xxx"
    
    geometry: 10x200 x 100x20

    links:
        - { label: "File 1", file: "xxx.ui", macros: "P=1,R=A" }

Scale

A widget representing a bar filling up based on a pv’s value versus its limits

• Special Attributes

• Example

- !Scale
    geometry: 0x0 x 50x200
    foreground: *burlywood
    pv: "xxx:yyy:zzz"

ShellCommand

A button that will trigger the running of a selected shell command

These shell commands are detailed by the attribute commands which is a list of dictionaries. Within each dictionary, the following values can be defined:

• label - The display name for the command to run
• command - The command and all arguments that will be executed

• Special Attributes

• Example

ExampleCommand: !ShellCommand
    geometry: 10x10 x 80x20
    
    text: "Say"
    
    commands: 
        - { label: "Hello",   command: "echo 'Hello'"  }
        - { label: "Goodbye", command: "echo 'Goodbye'"}

Slider

A widget that uses a slider to control output to a pv

• Special Attributes

• Example

- !Slider
    geometry: 140x0 x 120x20
    pv: "$(P)Ao10"

Text

A widget representing a basic text label.

• Special Attributes

• Example

- !Text
    geometry: 5x0 x 120x20
    
    text: "Label Text"
    font: -Liberation Sans - bold - 12
    
    alignment:
        horizontal: Center
        vertical: Center

TextEntry

A widget representing a text entry field.

• Special Attributes

• Example

- !TextEntry
    geometry: 5x0 x 120x20
    
    pv: "$(P)$(R)Description"
    
    alignment: BottomLeft

TextMonitor

A widget representing a text display field

• Special Attributes

• Example

- !TextMonitor
    geometry: 5x0 x 120x20
    
    pv: "$(P)$(R)Description_RBV"
    
    alignment: CenterRight