API reference - Class ObserverNotation used in Ruby API documentation Description: This class implements an event handler for use with 'observer' interfaces Class hierarchy: Observer
Some classes provide callbacks by attaching 'observer' objects to certain events. Specific actions can be implemented by reimplementing the 'signal...' methods of this class or by attaching code to the 'on_signal' or 'on_signal_int' event. Here is some sample code:
observer = RBA::Observer::new
def observer.signal
puts "A new view has been opened"
end
RBA::Application::instance.main_window.add_new_view_observer(observer)
Using the event this code looks like this:
observer = RBA::Observer::new
observer.on_signal do
puts "A new view has been opened"
end
RBA::Application::instance.main_window.add_new_view_observer(observer)
Public constructors
Public methods
Deprecated methods (protected, public, static, non-static and constructors)
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. void _destroyDescription: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, 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 _manageDescription: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. void _unmanageDescription: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. void assign(const Observer other)Description: Assigns another object to self void createDescription: Ensures the C++ object is created Use of this method is deprecated. Use _create instead void destroyDescription: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead [const] bool destroyed?Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead [const] new Observer ptr dupDescription: Creates a copy of self [const] bool is_const_object?Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead [static] new Observer ptr newDescription: Creates a new object of this class Python specific notes:This method is the default initializer of the object [event] void on_signalDescription: This event is called if the observer signals it's condition This event has been introduced in version 0.23. [event] void on_signal_int(int arg1)Description: This event is called if the observer signals it's condition with an integer argument This event has been introduced in version 0.23. [virtual] void signalDescription: This method is called when the event without value is issued [virtual] void signal_int(int value)Description: This method is called when an event associated with an integer is issued |