Client API index
This is an index, not a replacement for the learning path: getting started -> Hello -> object model → the focused guides. Every public widget header has an entry below and a corresponding row in coverage. Every installed header appears once in the tables, including headers for testing and implementation support; their descriptions identify the intended entry point.
Application and layout
| Header | Primary types | Start here |
|---|---|---|
include/cvision/ui/application.hpp | Application | Getting started |
include/cvision/ui/view.hpp | View | Object model |
include/cvision/ui/animation.hpp | Animation | Widget gallery |
include/cvision/ui/layout.hpp | Row, Column, layout specifications | Layout guide |
include/cvision/ui/grid.hpp | Grid | Layout guide |
include/cvision/ui/dock.hpp | Dock | Layout guide |
include/cvision/ui/anchor_pane.hpp | AnchorPane | Layout guide |
include/cvision/ui/overlay.hpp | Overlay | Layout guide |
include/cvision/ui/command.hpp | command registry and ids | Dialogs and commands |
include/cvision/ui/theme.hpp | Theme | Themes and rendering |
include/cvision/core/shadow_style.hpp | ShadowStyle: how a theme's shadow darkens cells and pictures | Themes and rendering |
include/cvision/ui/theme_format.hpp | serialize_theme, parse_theme: the saved text of a theme | Themes and rendering |
Embedded terminal
| Header | Primary types | Start here |
|---|---|---|
include/cvision/core/terminal_subsession.hpp | deterministic child-session snapshot contract, capability profile and policies | Embedded terminal |
include/cvision/core/process_launch.hpp | shared ProcessLaunchSpec, explicit command forms and environment policy | Captured process helpers |
include/cvision/core/process_runner.hpp | injected ProcessRunner, binary request, typed root/capture/error results | Captured process helpers |
include/cvision/core/detached_process.hpp | injected independent-process launch and separate typed cleanup outcomes | Captured process helpers |
include/cvision/term/windows_detached_process.hpp | Windows suspended launch with verified absence from every ancestor job | Captured process helpers |
include/cvision/term/process_runner.hpp | NativeProcessRunner: private POSIX/Windows helper pipes and owned group/job | Captured process helpers |
include/cvision/term/process_launch_internal.hpp | implementation-only native invocation buffers and preparation; not an application API | Captured process helpers |
include/cvision/term/terminal_subsession.hpp | launch specification and platform adapter seam | Embedded terminal |
include/cvision/core/palette.hpp | what a palette index names, and colour resolution | Themes and rendering |
include/cvision/core/base64.hpp | the encoding OSC 52 carries clipboard text in | Embedded terminal |
Chrome and interaction
| Header | Primary types | Guide/example |
|---|---|---|
include/cvision/widgets/application_shell.hpp | ApplicationShell, ApplicationShellOptions | Hello |
include/cvision/widgets/desktop.hpp | Desktop, DockEdge | Object model |
include/cvision/widgets/window.hpp | Window, FrameSlot, FrameLines, WindowHandle | Object model |
include/cvision/widgets/menu.hpp | MenuBar, DropdownMenu, menu items | Hello |
include/cvision/widgets/status_line.hpp | StatusLine, StatusLineItem | Hello |
include/cvision/widgets/command_presentation.hpp | CommandPresentation | Dialogs and commands |
include/cvision/widgets/mnemonic.hpp | MnemonicText | Widget gallery |
include/cvision/widgets/mnemonic_internal.hpp | shared mnemonic drawing helpers (internal) | mnemonic.hpp is the client entry point |
include/cvision/widgets/orientation.hpp | Orientation | Widget gallery |
Controls and data views
| Header | Primary types | Guide/example |
|---|---|---|
include/cvision/widgets/frame_text.hpp | FrameText | Widget gallery |
include/cvision/widgets/label.hpp | Label | Widget gallery |
include/cvision/widgets/static_text.hpp | StaticText | Widget gallery |
include/cvision/widgets/button.hpp | Button | Widget gallery |
include/cvision/widgets/input_presentation.hpp | InputPresentation, field geometry | Widget gallery |
include/cvision/widgets/input_presentation_internal.hpp | shared field surface drawing (internal) | input_presentation.hpp is the client entry point |
include/cvision/widgets/input_line.hpp | InputLine | Widget gallery |
include/cvision/widgets/key_chord_capture.hpp | KeyChordCapture | Widget gallery |
include/cvision/widgets/memo.hpp | Memo, MemoPosition | Widget gallery |
include/cvision/widgets/editor_document.hpp | EditorDocument, positions, ranges, transactions | Editor |
include/cvision/widgets/text_editor.hpp | TextEditor, EditorStatus, EditorStatusModel | Editor |
include/cvision/widgets/syntax_profile.hpp | profile registry and syntax spans | Editor |
include/cvision/widgets/syntax_cache.hpp | incremental lexical-state cache | Editor |
include/cvision/widgets/editor_search.hpp | literal search and atomic replace-all | Editor |
include/cvision/widgets/editor_window.hpp | optional editor/controller/window composition | Editor |
include/cvision/widgets/terminal_report_dialog.hpp | the terminal capability report | Widget gallery |
include/cvision/widgets/terminal_scrollbar.hpp | the frame-mounted scrollbar bound to a terminal's scrollback | Embedded terminal |
include/cvision/widgets/terminal_view.hpp | TerminalView | Embedded terminal |
include/cvision/widgets/popup_list.hpp | the floating list a control drops when its choices are data | Widget gallery |
include/cvision/widgets/text_layout.hpp | WrapMode, WrapOptions, WrapSegment, ScrollGeometry | Widget gallery |
include/cvision/widgets/text_view.hpp | TextView, TextSpan | Widget gallery |
include/cvision/widgets/flow_view.hpp | FlowView, FlowDocument | Flow content |
include/cvision/widgets/option_group.hpp | CheckGroup, RadioGroup | Widget gallery |
include/cvision/widgets/combo_box.hpp | ComboBox | Widget gallery |
include/cvision/widgets/list_view.hpp | ListView, ListModel, ListItem | Data views |
include/cvision/widgets/tree_view.hpp | TreeView, TreeNode, TreeModel, TreeItem | Data views |
include/cvision/widgets/table.hpp | Table, TableModel, TableCell | Data views |
include/cvision/widgets/cell_grid.hpp | CellGrid, CellGridModel, GridCell, GridFrame, MaterializedCellGridModel | Data views |
include/cvision/widgets/tab_control.hpp | TabControl | Widget gallery |
include/cvision/widgets/big_clock.hpp | BigClockView, BigClockContent | Widget gallery |
include/cvision/widgets/progress_paint_internal.hpp | shared meter painting (internal) | progress.hpp is the client entry point |
include/cvision/widgets/progress_tasks.hpp | ProgressModel, ProgressView, ActivityIndicator, ProgressController, ProgressMailbox | Advanced progress |
include/cvision/widgets/progress.hpp | Progress | Widget gallery |
include/cvision/widgets/scrollbar.hpp | Scrollbar | Widget gallery |
include/cvision/widgets/scroll_viewport.hpp | ScrollViewport | Widget gallery |
include/cvision/widgets/splitter.hpp | Splitter | Layout guide |
Dialogs and client services
| Header | Primary types | Guide/example |
|---|---|---|
include/cvision/widgets/dialog.hpp | descriptor dialogs and results | Dialogs and commands |
include/cvision/widgets/dialog_presentation.hpp | typed dialog presentation | Dialogs and commands |
include/cvision/widgets/message_box.hpp | message boxes | Hello |
include/cvision/widgets/file_dialog.hpp | open/save dialog | Platform services |
include/cvision/widgets/directory_picker.hpp | directory picker | Platform services |
include/cvision/widgets/file_editor_controller.hpp | injected editor file lifecycle | Editor |
include/cvision/widgets/help_viewer.hpp | help viewer/provider | Dialogs and commands |
include/cvision/widgets/date_time_dialog.hpp | date and time dialogs | Dialogs and commands |
include/cvision/widgets/window_list_dialog.hpp | window chooser: filter, switch to, close | Widget gallery |
include/cvision/widgets/theme_editor.hpp | theme editor | Themes and rendering |
include/cvision/widgets/paged_strip.hpp | PagedStrip | Widget gallery |
include/cvision/widgets/minimized_window_stub.hpp | MinimizedWindowStub | Widget gallery |
include/cvision/widgets/window_switcher_bar.hpp | WindowSwitcherBar, WindowSwitcherTarget | Widget gallery |
include/cvision/widgets/standard_strings.hpp | StandardStrings | Dialogs and commands |
Graphics and common components
| Header | Primary types | Guide/example |
|---|---|---|
include/cvision/widgets/image_view.hpp | ImageView | Graphics |
include/cvision/widgets/canvas.hpp | Canvas, fit_image_cells, kAssumedCellPixels | Graphics |
include/cvision/widgets/common_components.hpp | calendar/date/time/spin/slider/search/toolbar/palette/breadcrumb/property/wizard/notification/tooltip | Widget gallery |
The public terminal hosts live under include/cvision/term/; use
headless_terminal.hpp in tests and the platform backend header appropriate to
your host. Platform services covers the boundary.
Core values, text, and services
| Header | Primary contract | Start here |
|---|---|---|
include/cvision/core/ascii.hpp | locale-free ASCII classification and case folding | Text width |
include/cvision/core/assert.hpp | always-on CKV_ASSERT contract checks | Host diagnostics |
include/cvision/core/cell.hpp | Cell and grapheme/style/link storage | Themes and rendering |
include/cvision/core/clipboard.hpp | ClipboardWriter, MemoryClipboardWriter | Platform services |
include/cvision/core/clock.hpp | Clock, ManualClock | Platform services |
include/cvision/core/color.hpp | Color and colour kinds | Themes and rendering |
include/cvision/core/cursor.hpp | CursorState, CursorShape | Themes and rendering |
include/cvision/core/diagnostics.hpp | DiagnosticsSink, BufferedDiagnostics | Host diagnostics |
include/cvision/core/event.hpp | key, text, mouse, resize, focus, and paste events | Input decoder |
include/cvision/core/filesystem.hpp | injected FileSystem and file result contracts | Platform services |
include/cvision/core/frame_view.hpp | FrameView, RasterSlice | Graphics |
include/cvision/core/generated_unicode_15_1.hpp | generated Unicode tables; implementation support, not the client text entry point | Text width |
include/cvision/core/geometry.hpp | Point, Size, Rect, PixelPoint, PixelSize | Object model |
include/cvision/core/golden.hpp | symbolic scene golden::Document and records | Golden format |
include/cvision/core/hyperlink.hpp | LinkTable, LinkId, is_valid_hyperlink_target — hyperlink targets carried by cells | Terminal host integration |
include/cvision/core/image.hpp | Image, Rgba | Graphics |
include/cvision/core/key.hpp | Key, Modifier, KeyChord | Input decoder |
include/cvision/core/pointer_shape.hpp | PointerShape vocabulary | Terminal capability profiles |
include/cvision/core/process_resources.hpp | full-width ProcessId, typed clock-free ProcessResources observations | Platform services |
include/cvision/core/style.hpp | Style, attributes, underline shape | Themes and rendering |
include/cvision/core/text.hpp | deterministic text and grapheme helpers | Text width |
include/cvision/core/utf8.hpp | UTF-8 validation and conversion helpers | Text width |
include/cvision/core/version.hpp | Version and library version | Getting started |
Scene composition and capture
| Header | Primary contract | Start here |
|---|---|---|
include/cvision/scene/box_drawing.hpp | box junction and line-style resolution | Themes and rendering |
include/cvision/scene/compositor.hpp | Compositor, layers, shadows, raster visibility | Themes and rendering |
include/cvision/scene/cursor.hpp | scene cursor placement helpers | Themes and rendering |
include/cvision/scene/golden_capture.hpp | scene and frame capture into golden documents | Golden format |
include/cvision/scene/painter.hpp | Painter drawing API | Themes and rendering |
include/cvision/scene/rect_ops.hpp | rectangle set operations for damage and clipping | Themes and rendering |
include/cvision/scene/surface.hpp | Surface, damage spans, raster regions | Themes and rendering |
Terminal hosts, protocols, and diagnostics
| Header | Primary contract | Start here |
|---|---|---|
include/cvision/term/capabilities.hpp | Capabilities, terminal profiles, colour and input protocol enums, the cell/pixel conversions cells_to_pixels and cell_pixels_from_area | Terminal capability profiles |
include/cvision/term/capability_report.hpp | structured capability report entries | Terminal host integration |
include/cvision/term/file_trace_sink.hpp | FileTraceSink, the live file or stderr sink for a graphics trace | Graphics |
include/cvision/term/headless_terminal.hpp | deterministic HeadlessTerminal test host | Terminal host integration |
include/cvision/term/input_decoder.hpp | InputDecoder and capability-update policy | Input decoder |
include/cvision/term/osc_sequences.hpp | the window-title (OSC 0) and clipboard-export (OSC 52) sequences every VT backend sends | Terminal host integration |
include/cvision/term/pointer_shape_names.hpp | pointer-shape protocol names and support map | Terminal capability profiles |
include/cvision/term/posix_clock.hpp | PosixClock | Platform services |
include/cvision/term/posix_filesystem.hpp | PosixFileSystem | Platform services |
include/cvision/term/posix_terminal.hpp | POSIX PosixTerminal session backend | Terminal host integration |
include/cvision/term/posix_terminal_subsession.hpp | private POSIX child PTY adapter | Embedded terminal |
include/cvision/term/presenter.hpp | Presenter cell and raster VT encoder | Themes and rendering |
include/cvision/term/record_replay_terminal.hpp | deterministic terminal I/O recording and replay | Terminal host integration |
include/cvision/term/sixel_decoder.hpp | bounded Sixel image decoder | Graphics |
include/cvision/term/sixel_encoder.hpp | Sixel image encoder | Graphics |
include/cvision/term/terminal.hpp | Terminal, capability events, and wait handles | Terminal host integration |
include/cvision/term/terminal_clipboard.hpp | TerminalClipboardWriter | Platform services |
include/cvision/term/windows_clipboard.hpp | WindowsClipboardWriter: instance-owned native Unicode export | Platform services |
include/cvision/term/windows_filesystem.hpp | WindowsFileSystem: native Unicode file service and conditional atomic saves | Platform services |
include/cvision/term/terminal_emulator.hpp | TerminalEmulator for contained child output | Embedded terminal |
include/cvision/term/terminal_host_summary_internal.hpp | shared native capability-trace formatter (internal implementation support) | Host diagnostics |
include/cvision/term/virtual_display.hpp | VirtualDisplay for deterministic VT presentation | Graphics |
include/cvision/term/windows_clock.hpp | WindowsClock | Platform services |
include/cvision/term/windows_argv.hpp | pure CRT argument and CreateProcessW command-line encoding, distinct from shell command text | Terminal host integration |
include/cvision/term/windows_text.hpp | strict UTF-8/native UTF-16 composition, independent of the ANSI code page | Terminal host integration |
include/cvision/term/windows_process_image.hpp | read-only native executable-header and host-architecture inspection | Process helpers |
include/cvision/term/windows_process_resources.hpp | explicit native process and owned-job resource samplers | Platform services |
include/cvision/term/windows_terminal.hpp | Windows WindowsTerminal session backend | Terminal host integration |
include/cvision/term/windows_wait_set.hpp | WindowsWaitSet: scalable instance-owned native readiness | Terminal host integration |
include/cvision/term/windows_terminal_subsession.hpp | private Windows ConPTY child adapter | Embedded terminal |
UI support and testing
| Header | Primary contract | Start here |
|---|---|---|
include/cvision/ui/context.hpp | Context for application-owned services | Object model |
include/cvision/ui/history.hpp | HistoryRegistry for scoped interaction history | Object model |
include/cvision/ui/layout_metrics.hpp | layout measurement helpers | Layout guide |
include/cvision/ui/standard_roles.hpp | StandardRoles for theme role lookup | Themes and rendering |
include/cvision/testing/cktest.hpp | repository test harness; testing support, not an application dependency | Contributing |