diff options
author | Andy Belle-Isle <drumsetmonkey@gmail.com> | 2019-08-30 00:19:31 -0400 |
---|---|---|
committer | Andy Belle-Isle <drumsetmonkey@gmail.com> | 2019-08-30 00:19:31 -0400 |
commit | bd3fe0cac583739bc0d7c4b5c8f301bb350abca0 (patch) | |
tree | 7eeb1aabcebd6999de1c3457d0882246ec0ff4d4 /deps/sol2/docs/source/api/property.rst | |
parent | 2662ac356ce14dacfbc91689fd37244facff4989 (diff) |
Renamed lib to deps so github will ignore it for language stats
Diffstat (limited to 'deps/sol2/docs/source/api/property.rst')
-rw-r--r-- | deps/sol2/docs/source/api/property.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/deps/sol2/docs/source/api/property.rst b/deps/sol2/docs/source/api/property.rst new file mode 100644 index 0000000..7141bc9 --- /dev/null +++ b/deps/sol2/docs/source/api/property.rst @@ -0,0 +1,18 @@ +property +======== +*wrapper to specify read and write variable functionality using functions* + +.. code-block:: cpp + + template <typename Read, typename Write> + decltype(auto) property ( Read&& read_function, Write&& write_function ); + template <typename Read> + decltype(auto) property ( Read&& read_function ); + template <typename Write> + decltype(auto) property ( Write&& write_function ); + +These set of functions create a type which allows a setter and getter pair (or a single getter, or a single setter) to be used to create a variable that is either read-write, read-only, or write-only. When used during :doc:`usertype<usertype>` construction, it will create a variable that uses the setter/getter member function specified. + +.. literalinclude:: ../../../examples/source/property.cpp + :linenos: + |