API reference - Class StringValueNotation used in Ruby API documentation 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. Starting with version 0.22, the InputDialog class offers new method which do no longer require to use this class. Public constructors
Public methods
Detailed description[const] void assign(const StringValue other)Description: Assign the contents of another object to self This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content. void createDescription: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. void destroyDescription: 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: Returns a value indicating whether the object was already 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] StringValue dupDescription: Creates a copy of self [const] bool has_value?Description: True, if a value is present [const] bool is_const_object?Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. [static] StringValue newDescription: Creates a new object of this class [const] string to_sDescription: Get the actual value (a synonym for value) [const] string valueDescription: Get the actual value |