UI Utilities

This section describes UI utility classes and functions.

// namespaces

namespace ui.ComboBoxHistory;

// enums

enum ui.NetworkAdapterUsage;
enum ui.WebSocketCloseMode;
enum ui.WebSocketTransmitMode;

// structs

struct ui.HidDeviceEntry;

// classes

class ui.BufferPropertySet;
class ui.ChecksumInfoSet;
class ui.SerialUi;
class ui.SocketPropertySet;
class ui.SshPropertySet;
class ui.SslPropertySet;
class ui.StdEditToolBar;
class ui.StdSessionInfoSet;
class ui.ThroughputInfoSet;
class ui.WebSocketUi;

// global variables

ui.EnumPropertyOption const ui.TransmitModeOptionTable[3] = {  { "Auto",   WebSocketTransmitMode.Auto },  { "Text",   WebSocketTransmitMode.Text },  { "Binary", WebSocketTransmitMode.Binary },  };
string_t const ui.TransmitModeToolTipTable[3] = {  "Transmit as text if the packet is a valid UTF-8; transmit as binary otherwise",  "Transmit as text always",  "Transmit as binary always",  };
ui.EnumPropertyOption ui.CloseModeOptionTable[2] = {  { "Graceful", WebSocketCloseMode.Graceful },  { "Abrupt",   WebSocketCloseMode.Abrupt },  };

// global functions

bool ui.isHidMonDeviceLess(
    io.HidMonDeviceDesc const* device1,
    io.HidMonDeviceDesc const* device2
);

void ui.refreshHidMonDeviceListUi(
    ui.ComboBox* deviceCombo,
    ui.EnumProperty* deviceProp
);

size_t ui.findHidMonDeviceComboIndex(
    ui.ComboBox* deviceCombo,
    uint_t vid,
    uint_t pid,
    uint_t captureDeviceId = -1,
    uint_t address = -1,
    uint_t interfaceId = -1
);

bool ui.isHidDeviceLess(
    ui.HidDeviceEntry const* device1,
    ui.HidDeviceEntry const* device2
);

void ui.refreshHidDeviceListUi(
    ui.ComboBox* deviceCombo,
    ui.EnumProperty* deviceProp
);

size_t ui.findHidDeviceComboIndex(
    ui.ComboBox* deviceCombo,
    uint_t vid,
    uint_t pid,
    string_t path
);

ui.EnumPropertyOption const* ui.createPcapDeviceOptionArray();

ui.EnumProperty* ui.createPcapDeviceProperty(
    ui.PropertyGrid* propertyGrid,
    ui.GroupProperty* group = null,
    ui.Property* beforeProp = null,
    string_t name,
    string_t toolTip
);

ui.ComboBox* ui.createPcapDeviceComboBox(
    ui.ToolBar* toolBar,
    uint_t width = -1
);

bool ui.isSerialPortLess(
    io.SerialPortDesc const* port1,
    io.SerialPortDesc const* port2
);

void ui.enumerateSerialPorts(
    ui.ComboBox* portCombo,
    ui.ComboProperty* portProp
);

ui.EnumPropertyOption const* ui.createNetworkAdapterOptionArray(ui.NetworkAdapterUsage usage);

ui.EnumProperty* ui.createNetworkAdapterProperty(
    ui.PropertyGrid* propertyGrid,
    ui.Property* group = null,
    ui.Property* insertBefore = null,
    ui.NetworkAdapterUsage usage,
    string_t name,
    string_t toolTip
);

ui.EnumProperty* ui.createNetworkAdapterProperty(
    ui.PropertyGrid* propertyGrid,
    ui.NetworkAdapterUsage usage,
    string_t name,
    string_t toolTip
);

ui.ComboBox* ui.createNetworkAdapterComboBox(
    ui.ToolBar* toolBar,
    ui.NetworkAdapterUsage usage,
    uint_t width = -1
);

io.SocketOptions ui.getSocketOptions(
    ui.SocketPropertySet const* socketPropSet,
    ui.BufferPropertySet const* bufferPropSet
);

bool ui.isUsbMonDeviceLess(
    io.UsbMonDeviceDesc const* device1,
    io.UsbMonDeviceDesc const* device2
);

void ui.refreshUsbMonDeviceListUi(
    ui.ComboBox* deviceCombo,
    ui.EnumProperty* deviceProp
);

size_t ui.findUsbMonDeviceComboIndex(
    ui.ComboBox* deviceCombo,
    uint_t vid,
    uint_t pid,
    uint_t captureDeviceId = -1,
    uint_t address = -1
);

bool ui.isUsbDeviceLess(
    io.UsbDeviceEntry const* entry1,
    io.UsbDeviceEntry const* entry2
);

void ui.refreshUsbDeviceListUi(
    ui.ComboBox* deviceCombo,
    ui.EnumProperty* deviceProp
);

size_t ui.findUsbDeviceComboIndex(
    ui.ComboBox* deviceCombo,
    uint_t vid,
    uint_t pid,
    uint_t bus = -1,
    uint_t address = -1
);

size_t ui.findUsbInterfaceComboIndex(
    ui.ComboBox* interfaceCombo,
    uint_t interfaceId,
    uint_t altSettingId = -1
);

size_t ui.findUsbEndpointComboIndex(
    ui.ComboBox* interfaceCombo,
    uint_t endpointId
);