Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::TextBoxConcept::TextInsertionMessageArguments Class Reference

Message arguments that hold the information for inserting text to a Text Box node. More...

#include <kanzi/ui/node/concept/text_box.hpp>

Inheritance diagram for kanzi::TextBoxConcept::TextInsertionMessageArguments:
[legend]

Public Member Functions

size_t getPosition () const
 Returns the value of the PositionProperty. More...
 
string getText () const
 Returns the value of the TextProperty which contains the text to insert to a Text Box node. More...
 
void setPosition (size_t position)
 Sets the value of the PositionProperty. More...
 
void setText (string_view text)
 Sets the value of the TextProperty. More...
 
- Public Member Functions inherited from kanzi::MessageArguments
bool getAbstractArgument (AbstractPropertyType argumentType, Variant &variant) const
 Returns the value of an argument using AbstractPropertyType. More...
 
template<typename TDataType >
TDataType getArgument (const PropertyType< TDataType > &argumentType) const
 Returns the value of an argument. More...
 
detail::MessageDispatcher * getDispatcher () const
 Returns the message dispatcher that dispatches a message. More...
 
template<typename TDataType >
optional< TDataType > getOptionalArgument (const PropertyType< TDataType > &argumentType) const
 Returns the value of an argument. More...
 
shared_ptr< NodegetSource () const
 Returns the source node for a message. More...
 
TimePoint getTimestamp () const
 Returns the timestamp of a message. More...
 
AbstractMessageType getType () const
 Returns the message type of these message arguments as an AbstractMessageType instance. More...
 
bool isFrom (const Node &source) const
 Returns whether a node is the source node of a message. More...
 
bool isHandled () const
 Returns whether the message is handled. More...
 
bool isValid () const
 Returns whether a message is valid. More...
 
 MessageArguments ()=default
 Constructor. More...
 
 MessageArguments (const MessageArguments &)=delete
 Deleted copy. More...
 
MessageArgumentsoperator= (const MessageArguments &)=delete
 Deleted assignment. More...
 
void setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant)
 Sets the value of an argument using AbstractPropertyType. More...
 
template<typename TDataType >
void setArgument (const PropertyType< TDataType > &argumentType, typename PropertyType< TDataType >::DataType value)
 Sets the value of an argument. More...
 
void setDispatcher (detail::MessageDispatcher *dispatcher)
 Sets a dispatcher for a message. More...
 
void setHandled (bool handled)
 Sets the handling status for a message. More...
 
void setSource (Node *source)
 Sets the source node that dispatches a message. More...
 
void setTimestamp (TimePoint timestamp)
 Sets the timestamp of a message. More...
 
void setType (AbstractMessageType type)
 Sets the type of a message. More...
 
void setValid (bool valid)
 Sets the validity of a message. More...
 
 ~MessageArguments ()
 Destructor. More...
 

Static Public Attributes

static PropertyType< int > PositionProperty
 Sets the character index value at which to insert text. More...
 
static PropertyType< string > TextProperty
 Sets the text content of a Text Box node. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from kanzi::MessageArguments
static size_t getArgumentAllocatorPoolSize ()
 Gets the current size of memory pool of argument entries. More...
 
static const MetaclassgetStaticMetaclass ()
 Initializes and returns static metadata of base MessageArguments class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Initializes and returns the Kanzi Studio editor information. More...
 

Detailed Description

Message arguments that hold the information for inserting text to a Text Box node.

Member Function Documentation

◆ setPosition()

void kanzi::TextBoxConcept::TextInsertionMessageArguments::setPosition ( size_t  position)
inline

Sets the value of the PositionProperty.

Parameters
positionThe character index at which to insert text.

◆ getPosition()

size_t kanzi::TextBoxConcept::TextInsertionMessageArguments::getPosition ( ) const
inline

Returns the value of the PositionProperty.

Returns
The value of the PositionProperty in the message argument.

◆ setText()

void kanzi::TextBoxConcept::TextInsertionMessageArguments::setText ( string_view  text)
inline

Sets the value of the TextProperty.

Parameters
textThe text string that you want to insert to a Text Box node.

◆ getText()

string kanzi::TextBoxConcept::TextInsertionMessageArguments::getText ( ) const
inline

Returns the value of the TextProperty which contains the text to insert to a Text Box node.

Returns
The value of the TextProperty in the message argument.

Member Data Documentation

◆ PositionProperty

PropertyType<int> kanzi::TextBoxConcept::TextInsertionMessageArguments::PositionProperty
static

Sets the character index value at which to insert text.

◆ TextProperty

PropertyType<string> kanzi::TextBoxConcept::TextInsertionMessageArguments::TextProperty
static

Sets the text content of a Text Box node.


The documentation for this class was generated from the following file: