API reference - Class ProgressNotation used in Ruby API documentation Description: A progress reporter This is the base class for all progress reporter objects. Progress reporter objects are used to report the progress of some operation and to allow to abort an operation. Progress reporter objects must be triggered periodically, i.e. a value must be set. On the display side, a progress bar usually is used to represent the progress of an operation. Actual implementations of the progress reporter class are RelativeProgress and AbsoluteProgress. This class has been introduced in version 0.23. Public methods
Detailed descriptionvoid 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. [const] string descDescription: Gets the description text of the progress object void desc=(string desc)Description: Sets the description text of the progress object 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] 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. void title=(string title)Description: Sets the title text of the progress object Initially the title is equal to the description. |