Skip to content

getting_started.md

Latest commit

 

History

History
101 lines (72 loc) · 2.7 KB

getting_started.md

File metadata and controls

101 lines (72 loc) · 2.7 KB
Raw

Getting Started

Requirements

  • CMake 3.24+
  • C++20 compiler
  • Qt 6.7+
  • Qt modules: Core, Gui, Qml, Quick

Build The Project

cmake -S . -B build
cmake --build build

Useful targets:

  • ScintillaQuick

If BUILD_TESTING is enabled, test executables are built as well. Examples and benchmarks are opt-in:

cmake -S . -B build -DSCINTILLAQUICK_BUILD_EXAMPLES=ON -DSCINTILLAQUICK_BUILD_BENCHMARKS=ON
cmake --build build

Run The Example

After building with SCINTILLAQUICK_BUILD_EXAMPLES=ON, run:

./build/scintillaquick_minimal_editor

On Windows with a multi-config generator, use the matching configuration path, for example:

./build/Debug/scintillaquick_minimal_editor.exe

Install And Consume

Install the package:

cmake --install build --prefix <install-prefix>

Then consume it from another CMake project:

find_package(ScintillaQuick CONFIG REQUIRED)
target_link_libraries(my_app PRIVATE ScintillaQuick::ScintillaQuick)

The installed package includes Scintilla's public headers. Scintilla internal implementation headers are not part of the installed interface.

Minimal Integration Pattern

Typical C++ integration looks like this:

  1. Create a QGuiApplication.
  2. Create a QQuickWindow or parent QQuickItem.
  3. Instantiate ScintillaQuick_item.
  4. Attach it to the Qt Quick scene.
  5. Set geometry, font, and initial text. The first-party examples and tests use the shared helper in examples/common/scintillaquick_font.h to select a bundled fixed-font family. By default it picks Cascadia Code, and SCINTILLAQUICK_FIXED_FONT_FAMILY can switch it to Cousine.
  6. Drive editor behavior with Scintilla messages through send().

The editor also has a built-in bottom find/replace panel. Ctrl+F shows the find row and Ctrl+H adds the replace row. Applications may invoke showFind(), showFindReplace(), and hideFindPanel() directly, bind to the findPanelVisible and findReplaceMode properties, and customize the panel with the findPanelFont and findPanel*Color properties. Set findOptions to a combination of Scintilla SCFIND_* flags when case-sensitive, whole-word, or regular-expression matching is required.

See examples/minimal_editor/main.cpp for a complete runnable example.

Testing

Run the registered test suite with:

ctest --test-dir build --output-on-failure

Registered tests currently include smoke, frame-validation, and visual-regression coverage. Benchmark-backed coverage is registered when SCINTILLAQUICK_BUILD_BENCHMARKS=ON.

On Windows, visual tests require a desktop session because they create and show a QQuickWindow.