Class StringListValue (version 0.18)

Description: Encapsulate a string list

This class is provided as a return value of FileDialog. By using an object rather than a pure string list, 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[ ] value	Get the actual value (a list of strings)
assign( StringListValue other )	Assign the contents of another object to self
[const] StringListValue dup	Creates a copy of self.
destroy	Explicitly destroy the object
[const] bool destroyed	Tell, if the object was destroyed

assign( StringListValue 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.

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] StringListValue dup

Description: Creates a copy of self.

[const] bool has_value?

Description: True, if a value is present

[const] string[ ] value

Description: Get the actual value (a list of strings)