mirror of
https://github.com/slint-ui/slint.git
synced 2025-10-01 14:21:16 +00:00
8de3075270
Move the sixtyfps::namespace entry into a dedicated C++ integration overview page. Also duplicate and specialize the instantiation and model bits, which differ between the compiled code and the interpreter. Finally, fix the generated C++ docs to not mention that there's a constructor, instead we generate a constructor function.
98 lines
3.9 KiB
Markdown
98 lines
3.9 KiB
Markdown
# Generated code
|
|
|
|
The SixtyFPS compiler called by the build system will generate a header file for the root `.60`
|
|
file. This header file will contain a `class` with the same name as the component.
|
|
|
|
This class will have the following public member functions:
|
|
|
|
* A `create` constructor function and a destructor.
|
|
* A `show` function, which will show the component on the screen. Note that in order to render
|
|
and react to user input, it's still necessary to spin the event loop, by calling {cpp:func}`sixtyfps::run_event_loop()`
|
|
or using the convenience `fun` function in this class.
|
|
* A `hide` function, which de-registers the component from the windowing system.
|
|
* A `window` function that provides access to the {cpp:class}`sixtyfps::Window`, allow for further customization
|
|
towards the windowing system.
|
|
* A `run` convenience function, which will show the component and starts the event loop.
|
|
* for each properties:
|
|
* A getter `get_<property_name>` returning the property type.
|
|
* A setter `set_<property_name>` taking the new value of the property by const reference
|
|
* for each callbacks:
|
|
* `invoke_<callback_name>` function which takes the callback argument as parameter and call the callback.
|
|
* `on_<callback_name>` function which takes a functor as an argument and sets the callback handler
|
|
for this callback. the functor must accept the type parameter of the callback
|
|
* A `global` function, to provide access to any exported global singletons.
|
|
|
|
The class is instantiated with the `create` function, which returns the type wrapped in {cpp:class}`sixtyfps::ComponentHandle`.
|
|
This is a smart pointer that owns the actual instance and keeps it alive as long as at least one {cpp:class}`sixtyfps::ComponentHandle`
|
|
is in scope, similar to `std::shared_ptr<T>`.
|
|
|
|
For more complex UIs it is common to supply data in the form of an abstract data model, that is used with
|
|
[`for` - `in`](markdown/langref.md#repetition) repetitions or [`ListView`](markdown/widgets.md#listview) elements in the `.60` language.
|
|
All models in C++ are sub-classes of the {cpp:class}`sixtyfps::Model` and you can sub-class it yourself. For convenience,
|
|
the {cpp:class}`sixtyfps::VectorModel` provides an implementation that is backed by a `std::vector<T>`.
|
|
|
|
## Example
|
|
|
|
Let's assume we have this code in our `.60` file
|
|
|
|
```60
|
|
SampleComponent := Window {
|
|
property<int> counter;
|
|
property<string> user_name;
|
|
callback hello;
|
|
// ... maybe more elements here
|
|
}
|
|
```
|
|
|
|
This will generate a header with the following contents (edited for documentation purpose)
|
|
|
|
```cpp
|
|
#include <array>
|
|
#include <limits>
|
|
#include <sixtyfps.h>
|
|
|
|
|
|
class SampleComponent {
|
|
public:
|
|
/// Constructor function
|
|
inline auto create () -> sixtyfps::ComponentHandle<MainWindow>;
|
|
/// Destructor
|
|
inline ~SampleComponent ();
|
|
|
|
/// Show this component, and runs the event loop
|
|
inline void run () const;
|
|
|
|
/// Show the window that renders this component. Call `sixtyfps::run_event_loop()`
|
|
/// to continuously render the contents and react to user input.
|
|
inline void show () const;
|
|
|
|
/// Hide the window that renders this component.
|
|
inline void hide () const;
|
|
|
|
/// Getter for the `counter` property
|
|
inline int get_counter () const;
|
|
/// Setter for the `counter` property
|
|
inline void set_counter (const int &value) const;
|
|
|
|
/// Getter for the `user_name` property
|
|
inline sixtyfps::SharedString get_user_name () const;
|
|
/// Setter for the `user_name` property
|
|
inline void set_user_name (const sixtyfps::SharedString &value) const;
|
|
|
|
/// Call this function to call the `hello` callback
|
|
inline void invoke_hello () const;
|
|
/// Sets the callback handler for the `hello` callback.
|
|
template<typename Functor> inline void on_hello (Functor && callback_handler) const;
|
|
|
|
// Returns a reference to a global singleton that's exported.
|
|
inline template<typename T>
|
|
const T &global() const;
|
|
|
|
private:
|
|
/// private fields omitted
|
|
};
|
|
|
|
|
|
|
|
|
|
```
|