.. generated by _ext/appcui_api.py - do not edit (regenerated by every build)

API reference
=============

Generated from the public header ``AppCUI/include/AppCUI.hpp`` (the only header an application includes).
Every declaration is listed, documented or not; descriptions come from the ``///`` comments of the header
and from ``docs/doxygen/namespaces.dox``.

.. code-block:: c++

   #include <AppCUI.hpp>

   using namespace AppCUI;

Namespaces
----------

* :doc:`AppCUI::Application <namespace_AppCUI_Application>` - Application lifetime: initialization (Init, InitializationData), the event loop (Run), desktop windows (AddWindow, ArrangeWindows), menus, themes, settings (<executable>.ini) and custom frontends.
* :doc:`AppCUI::Controls <namespace_AppCUI_Controls>` - Every visual element: windows, buttons, text fields, lists, trees, grids, splitters, tabs, menus and the base Control class.
* :doc:`AppCUI::Controls::Factory <namespace_AppCUI_Controls_Factory>` - Creation helpers: Factory::<Control>::Create(parent, ..., layout, ...) creates a control and adds it to its parent (returning a non-owning Reference) or returns an owning Pointer when no parent is given.
* :doc:`AppCUI::Controls::Handlers <namespace_AppCUI_Controls_Handlers>` - Event handlers that can be attached to a control (control->Handlers()->OnXXX = ...) instead of deriving a new control class: either a pointer to an object that implements the matching On...Interface or a plain function (a lambda without captures).
* :doc:`AppCUI::Graphics <namespace_AppCUI_Graphics>` - Drawing: colors, characters, the Renderer used by Control::Paint, canvases, images, rectangles, clipping, special characters (box drawing, arrows, ...), code pages and text formatting.
* :doc:`AppCUI::Graphics::ProgressStatus <namespace_AppCUI_Graphics_ProgressStatus>` - A modal progress window for long operations.
* :doc:`AppCUI::Input <namespace_AppCUI_Input>` - Keyboard and mouse input: key codes and modifiers (Key), mouse buttons and wheel, key bindings, key maps and keyboard modifier profiles (ModifierMap).
* :doc:`AppCUI::Utils <namespace_AppCUI_Utils>` - General purpose utilities: strings (String, LocalString, UnicodeStringBuilder, FixSizeString), buffers (Buffer, BufferView), INI files (IniObject), number formatting and parsing, smart references (Reference, Pointer), properties (PropertiesInterface) and key helpers (KeyUtils).
* :doc:`AppCUI::Utils::Number <namespace_AppCUI_Utils_Number>` - Parsing of numbers from strings (decimal, hexadecimal, ...).
* :doc:`AppCUI::OS <namespace_AppCUI_OS>` - Operating system services: files (File, MemoryFile, DataObject), the clipboard, dynamic libraries, date / time and special folders.
* :doc:`AppCUI::Dialogs <namespace_AppCUI_Dialogs>` - Ready made modal dialogs: message boxes, open / save file dialogs, the windows manager and the theme editor.
* :doc:`AppCUI::Log <namespace_AppCUI_Log>` - Logging of AppCUI (and application) messages to a file, to stdout / stderr or to the debugger.
* :doc:`AppCUI::Endian <namespace_AppCUI_Endian>` - Byte order helpers: byte swapping and conversions between the host order and little / big endian.
* :doc:`AppCUI <namespace_AppCUI>` - Root namespace of the AppCUI framework (#include <AppCUI.hpp>).
* :doc:`AppCUI::StdIncludes <namespace_AppCUI_StdIncludes>` - Standard library names (string_view, u16string_view, unique_ptr, vector, optional, ...) imported into the AppCUI namespace.

.. toctree::
   :hidden:
   :maxdepth: 2

   namespace_AppCUI_Application
   namespace_AppCUI_Controls
   namespace_AppCUI_Controls_Factory
   namespace_AppCUI_Controls_Handlers
   namespace_AppCUI_Graphics
   namespace_AppCUI_Graphics_ProgressStatus
   namespace_AppCUI_Input
   namespace_AppCUI_Utils
   namespace_AppCUI_Utils_Number
   namespace_AppCUI_OS
   namespace_AppCUI_Dialogs
   namespace_AppCUI_Log
   namespace_AppCUI_Endian
   namespace_AppCUI
   namespace_AppCUI_StdIncludes