language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-09-30 22:01:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Minor documentation fixes for the globals access API

Browse source
This commit is contained in:
Simon Hausmann 2021-08-27 13:19:33 +02:00 • committed by Olivier Goffart
parent 3206d6fcfc
commit 0bb586e70f
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
api/sixtyfps-cpp/include/sixtyfps_interpreter.h
View file

@ -712,15 +712,15 @@ public:
/// Set the value for a property within an exported global
///
/// For example, if the main file has a global `TheGlobal` with a `property <int> hello`,
/// For example, if the main file has an exported global `TheGlobal` with a `property <int> hello`,
/// we can set this property
/// ```
/// instance->set_global_property("TheGlobal", "hello", 42);
/// ```
///
/// Returns true if the property was correctly set. Returns false if the property
/// could not be set because it either do not exist (was not declared in .60) or if
/// the value is not of the proper type for the property's type.
/// could not be set because it either does not exist (was not declared in .60) or if
/// the value is not of the correct type for the property's type.
bool set_global_property(std::string_view global, std::string_view prop_name,
const Value &value) const
{
@ -729,7 +729,7 @@ public:
inner(), sixtyfps::private_api::string_to_slice(global),
sixtyfps::private_api::string_to_slice(prop_name), &value.inner);
}
/// Returns the value behind a property in a exported global.
/// Returns the value behind a property in an exported global.
std::optional<Value> get_global_property(std::string_view global,
std::string_view prop_name) const
{
@ -752,7 +752,7 @@ public:
/// callback to_uppercase(string) -> string;
/// }
/// ```
/// Then one can set the callback handler
/// Then you can set the callback handler
/// ```cpp
/// instance->set_global_callback("Logic", "to_uppercase", [](auto args) {
/// std::string arg1(*args[0].to_string());