Files
KDDockWidgets/docs_devel/new_frontend.md
Sergio Martins 696ce887a8 docs: Add documentaiton about how to create a new frontend
Will be updating it as we go.
2022-06-26 22:33:46 +01:00

11 lines
687 B
Markdown

# Creating a new frontend
- Copy `src/dummy/` into `src/yourfrontend/`
- Rename the files from `_dummy` to `_yourfrontend`
- Edit `CMakeLists.txt` and `src/CMakeLists.txt`
- Edit the `FrontendType` enum in `KDDockWidgets.h` and add a new enumerator for your frontend
- Edit `Platform::frontendTypes()` in `Platform.cpp` and honour your new enumerator, properly ifdefed
- In `Platform.cpp` add the needed `#include "yourplatform/Platform_yourplatform.h` include
- Edit `Platform::tests_initPlatform()` and add your enumerator
- Edit `Platform_yourfrontend::name()` to return an ID for your frontend
- Run `./bin/tst_platform -tc="Platform::Platform,Platform::name"` , make sure it passes