YOUSEFUL / DELPHI
Component reference
Every Atlas class, with its unit, members, and examples. Registered components appear on the Delphi tool palette; support types are the records, enumerations and base classes you use with them.
214 entries
No matching components. Try another word or clear the search.
Atlas VCL
Data models, grids, trees, editors, charts, scheduling and application layout for Windows. Tutorial · Sample projects
| Component | Unit | Kind | Summary |
|---|---|---|---|
TAtlasActionTile | Atlas.Layout | Visual control | A coloured, clickable tile that shows and executes an action; Enter and Space activate it. |
TAtlasChart | Atlas.Charts | Visual control | Line, bar and pie chart control with chart-owned series, gaps for missing points and offscreen rendering. |
TAtlasCommandBar | Atlas.Layout | Visual control | Tabbed command bar that groups action-bound buttons under tab and group captions. |
TAtlasDiagram | Atlas.Diagram | Visual control | Interactive view of a TAtlasGraph: select, drag, connect, rename, add and delete nodes. |
TAtlasGantt | Atlas.Gantt | Visual control | Grid-based Gantt chart over a TAtlasTaskPlan: one row per task with caption, predecessor IDs, a timeline bar and a progress fill. |
TAtlasGauge | Atlas.Gauges | Visual control | Horizontal bar gauge with a caption, a clamped value and warning and critical colour thresholds. |
TAtlasGraph | Atlas.Graph | Non-visual component | Non-visual model of captioned nodes and directed edges with stable IDs, hierarchy layout, cycle detection and transactional JSON. |
TAtlasGrid | Atlas.Grid | Visual control | A grid that shows a TAtlasTable, sorts by header click and edits cells in place with validation. |
TAtlasInspector | Atlas.Inspector | Visual control | A property grid that lists the published properties of an object and edits them with type and range checks. |
TAtlasMap | Atlas.Map | Visual control | Offline Web Mercator map control for your own markers and paths, with pan, anchored zoom and marker hit testing. |
TAtlasNavigation | Atlas.Layout | Visual control | List box whose items are actions: selecting an item executes its action. |
TAtlasPdfDocument | Atlas.Pdf | Non-visual component | Loads a local PDF file through the Windows PDF engine and renders pages to PNG images at a chosen width. |
TAtlasPdfViewer | Atlas.Pdf | Visual control | Panel with a toolbar, status text and a scrollable page image that shows a PDF file through TAtlasPdfDocument, with page navigation and zoom. |
TAtlasPivot | Atlas.Pivot | Non-visual component | Summarizes a TAtlasTable by two dimensions into a new table with row, column and grand totals. |
TAtlasPrintDocument | Atlas.Printing | Non-visual component | Paginates the current view of a TAtlasTable into fixed-size pages for preview, custom drawing or the Windows printer. |
TAtlasRichEdit | Atlas.RichEdit | Visual control | A Windows RichEdit control with one-call selection formatting, find and replace, RTF bytes and redo. |
TAtlasSchedule | Atlas.Schedule | Non-visual component | In-memory appointment model with stable IDs, per-resource conflict checking, interval queries, change notification and transactional JSON. |
TAtlasScheduler | Atlas.Scheduler | Visual control | Day or week view over a TAtlasSchedule with hour rows, side-by-side lanes for overlapping appointments, selection, keyboard movement and host edit events. |
TAtlasSheetGrid | Atlas.SheetGrid | Visual control | A string grid that shows a TAtlasWorkbook: calculated values in the cells, the raw formula in the editor. |
TAtlasSpellChecker | Atlas.Spell | Non-visual component | Checks text against a word list you supply and suggests corrections ranked by edit distance. |
TAtlasTable | Atlas.Data | Non-visual component | An in-memory table with a fixed, typed schema, a sorted and filtered view, change notifications and CSV import and export. |
TAtlasTaskPlan | Atlas.Gantt | Non-visual component | Task model with intervals, progress, acyclic finish-to-start dependencies, staged automatic scheduling and transactional JSON. |
TAtlasThemer | Atlas.Themes | Non-visual component | Applies one of eleven built-in colour palettes to a control and every control inside it, and saves the choice by name. |
TAtlasTileBoard | Atlas.Layout | Visual control | Flow panel that lays out action tiles left to right and wraps them. |
TAtlasTree | Atlas.Tree | Visual control | A tree view with lazy child loading, safe node moves, caption search, sorting and JSON persistence. |
TAtlasValueEdit | Atlas.Editors | Visual control | A TEdit that validates its text against a TAtlasColumnKind and normalizes it when focus leaves. |
TAtlasWizard | Atlas.Wizard | Visual control | Page-by-page wizard with Back, Next/Finish and Cancel buttons, a validation veto and finish, cancel and page-change events. |
TAtlasWorkbook | Atlas.Spreadsheet | Non-visual component | A sparse one-sheet model of text, numbers and formulas with five functions, cell formats and JSON persistence. |
TAtlasWorkspace | Atlas.Layout | Visual control | Panel of named, resizable edge and client panes that move between edges, float in tool windows and save their layout as JSON. |
EAtlasChartError support type | Atlas.Charts | Class | Raised when a chart rejects a coordinate, a second pie series, a negative pie value or an unrenderable range. |
EAtlasDataError support type | Atlas.Data | Class | The exception raised for invalid table data, schema changes, CSV text, pivot input and value edits. |
EAtlasFormulaError support type | Atlas.Spreadsheet | Class | The exception raised by TAtlasWorkbook for formula errors, bad addresses and invalid JSON; Code holds the error code. |
EAtlasGraphError support type | Atlas.Graph | Class | Raised by TAtlasGraph for unknown nodes or edges, invalid bounds, self or duplicate edges, cycles and rejected JSON. |
EAtlasLayoutError support type | Atlas.Layout | Class | Raised by the workspace, command bar, tile board and navigation for invalid panes, layouts, bounds or missing actions. |
EAtlasPdfError support type | Atlas.Pdf | Class | Exception raised by TAtlasPdfDocument and TAtlasPdfViewer for Atlas VCL's own checks: missing file, wrong thread, page or zoom out of range, invalid render size, timeout. |
EAtlasPrintError support type | Atlas.Printing | Class | Exception raised by TAtlasPrintDocument for a missing table, an invalid page geometry or a page index out of range. |
EAtlasPropertyError support type | Atlas.Inspector | Class | The exception raised by TAtlasInspector.SetProperty for values it cannot assign. |
EAtlasScheduleError support type | Atlas.Schedule | Class | Exception raised by TAtlasSchedule and TAtlasScheduler for invalid intervals, unknown IDs, resource conflicts, rejected imports and invalid view settings. |
EAtlasTreeError support type | Atlas.Tree | Class | The exception raised by TAtlasTree for foreign nodes, cyclic moves and invalid JSON. |
TAtlasAggregate support type | Atlas.Pivot | Enumeration | The aggregate TAtlasPivot.Summarize computes: count, sum, minimum, maximum or average. |
TAtlasAppointment support type | Atlas.Schedule | Record | One appointment of a TAtlasSchedule: ID, caption, resource, half-open interval and colour. |
TAtlasAppointmentEvent support type | Atlas.Scheduler | Type | Method type of the TAtlasScheduler OnSelect and OnEdit events: the sender and an appointment ID. |
TAtlasAppointmentRect support type | Atlas.Scheduler | Record | An appointment ID with the rectangle it occupies in the last rendered scheduler view. |
TAtlasCellFormat support type | Atlas.Spreadsheet | Record | How a TAtlasWorkbook cell displays its number and how TAtlasSheetGrid paints it. |
TAtlasChartKind support type | Atlas.Charts | Enumeration | The chart type of a TAtlasChart: line, bar or pie. |
TAtlasChartPoint support type | Atlas.Charts | Record | A chart point as stored by a series: coordinates, a missing flag and an optional caption. |
TAtlasChartSeries support type | Atlas.Charts | Class | One named, coloured list of points in a TAtlasChart, created by AddSeries. |
TAtlasColumn support type | Atlas.Data | Record | The definition of one TAtlasTable column: name, kind, editability and preferred width. |
TAtlasColumnKind support type | Atlas.Data | Enumeration | The four value kinds of a TAtlasTable column: text, number, boolean and date. |
TAtlasGeoPoint support type | Atlas.Map | Record | A latitude and longitude in degrees, as used by TAtlasMap. |
TAtlasGraphEdge support type | Atlas.Graph | Record | A directed graph edge: source and target node IDs. |
TAtlasGraphNode support type | Atlas.Graph | Record | A graph node as returned by TAtlasGraph: ID, caption and rectangle. |
TAtlasLoadChildrenEvent support type | Atlas.Tree | Type | The type of TAtlasTree.OnLoadChildren: procedure(Sender: TObject; Node: TTreeNode) of object. |
TAtlasNumberFormat support type | Atlas.Spreadsheet | Enumeration | The four number formats of a workbook cell: general, fixed, percent and currency. |
TAtlasPageValidationEvent support type | Atlas.Wizard | Type | Event type of TAtlasWizard.OnValidate: a page is about to be left through Next. |
TAtlasPdfRect support type | Atlas.Pdf | Record | Source rectangle type of the Windows PDF render options binding; not used by the public rendering API. |
TAtlasPdfSize support type | Atlas.Pdf | Record | Width and height of a PDF page as reported by the Windows PDF engine (device-independent pixels at 96 dpi). |
TAtlasRow support type | Atlas.Data | Type | One row of string values, TArray<string>, as returned by AtlasParseCSV. |
TAtlasSpellingIssue support type | Atlas.Spell | Record | One unknown word found by TAtlasSpellChecker.Check: the word, its one-based start and its length. |
TAtlasTask support type | Atlas.Gantt | Record | One task of a TAtlasTaskPlan: ID, caption, half-open interval and progress percentage. |
TAtlasTheme support type | Atlas.Themes | Record | A named palette of surface, alternate, primary and text colours, returned by AtlasTheme. |
Atlas Analytics
Report definitions and linked dashboards over Atlas VCL data. Tutorial · Sample projects
| Component | Unit | Kind | Summary |
|---|---|---|---|
TAtlasDashboard | Atlas.Dashboard | Visual control | A scroll box of KPI, chart and grid cards that all show one filtered snapshot of a TAtlasTable and refresh together. |
TAtlasReportDefinition | Atlas.Reports | Non-visual component | A serializable report definition: a detail projection or a grouped summary over a TAtlasTable, run into a table, an HTML page or a print document. |
EAtlasAnalyticsError support type | Atlas.Analytics | Class | Raised for invalid queries, report definitions and dashboard widgets. |
TAtlasAnalytics support type | Atlas.Analytics | Class | Static query functions over a TAtlasTable: select and filter, group and aggregate, and export the dataset JSON. |
TAtlasDashboardWidget support type | Atlas.Dashboard | Class | One card of a TAtlasDashboard: its definition and the table it currently shows. |
TAtlasFilter support type | Atlas.Analytics | Record | One filter condition: field, operator and value as text. |
TAtlasFilterOperator support type | Atlas.Analytics | Enumeration | The comparison of a TAtlasFilter: equal, not equal, contains and the four ordered comparisons. |
TAtlasMeasure support type | Atlas.Analytics | Record | One aggregate column: the field to read, the result caption and the kind of calculation. |
TAtlasMeasureKind support type | Atlas.Analytics | Enumeration | How a measure is calculated: count, sum, minimum, maximum or average. |
TAtlasWidgetDefinition support type | Atlas.Dashboard | Record | What a dashboard widget shows: kind, title, measured field, measure and chart dimension. |
TAtlasWidgetKind support type | Atlas.Dashboard | Enumeration | The three dashboard widget kinds: KPI card, bar chart and grid. |
Atlas UI
Kanban boards, an Object Pascal syntax editor and verified update staging. Tutorial · Sample projects
| Component | Unit | Kind | Summary |
|---|---|---|---|
TAtlasKanban | Atlas.Kanban | Visual control | Custom-drawn Kanban board that shows a TAtlasKanbanModel as columns of cards, with selection, mouse and keyboard moves and wheel scrolling. |
TAtlasKanbanModel | Atlas.Kanban | Non-visual component | Non-visual Kanban data model: ordered columns with optional work-in-progress limits, cards with stable ids, vetoable moves and a validated JSON format. |
TAtlasSyntaxMemo | Atlas.Syntax | Visual control | Rich Edit control that colours Object Pascal source as you type and keeps its own text-only undo and redo history. |
TAtlasWebUpdater | Atlas.Updater | Non-visual component | Non-visual component that reads a JSON update manifest over HTTPS, compares version numbers, and downloads, verifies and stages the update file without running it. |
EAtlasKanban support type | Atlas.Kanban | Class | Raised by the Kanban model and board for invalid ids, full columns, bad positions, unsupported JSON and changes during BeforeMove. |
EAtlasUpdate support type | Atlas.Updater | Class | Raised by TAtlasWebUpdater for refused manifests, URLs, versions and limits, HTTP errors, and downloads that fail verification. |
TAtlasBeforeCardMove support type | Atlas.Kanban | Type | The type of TAtlasKanbanModel.BeforeMove: a method that may veto a card move. |
TAtlasKanbanCard support type | Atlas.Kanban | Record | One card of a Kanban board: its id, title and detail text. |
TAtlasKanbanColumn support type | Atlas.Kanban | Class | Internal storage of one Kanban column; read columns through TAtlasKanbanModel instead. |
TAtlasToken support type | Atlas.Syntax | Record | One token found by the Object Pascal lexer: where it starts, how long it is and what kind it is. |
TAtlasTokenKind support type | Atlas.Syntax | Enumeration | The kinds of Object Pascal token the syntax lexer tells apart: plain text, keyword, string, comment and number. |
TAtlasUpdateInfo support type | Atlas.Updater | Record | The fields of an update manifest: version, download URL, SHA-256 digest and size. |
Atlas Fin
Financial charts with OHLCV data, indicators and multi-pane views. Tutorial · Sample projects
| Component | Unit | Kind | Summary |
|---|---|---|---|
TAtlasFinChart | Atlas.FinChart | Visual control | A multi-pane financial chart: price bars, volume and technical studies in stacked panes on one shared, gap-free time axis. |
EAtlasFinError support type | Atlas.FinData | Class | The exception Atlas Fin raises for invalid bars, CSV text, periods, zoom factors and export requests. |
TAtlasBands support type | Atlas.FinIndicators | Record | The three lines TAtlasIndicators.Bollinger returns. |
TAtlasBar support type | Atlas.FinData | Record | One price bar: time, open, high, low, close and volume. |
TAtlasBarEvent support type | Atlas.FinChart | Type | The event type of TAtlasFinChart.OnCrosshair: a bar index, or -1 for none. |
TAtlasBarPeriod support type | Atlas.FinData | Enumeration | The calendar period TAtlasBarSeries.Aggregate combines bars into. |
TAtlasBarSeries support type | Atlas.FinData | Class | A validated, time-ordered list of OHLCV price bars with live update, time lookup, aggregation and CSV. |
TAtlasFinPane support type | Atlas.FinChart | Class | One horizontal pane of a TAtlasFinChart: a title, a height weight, its own value scale and the studies drawn in it. |
TAtlasFinPanes support type | Atlas.FinChart | Class | The collection behind TAtlasFinChart.Panes: the panes of a chart from top to bottom. |
TAtlasFinStudies support type | Atlas.FinChart | Class | The collection behind TAtlasFinPane.Studies: what a pane draws, in drawing order. |
TAtlasFinStudy support type | Atlas.FinChart | Class | One thing a pane draws: the price bars, the volume, or a technical indicator computed from the closes. |
TAtlasIndicators support type | Atlas.FinIndicators | Class | Technical indicators over an array of values: SMA, EMA, Bollinger bands, RSI and MACD. |
TAtlasMacd support type | Atlas.FinIndicators | Record | The three lines TAtlasIndicators.MACD returns. |
TAtlasStudyKind support type | Atlas.FinChart | Enumeration | What a TAtlasFinStudy draws: one of four price styles, volume, or one of five indicators. |
Atlas Info
Data-aware grid, lookup, filter and rich text controls. Tutorial · Sample projects
| Component | Unit | Kind | Summary |
|---|---|---|---|
TAtlasDataFilter | Atlas.DBFilter | Non-visual component | A non-visual controller that filters a dataset by case-insensitive text on one field, composed with the dataset's own filter, and puts that filter back when cleared or freed. |
TAtlasDBGrid | Atlas.DBControls | Visual control | A data-aware grid with validated typed edits that never post on their own, CSV export of visible or selected rows, and a row height that follows the monitor DPI. |
TAtlasDBLookupCombo | Atlas.DBControls | Visual control | A data-aware lookup combo box that selects by key or by case-insensitive display text, checks the key against the lookup table and leaves the master record in edit state. |
TAtlasDBRichEdit | Atlas.DBControls | Visual control | A data-aware rich edit that loads, formats and stores RTF in a blob or memo field and leaves posting to your code. |
TAtlasFilterEdit | Atlas.DBFilter | Visual control | An edit box that applies its text to a TAtlasDataFilter every time the text changes. |
EAtlasDatabaseError support type | Atlas.DBControls | Class | The exception the Atlas Info controls and filter raise when they refuse an operation. |
TAtlasTextMatch support type | Atlas.DBFilter | Enumeration | How TAtlasDataFilter compares the field text with the filter text. |
Atlas Plot Pro
Statistics, box plots, heat maps, radar plots and analysis series. Tutorial · Sample projects
| Component | Unit | Kind | Summary |
|---|---|---|---|
TAtlasBoxPlot | Atlas.BoxPlot | Visual control | Box-and-whisker chart: one box per sample with quartiles, median, mean, 1.5 IQR whiskers and outliers. |
TAtlasHeatMap | Atlas.HeatMap | Visual control | A matrix of values drawn as coloured cells with a two- or three-stop gradient, empty cells and a colour scale. |
TAtlasPolarPlot | Atlas.PolarPlot | Visual control | Radar (spider) chart: categories as spokes, each series a filled or outlined shape across them. |
TAtlasBoxHit support type | Atlas.BoxPlot | Record | What TAtlasBoxPlot.HitTest found: the part, the category and, for an outlier, its index. |
TAtlasBoxPart support type | Atlas.BoxPlot | Enumeration | The part of a box plot a hit test found. |
TAtlasBoxStats support type | Atlas.PlotStats | Record | Box plot statistics of one sample: count, quartiles, mean, whiskers and outliers. |
TAtlasCustomChart support type | Atlas.ProChart | Visual control | Base class of the Atlas Plot Pro controls: painting, off-screen rendering, export, title, footnote, legend and batching. |
TAtlasHistogram support type | Atlas.PlotStats | Record | Histogram bins: edges, counts and a lookup of the bin a value falls in. |
TAtlasLegendEntry support type | Atlas.ProChart | Record | One line of a legend drawn by TAtlasCustomChart.DrawLegend: a caption and a swatch colour. |
TAtlasPlotAnalysis support type | Atlas.PlotAnalysis | Class | Adds a histogram, a polynomial fit curve or a smoothed copy as a new series of a TAtlasPlot. |
TAtlasPolarGrid support type | Atlas.PolarPlot | Enumeration | Shape of the radar chart's rings: polygons through the spokes or circles. |
TAtlasPolarStyle support type | Atlas.PolarPlot | Enumeration | Whether radar series are filled shapes or outlines. |
TAtlasPolynomial support type | Atlas.PlotStats | Record | A fitted least-squares polynomial: evaluate it anywhere and read its R squared. |
TAtlasStats support type | Atlas.PlotStats | Class | Statistics without a chart: mean, deviation, quantiles, box statistics, histograms, correlation, polynomial fits and smoothing. |
Atlas Plot
General purpose charts: series, axes, legend, zoom and image export. Tutorial · Sample projects
| Component | Unit | Kind | Summary |
|---|---|---|---|
TAtlasPlot | Atlas.Plot | Visual control | VCL chart control with line, step, area, bar, point and pie series, zoom, hit testing and PNG, SVG, EMF and CSV export. |
EAtlasPlotError support type | Atlas.PlotAxis | Class | Raised by Atlas Plot for invalid values, ranges, sizes and formats; the chart is left unchanged. |
TAtlasCanvasSurface support type | Atlas.PlotSurface | Class | Drawing surface over any VCL TCanvas: screen, bitmap, metafile or printer. |
TAtlasPlotAxis support type | Atlas.PlotAxis | Class | Scale of one TAtlasPlot axis: automatic or manual range, logarithmic, date/time, inverted, grid, title and label format. |
TAtlasPlotKind support type | Atlas.PlotSeries | Enumeration | How a TAtlasPlotSeries is drawn: line, step, area, bar, point or pie. |
TAtlasPlotLegendPosition support type | Atlas.Plot | Enumeration | Side of a TAtlasPlot the legend occupies. |
TAtlasPlotMarks support type | Atlas.PlotSeries | Enumeration | Which label a TAtlasPlotSeries draws next to each point. |
TAtlasPlotPoint support type | Atlas.PlotSeries | Record | One stored point of a series: argument, value, gap flag, text and colour. |
TAtlasPlotPointEvent support type | Atlas.Plot | Type | Event type of TAtlasPlot.OnPointClick: the clicked series and point index. |
TAtlasPlotSeries support type | Atlas.PlotSeries | Class | One data series of a TAtlasPlot: its points, kind, colour, marks and statistics. |
TAtlasPlotSeriesList support type | Atlas.PlotSeries | Class | The collection behind TAtlasPlot.Series. |
TAtlasPlotStacking support type | Atlas.Plot | Enumeration | How TAtlasPlot stacks bar and area series. |
TAtlasPlotSurface support type | Atlas.PlotSurface | Class | Abstract drawing target that TAtlasPlot.Render draws through: pen, brush, font, lines, shapes, text and clipping. |
TAtlasPlotTick support type | Atlas.PlotAxis | Record | One axis tick: its value and its label. |
TAtlasRenderProc support type | Atlas.PlotSurface | Type | Callback that draws onto a surface; passed to AtlasExportImage. |
TAtlasSvgSurface support type | Atlas.PlotSurface | Class | Drawing surface that builds an SVG document. |
Atlas Virtual Grid
A custom-drawn grid over memory, on-demand or chart-backed data. Tutorial · Sample projects
| Component | Unit | Kind | Summary |
|---|---|---|---|
TAtlasMemoryData | Atlas.VGridData | Non-visual component | A data source that holds typed cells in memory, filled from invariant text or from typed cells. |
TAtlasPlotData | Atlas.VGridPlot | Non-visual component | The chart companion: a data source that shows a TAtlasPlot chart as a table, with one row per argument and one column per series, and writes edits back to the chart. |
TAtlasVirtualData | Atlas.VGridData | Non-visual component | A data source that stores nothing: the application supplies each cell on demand through OnGetCell and receives edits through OnSetCell. |
TAtlasVirtualGrid | Atlas.VGrid | Visual control | A custom-drawn VCL data grid that holds no cells: it asks a data source for the ones on screen. It has bands, frozen columns, sorting, a text filter, totals, multi-row selection, in-place editing and CSV, HTML, SVG and PNG output. |
EAtlasGridError support type | Atlas.VGridData | Class | The exception class of Atlas Virtual Grid, and the way a data source refuses a value. |
TAtlasCell support type | Atlas.VGridData | Record | One typed cell value: text, number, date/time or yes/no, or null. |
TAtlasCellKind support type | Atlas.VGridData | Enumeration | The four kinds of cell value. |
TAtlasCellStyleEvent support type | Atlas.VGrid | Type | Method type of TAtlasVirtualGrid.OnCellStyle: choose a cell's background and text colour. |
TAtlasColumnAlign support type | Atlas.VGrid | Enumeration | Horizontal alignment of a column's cells, title and total. |
TAtlasGetCellEvent support type | Atlas.VGridData | Type | Method type of TAtlasVirtualData.OnGetCell: supply one cell. |
TAtlasGridArea support type | Atlas.VGrid | Enumeration | The part of the grid a point falls on, as reported by HitTest. |
TAtlasGridColumn support type | Atlas.VGrid | Class | One grid column: which data column it shows, and its title, width, format, band, alignment, visibility, read-only flag and total. |
TAtlasGridColumns support type | Atlas.VGrid | Class | The grid's collection of columns. |
TAtlasGridData support type | Atlas.VGridData | Non-visual component | The abstract base of every data source: rows, typed columns, cells, change notification and batching. |
TAtlasGridHit support type | Atlas.VGrid | Record | The result of TAtlasVirtualGrid.HitTest: area, column and row under a point. |
TAtlasGridMessageEvent support type | Atlas.VGrid | Type | Method type of TAtlasVirtualGrid.OnEditError: the reason a value was refused. |
TAtlasSetCellEvent support type | Atlas.VGridData | Type | Method type of TAtlasVirtualData.OnSetCell: store or refuse one edited cell. |
TAtlasTotalKind support type | Atlas.VGrid | Enumeration | The footer totals: none, sum, average, minimum, maximum or count. |
Atlas Crypto
Misuse-resistant hashing, key derivation, encryption and signatures over Windows CNG. Tutorial · Sample projects
| Component | Unit | Kind | Summary |
|---|---|---|---|
TAtlasFileProtector | Atlas.CryptoComponents | Non-visual component | Non-visual component that encrypts and decrypts files and text with a password (PBKDF2-HMAC-SHA256 and AES-256-GCM in authenticated chunks), with progress and cancel. |
TAtlasHashCalculator | Atlas.CryptoComponents | Non-visual component | Non-visual component that returns SHA-2 (or legacy SHA-1 and MD5) digests of text, streams and files as hexadecimal, and checks a file against a published checksum in constant time. |
EAtlasCryptoError support type | Atlas.Crypto | Class | The one exception class raised by every Atlas Crypto failure: bad arguments, failed authentication, CNG errors and cancel. |
TAtlasAesGcm support type | Atlas.Crypto | Class | Raw AES in Galois/Counter Mode with a 12-byte nonce and a 16-byte tag. Prefer TAtlasSecretBox. |
TAtlasBytes support type | Atlas.Crypto | Class | Byte helpers: hexadecimal, URL-safe base64, UTF-8, joining, constant-time comparison and wiping. |
TAtlasCryptoProgress support type | Atlas.CryptoBox | Type | Progress callback of the stream and file functions: an anonymous procedure with bytes done, bytes in total and a cancel flag. |
TAtlasCryptoProgressEvent support type | Atlas.CryptoComponents | Type | The method type of OnProgress on both components: bytes done, bytes in total, and a flag to cancel. |
TAtlasEcdh support type | Atlas.CryptoKeys | Class | Elliptic-curve Diffie-Hellman key agreement on P-256: two parties derive the same 32-byte key from their own private key and the other's public key. |
TAtlasEcdsa support type | Atlas.CryptoKeys | Class | ECDSA signatures on the NIST P-256 curve with SHA-256, and conversion of public keys to and from X/Y coordinates. |
TAtlasHash support type | Atlas.Crypto | Class | SHA-2, SHA-1 and MD5 hashes and HMAC, in one call or incrementally over bytes, buffers, streams and files. |
TAtlasHashKind support type | Atlas.Crypto | Enumeration | The hash algorithms: SHA-256, SHA-384 and SHA-512, and the legacy SHA-1 and MD5. |
TAtlasKdf support type | Atlas.Crypto | Class | Key derivation: PBKDF2 to stretch passwords, HKDF to derive several keys from one strong secret. |
TAtlasKeyPair support type | Atlas.CryptoKeys | Record | A public and a private key as CNG key blobs in TBytes, with Wipe for the private half. |
TAtlasRandom support type | Atlas.Crypto | Class | Cryptographically secure random bytes, unbiased integers and URL-safe tokens from the operating system. |
TAtlasRsa support type | Atlas.CryptoKeys | Class | RSA with OAEP (SHA-256) encryption of short secrets and PSS (SHA-256, 32-byte salt) signatures, for keys of 2048 to 8192 bits. |
TAtlasSecretBox support type | Atlas.CryptoBox | Class | Seal and open bytes or text with a 32-byte key or a password, using AES-256-GCM with generated nonces and salts. |
TAtlasStreamCrypt support type | Atlas.CryptoBox | Class | Encrypt and decrypt streams and files of any size in authenticated chunks, with a key or a password, progress and cancel. |
TCngAlgorithm support type | Atlas.Crypto.Cng | Class | Low-level wrapper of a Windows CNG algorithm provider handle, used by the other units; applications rarely need it. |
Atlas Log
Structured logging with levels, templates, scopes, sinks and a live viewer. Tutorial · Sample projects
| Component | Unit | Kind | Summary |
|---|---|---|---|
TAtlasAsyncSink | Atlas.LogSinks | Non-visual component | Queues events and writes them to another sink on a background thread, with a bounded queue. |
TAtlasCallbackSink | Atlas.LogSinks | Non-visual component | Hands each event to an event handler, on the thread that logged. |
TAtlasConsoleSink | Atlas.LogSinks | Non-visual component | Writes events to standard output, and to standard error from ErrorLevel upward. |
TAtlasDebugSink | Atlas.LogSinks | Non-visual component | Sends events to OutputDebugString, for the IDE event log and debug viewers. |
TAtlasFileSink | Atlas.LogSinks | Non-visual component | Writes UTF-8 lines to a file, with size rotation, daily files and retention. |
TAtlasLogger | Atlas.Log | Non-visual component | Takes log events at six levels, fills message templates, and hands each event to its sinks. |
TAtlasLogView | Atlas.LogView | Visual control | A live, filterable VCL view of a TAtlasMemorySink, with level colours. |
TAtlasMemorySink | Atlas.LogSinks | Non-visual component | Keeps the most recent events in a ring buffer, for the log viewer, diagnostics and tests. |
EAtlasLogError support type | Atlas.Log | Class | Raised for configuration mistakes; logging calls themselves never raise. |
TAtlasJsonFormatter support type | Atlas.LogFormat | Class | Formats an event as one JSON object on one line. |
TAtlasLogChannel support type | Atlas.Log | Record | A logger bound to one category; cheap to copy and to keep in a field. |
TAtlasLogClock support type | Atlas.Log | Type | A replaceable clock returning UTC, so tests can control event times and cross midnight. |
TAtlasLogEvent support type | Atlas.Log | Record | One log event: time, level, category, message, template, scope, thread, exception and properties. |
TAtlasLogEventHandler support type | Atlas.LogSinks | Type | The event type of TAtlasCallbackSink.OnEvent. |
TAtlasLogFormatter support type | Atlas.LogFormat | Class | The abstract base of the formatters: one event in, one line of text out. |
TAtlasLogLayout support type | Atlas.LogSinks | Enumeration | How a text sink writes an event: a text pattern or a JSON object. |
TAtlasLogLevel support type | Atlas.Log | Enumeration | The six log levels, from trace to fatal, plus llOff as a threshold. |
TAtlasLogProperty support type | Atlas.Log | Record | A name and a text value taken from a message template hole or a spare argument. |
TAtlasLogSink support type | Atlas.Log | Class | The abstract base of every sink: logger link, threshold and a lock around writing. |
TAtlasOverflow support type | Atlas.LogSinks | Enumeration | What an asynchronous sink does when its queue is full. |
TAtlasTextFormatter support type | Atlas.LogFormat | Class | Formats an event as one line of text from a pattern of tokens. |
TAtlasTextSink support type | Atlas.LogSinks | Class | The base of the sinks that write lines of text: Layout and Pattern. |
Atlas MQTT
An MQTT 3.1.1 client component and a small embeddable broker. Tutorial · Sample projects
| Component | Unit | Kind | Summary |
|---|---|---|---|
TAtlasMqttBroker | Atlas.MqttBroker | Non-visual component | A small MQTT 3.1.1 broker that runs inside your program, for tests, simulators, demos and a local message bus. |
TAtlasMqttClient | Atlas.MqttClient | Non-visual component | An MQTT 3.1.1 client component: publishes and subscribes at qualities 0 to 2, keeps the connection alive and reconnects by itself. |
EAtlasMqttError support type | Atlas.MqttCodec | Class | Base class of every Atlas MQTT exception; raised for invalid arguments, settings and packets. |
EAtlasMqttProtocolError support type | Atlas.MqttCodec | Class | Raised when received bytes break the MQTT 3.1.1 wire format. |
EAtlasMqttTransportError support type | Atlas.MqttTransport | Class | Raised for socket failures: binding, connecting, name lookup, sending. |
TAtlasMqttAuthenticateEvent support type | Atlas.MqttBroker | Type | The type of TAtlasMqttBroker.OnAuthenticate: decide whether a client may connect. |
TAtlasMqttCodec support type | Atlas.MqttCodec | Class | MQTT 3.1.1 packet encoding and strict decoding, topic validation and topic matching, as class functions. |
TAtlasMqttConnectedEvent support type | Atlas.MqttClient | Type | The type of TAtlasMqttClient.OnConnected. |
TAtlasMqttMessageEvent support type | Atlas.MqttClient | Type | The type of TAtlasMqttClient.OnMessage: one delivered message. |
TAtlasMqttPacketEvent support type | Atlas.MqttClient | Type | The type of TAtlasMqttClient.OnPublished: the broker acknowledged a message. |
TAtlasMqttParser support type | Atlas.MqttCodec | Class | Turns a TCP byte stream into MQTT packets, however the bytes are split, with a size limit checked on the header. |
TAtlasMqttState support type | Atlas.MqttClient | Enumeration | Where a client's connection stands, as reported by TAtlasMqttClient.State. |
TAtlasMqttSubscribedEvent support type | Atlas.MqttClient | Type | The type of TAtlasMqttClient.OnSubscribed: the broker answered a subscription. |
TAtlasMqttTextEvent support type | Atlas.MqttClient | Type | The type of TAtlasMqttClient.OnDisconnected and OnError: something happened, with the reason in words. |
TAtlasMqttTransport support type | Atlas.MqttTransport | Class | The abstract byte pipe under the client: derive from it to supply TLS, a tunnel or a test double. |
TAtlasMqttTransportEvent support type | Atlas.MqttClient | Type | The type of TAtlasMqttClient.OnCreateTransport: supply the byte pipe for the next connection attempt. |
TAtlasTcpListener support type | Atlas.MqttTransport | Class | A listening TCP socket that accepts connections as TAtlasTcpTransport objects; the broker is built on it. |
TAtlasTcpTransport support type | Atlas.MqttTransport | Class | The TCP transport over Winsock, IPv4 only; used by the client unless OnCreateTransport supplies another. |
TMqttPacket support type | Atlas.MqttCodec | Record | One MQTT 3.1.1 control packet as a record: the input of TAtlasMqttCodec.Encode and the output of Decode. |
TMqttPacketKind support type | Atlas.MqttCodec | Enumeration | The sixteen MQTT control packet types; the ordinal is the type number on the wire. |
TMqttQoS support type | Atlas.MqttCodec | Enumeration | Quality of service: at most once, at least once, exactly once. |