Class StringValue (version 0.16)

Description: Encapsulate a string value

This class is provided as a return value of InputDialog::get_string, InputDialog::get_item and FileDialog. By using an object rather than a pure value, an object with has_value? = false can be returned indicating that the "Cancel" button was pressed.

Class overview

Index

Method Overview

[const] bool has_value?	True, if a value is present
[const] string to_s	Get the actual value (a synonym for value)
[const] string value	Get the actual value
destroy	Explicitly destroy the object
[const] bool destroyed	Tell, if the object was destroyed

destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed

Description: Tell, if the object was destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool has_value?

Description: True, if a value is present

[const] string to_s

Description: Get the actual value (a synonym for value)

[const] string value

Description: Get the actual value