Kanzi  3.9.5
Kanzi Engine API
kanzi::TextBoxConcept::SelectedTextMessageArguments Class Reference

Message arguments that hold the information about the selected text in the buffer of a Text Box node. More...

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

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

Public Member Functions

size_t getSelectionEnd () const
 Returns the value of the SelectionEndProperty. More...
 
size_t getSelectionStart () const
 Returns the value of the SelectionStartProperty. More...
 
void setSelectionEnd (size_t endPosition)
 Sets the value of the SelectionEndProperty. More...
 
void setSelectionStart (size_t startPosition)
 Sets the value of the SelectionStartProperty. More...
 
- Public Member Functions inherited from kanzi::TextBoxConcept::TextContentMessageArguments
string getText () const
 Returns the value of the TextProperty which contains the text in a Text Box node. More...
 
void setText (string 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 > SelectionEndProperty
 Sets the index value for the end of a selection. More...
 
static PropertyType< int > SelectionStartProperty
 Sets the index value for the start of a selection. More...
 
- Static Public Attributes inherited from kanzi::TextBoxConcept::TextContentMessageArguments
static PropertyType< string > TextProperty
 The property defines 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 about the selected text in the buffer of a Text Box node.

Member Function Documentation

◆ setSelectionStart()

void kanzi::TextBoxConcept::SelectedTextMessageArguments::setSelectionStart ( size_t  startPosition)
inline

Sets the value of the SelectionStartProperty.

Parameters
startPositionThe index value for the start of a selection.

◆ getSelectionStart()

size_t kanzi::TextBoxConcept::SelectedTextMessageArguments::getSelectionStart ( ) const
inline

Returns the value of the SelectionStartProperty.

Returns
The value of the SelectionStartProperty in the message argument.

◆ setSelectionEnd()

void kanzi::TextBoxConcept::SelectedTextMessageArguments::setSelectionEnd ( size_t  endPosition)
inline

Sets the value of the SelectionEndProperty.

Parameters
endPositionThe index value for the end of a selection.

◆ getSelectionEnd()

size_t kanzi::TextBoxConcept::SelectedTextMessageArguments::getSelectionEnd ( ) const
inline

Returns the value of the SelectionEndProperty.

Returns
The value of the SelectionEndProperty in the message argument.

Member Data Documentation

◆ SelectionStartProperty

PropertyType<int> kanzi::TextBoxConcept::SelectedTextMessageArguments::SelectionStartProperty
static

Sets the index value for the start of a selection.

◆ SelectionEndProperty

PropertyType<int> kanzi::TextBoxConcept::SelectedTextMessageArguments::SelectionEndProperty
static

Sets the index value for the end of a selection.


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