rohd_devtools_widgets library
Classes
- AppBarOverlay
- Wraps a body widget and an appBar widget, where the AppBar auto-hides by sliding up when autoHide is true.
- BitDefineFieldsAction
- User picked "Define Bit Fields..." and entered a non-empty list of named BitFieldDefs.
- BitExpandRangeAction
-
User picked "Expand Bits" and (implicitly or via dialog) chose the bit
range
[bitEnd:bitStart]to expand into single-bit synthesized waveforms. - BitExpansionAction
- Result of a bit-expansion menu interaction after any follow-up dialog has resolved. Returned by resolveBitExpansionMenuValue.
- BitExpansionMenuValues
- Popup-menu values used by the bit-expansion items.
- BitFieldDef
- A named bit-field definition within a bitvector signal.
- BitFieldUtils
- Shared utilities for parsing and formatting bit-field definitions.
- CrossProbeButton
- A toolbar icon button for cross-probing signal selections between viewers.
- CrossProbeService
- Abstract interface for cross-probing signal selections between viewers.
- ExportPngButton
- Small camera-icon button for triggering PNG export.
- LocalCrossProbeChannel
- Shared in-process broadcast channel.
- LocalCrossProbeService
- Per-viewer CrossProbeService backed by a shared LocalCrossProbeChannel.
- MarkdownHelpButton
- A help button that loads its content from a markdown asset file.
- NullCrossProbeService
- A no-op CrossProbeService for standalone or offline contexts where cross-probing between viewers is not available.
- NullExtensionClient
- A no-op RohdExtensionClient used when no extension is reachable.
- RohdExtensionClient
- Abstract client for the ROHD VS Code extension handshake.
- RohdFormatInfo
- Availability status for a single source format.
- RohdModuleInfo
- Information returned by the ROHD extension for a specific module.
- SignalValueFormatPreference
- A format preference for one signal occurrence address.
- SignalValueFormatRegistry
- Shared display-format preferences keyed by occurrence address.
- TypeFieldNode
- A node in the expanded type tree, used for structured display.
Enums
- RohdSourceFormat
- Identifies a source/output format the ROHD extension can navigate to.
- SignalValueFormat
- The available display formats for signal values.
Functions
-
buildBitExpansionMenuItems(
{required int width, double fontSize = 13, double itemHeight = 32, bool includeDivider = false}) → List< PopupMenuEntry< String> > - Build the standard pair of popup-menu items shown when right-clicking a single multi-bit signal:
-
buildGotoSourceMenuItems(
{required List< RohdSourceFormat> formats, int count = 1, double height = 32, TextStyle? textStyle, bool showIcons = true, SourceFormatIconBuilder iconBuilder = sourceFormatMenuIcon}) → List<PopupMenuItem< String> > -
Build
Go to <format> Sourcepopup-menu items forformats. -
buildRohdPopupMenuItem<
T> ({required T value, required Widget icon, required String label, double height = 32, TextStyle? textStyle, bool enabled = true}) → PopupMenuItem< T> - Standard popup-menu item using the same fixed icon gutter as source rows.
-
captureBoundaryToPng(
BuildContext context, {required GlobalKey< State< boundaryKey, String filePrefix = 'export', double pixelRatio = 2.0, Future<StatefulWidget> >String?> saveFn(Uint8List pngBytes, String fileName)?, Future<Uint8List?> encodeFn(RenderRepaintBoundary boundary, double pixelRatio)?}) → Future<bool> -
Capture a RepaintBoundary identified by
boundaryKey, encode to PNG, save/download, and show a toast. -
expandLogicType(
Map< String, dynamic> ? logicType, {String? parentBinaryValue}) → List<TypeFieldNode> -
Expand a
logic_typemetadata map into a tree of TypeFieldNodes. -
formatFieldValue(
String? binaryValue, int width) → String - Format a binary field value for display.
-
formatTypeTooltip(
Map< String, dynamic> ? logicType, {String? parentBinaryValue, String? signalName, int maxDepth = 6}) → String - Build a multi-line indented string showing struct/array fields with values.
-
gotoSourceFormatFromValue(
String? value) → RohdSourceFormat? - Decode a popup-menu value produced by gotoSourceMenuValue.
-
gotoSourceMenuLabel(
RohdSourceFormat format, {int count = 1}) → String -
Menu label for
Go to <format> Source, pluralized withcount. -
gotoSourceMenuValue(
RohdSourceFormat format) → String -
Encode a popup-menu value for navigating to
format. -
gotoSourceShortName(
RohdSourceFormat format) → String -
Short, menu-friendly name for
format(e.g.'ROHD','SV'). -
hexToBinary(
String hexValue, int width) → String? - Convert a hex value string (e.g. "0x1a3f" or "1a3f") to binary (MSB-first).
-
resolveBitExpansionMenuValue(
BuildContext context, {required String? value, required String signalName, required int width}) → Future< BitExpansionAction?> -
Translate a popup-menu
valuereturned byshowMenu<String>into a BitExpansionAction, showing any follow-up dialog as needed. -
Resolve which navigable source formats to display for
info. -
savePngBytes(
Uint8List pngBytes, String fileName) → Future< String?> - Stub — always throws.
-
showBitRangeDialog(
BuildContext context, {required String signalName, required int width}) → Future< (int, int)?> - Show a dialog to select a bit range for a signal.
-
showDefineBitFieldsDialog(
BuildContext context, {required String signalName, required int width, List< BitFieldDef> ? existingDefs}) → Future<List< BitFieldDef> ?> - Show a dialog to define named bit-field slices on a signal.
-
showExportToast(
BuildContext context, String message, {Duration duration = const Duration(seconds: 3)}) → void - Show a brief floating toast at the bottom of the screen.
-
sourceFormatIcon(
RohdSourceFormat format, {double size = 18}) → Widget - Backwards-compatible alias for sourceFormatMenuIcon.
-
sourceFormatIconStrip(
{required Iterable< RohdSourceFormat> formats, SourceFormatIconBuilder iconBuilder = sourceFormatMenuIcon, double size = 16, double gap = 3}) → Widget - Compact strip of source/output format icons for trace-picker menu rows.
-
sourceFormatMenuIcon(
RohdSourceFormat format, {double size = 18}) → Widget -
App-bar-style icon for a source/output
format. -
sourcePopupMenuRow(
{required Widget icon, required String label, TextStyle? textStyle, double iconSlotWidth = 22, double gap = 8}) → Widget - Standard popup-menu row with a fixed-width prefix icon and ellipsized label.
Typedefs
-
AvailableSourceFormats
= List<
RohdSourceFormat> Function() - Returns the source formats currently navigable for the active module.
-
GoToSourceCallback
= void Function(RohdSourceFormat format, List<
String> signalPaths) -
Invoked when the user picks
Go to <format> SourceforsignalPaths. - SourceFormatIconBuilder = Widget Function(RohdSourceFormat format, {double size})
-
Builds an icon for a source/output
format.