GNU Octave  6.2.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
callback_property Class Reference

#include "graphics.in.h"

Inheritance diagram for callback_property:
Inheritance graph
[legend]
Collaboration diagram for callback_property:
Collaboration graph
[legend]

Public Member Functions

 callback_property (const callback_property &p)
 
 callback_property (const std::string &nm, const graphics_handle &h, const octave_value &m)
 
void add_listener (const octave_value &v, listener_mode mode=GCB_POSTSET)
 
base_property * clone (void) const
 
void delete_listener (const octave_value &v=octave_value(), listener_mode mode=GCB_POSTSET)
 
OCTINTERP_API void execute (const octave_value &data=octave_value()) const
 
octave_value get (void) const
 
int get_id (void) const
 
std::string get_name (void) const
 
graphics_handle get_parent (void) const
 
bool is_defined (void) const
 
bool is_hidden (void) const
 
virtual bool is_radio (void) const
 
bool ok (void) const
 
callback_property & operator= (const octave_value &val)
 
OCTINTERP_API void run_listeners (listener_mode mode=GCB_POSTSET)
 
OCTINTERP_API bool set (const octave_value &v, bool do_run=true, bool do_notify_toolkit=true)
 
void set_hidden (bool flag)
 
void set_id (int d)
 
void set_name (const std::string &s)
 
void set_parent (const graphics_handle &h)
 
virtual Cell values_as_cell (void) const
 
virtual std::string values_as_string (void) const
 

Protected Member Functions

bool do_set (const octave_value &v)
 

Private Types

typedef std::map< listener_mode, octave_value_list > listener_map
 
typedef std::map< listener_mode, octave_value_list >::const_iterator listener_map_const_iterator
 
typedef std::map< listener_mode, octave_value_list >::iterator listener_map_iterator
 

Private Member Functions

OCTINTERP_API bool validate (const octave_value &v) const
 

Private Attributes

octave_value callback
 
octave::refcount< octave_idx_type > count
 
bool hidden
 
int id
 
listener_map listeners
 
std::string name
 
graphics_handle parent
 

Detailed Description

Definition at line 1902 of file graphics.in.h.

Member Typedef Documentation

◆ listener_map

typedef std::map<listener_mode, octave_value_list> base_property::listener_map
privateinherited

Definition at line 416 of file graphics.in.h.

◆ listener_map_const_iterator

typedef std::map<listener_mode, octave_value_list>::const_iterator base_property::listener_map_const_iterator
privateinherited

Definition at line 420 of file graphics.in.h.

◆ listener_map_iterator

typedef std::map<listener_mode, octave_value_list>::iterator base_property::listener_map_iterator
privateinherited

Definition at line 418 of file graphics.in.h.

Constructor & Destructor Documentation

◆ callback_property() [1/2]

callback_property::callback_property ( const std::string &  nm,
const graphics_handle &  h,
const octave_value &  m 
)
inline

Definition at line 1905 of file graphics.in.h.

Referenced by clone().

◆ callback_property() [2/2]

callback_property::callback_property ( const callback_property &  p)
inline

Definition at line 1909 of file graphics.in.h.

Member Function Documentation

◆ add_listener()

void base_property::add_listener ( const octave_value &  v,
listener_mode  mode = GCB_POSTSET 
)
inlineinherited

Definition at line 347 of file graphics.in.h.

References octave_value_list::length(), base_property::listeners, and octave_value_list::resize().

Referenced by property::add_listener().

◆ clone()

base_property* callback_property::clone ( void  ) const
inlinevirtual

Reimplemented from base_property.

Definition at line 1927 of file graphics.in.h.

References callback_property().

◆ delete_listener()

void base_property::delete_listener ( const octave_value &  v = octave_value (),
listener_mode  mode = GCB_POSTSET 
)
inlineinherited

Definition at line 353 of file graphics.in.h.

References GCB_PERSISTENT, octave_value_list::length(), base_property::listeners, and octave_value_list::resize().

Referenced by property::delete_listener().

◆ do_set()

bool callback_property::do_set ( const octave_value &  v)
inlineprotectedvirtual

Reimplemented from base_property.

Definition at line 1930 of file graphics.in.h.

References callback, error(), base_property::get_name(), and validate().

◆ execute()

void callback_property::execute ( const octave_value &  data = octave_value ()) const

Definition at line 1941 of file graphics.cc.

References octave::__get_gh_manager__(), octave::action_container::add_method(), callback, callback_props::contains(), callback_props::erase(), gh_manager::execute_callback(), executing_callbacks, base_property::get_parent(), callback_props::insert(), octave_value::is_defined(), and octave_value::isempty().

◆ get()

octave_value callback_property::get ( void  ) const
inlinevirtual

Reimplemented from base_property.

Definition at line 1912 of file graphics.in.h.

References callback.

◆ get_id()

int base_property::get_id ( void  ) const
inlineinherited

Definition at line 317 of file graphics.in.h.

References base_property::id.

Referenced by property::get_id().

◆ get_name()

std::string base_property::get_name ( void  ) const
inlineinherited

Definition at line 303 of file graphics.in.h.

References base_property::name.

Referenced by string_array_property::string_array_property(), double_radio_property::current_value(), radio_property::do_set(), color_property::do_set(), double_property::do_set(), double_radio_property::do_set(), array_property::do_set(), handle_property::do_set(), do_set(), string_property::do_set(), string_array_property::do_set(), text_label_property::do_set(), double_radio_property::double_value(), property::get_name(), and array_property::validate().

◆ get_parent()

graphics_handle base_property::get_parent ( void  ) const
inlineinherited

Definition at line 307 of file graphics.in.h.

References base_property::parent.

Referenced by execute(), and property::get_parent().

◆ is_defined()

bool callback_property::is_defined ( void  ) const
inline

Definition at line 1916 of file graphics.in.h.

References callback, octave_value::is_defined(), and octave_value::isempty().

◆ is_hidden()

bool base_property::is_hidden ( void  ) const
inlineinherited

Definition at line 311 of file graphics.in.h.

References base_property::hidden.

Referenced by property::is_hidden().

◆ is_radio()

virtual bool base_property::is_radio ( void  ) const
inlinevirtualinherited

Reimplemented in double_radio_property, color_property, and radio_property.

Definition at line 315 of file graphics.in.h.

Referenced by property::is_radio().

◆ ok()

bool base_property::ok ( void  ) const
inlineinherited

Definition at line 301 of file graphics.in.h.

References octave_handle::ok(), and base_property::parent.

Referenced by property::ok().

◆ operator=()

callback_property& callback_property::operator= ( const octave_value &  val)
inline

Definition at line 1921 of file graphics.in.h.

References base_property::set().

◆ run_listeners()

void base_property::run_listeners ( listener_mode  mode = GCB_POSTSET)
inherited

Definition at line 1283 of file graphics.cc.

References octave::__get_gh_manager__(), gh_manager::execute_listener(), octave_value_list::length(), base_property::listeners, and base_property::parent.

Referenced by property::run_listeners(), and base_property::set().

◆ set()

bool base_property::set ( const octave_value &  v,
bool  do_run = true,
bool  do_notify_toolkit = true 
)
inherited

Definition at line 1257 of file graphics.cc.

References octave::__get_gh_manager__(), base_property::do_set(), GCB_POSTSET, gh_manager::get_object(), base_property::parent, base_property::run_listeners(), and graphics_object::update().

Referenced by base_property::operator=(), string_property::operator=(), string_array_property::operator=(), text_label_property::operator=(), radio_property::operator=(), color_property::operator=(), double_property::operator=(), double_radio_property::operator=(), array_property::operator=(), row_vector_property::operator=(), bool_property::operator=(), handle_property::operator=(), any_property::operator=(), children_property::operator=(), operator=(), and property::set().

◆ set_hidden()

void base_property::set_hidden ( bool  flag)
inlineinherited

Definition at line 313 of file graphics.in.h.

References base_property::hidden.

Referenced by property::set_hidden().

◆ set_id()

void base_property::set_id ( int  d)
inlineinherited

Definition at line 319 of file graphics.in.h.

References d.

Referenced by property::set_id().

◆ set_name()

void base_property::set_name ( const std::string &  s)
inlineinherited

Definition at line 305 of file graphics.in.h.

References base_property::name.

Referenced by property::set_name().

◆ set_parent()

void base_property::set_parent ( const graphics_handle &  h)
inlineinherited

Definition at line 309 of file graphics.in.h.

References base_property::parent.

Referenced by property::set_parent().

◆ validate()

bool callback_property::validate ( const octave_value &  v) const
private

Definition at line 1878 of file graphics.cc.

References octave_value::cell_value(), octave_value::columns(), octave_value::is_function_handle(), octave_value::is_string(), octave_value::iscell(), octave_value::isempty(), and octave_value::rows().

Referenced by do_set().

◆ values_as_cell()

virtual Cell base_property::values_as_cell ( void  ) const
inlinevirtualinherited

Reimplemented in color_property, and radio_property.

Definition at line 336 of file graphics.in.h.

References error(), and base_property::name.

Referenced by property::values_as_cell().

◆ values_as_string()

virtual std::string base_property::values_as_string ( void  ) const
inlinevirtualinherited

Reimplemented in color_property, and radio_property.

Definition at line 331 of file graphics.in.h.

References error(), and base_property::name.

Referenced by property::values_as_string().

Member Data Documentation

◆ callback

octave_value callback_property::callback
private

Definition at line 1945 of file graphics.in.h.

Referenced by do_set(), execute(), get(), and is_defined().

◆ count

octave::refcount<octave_idx_type> base_property::count
privateinherited

Definition at line 424 of file graphics.in.h.

Referenced by property::property(), property::~property(), and property::operator=().

◆ hidden

bool base_property::hidden
privateinherited

Definition at line 427 of file graphics.in.h.

Referenced by base_property::is_hidden(), and base_property::set_hidden().

◆ id

int base_property::id
privateinherited

Definition at line 423 of file graphics.in.h.

Referenced by base_property::get_id().

◆ listeners

listener_map base_property::listeners
privateinherited

Definition at line 428 of file graphics.in.h.

Referenced by base_property::add_listener(), base_property::delete_listener(), and base_property::run_listeners().

◆ name

std::string base_property::name
privateinherited

Definition at line 425 of file graphics.in.h.

Referenced by base_property::do_set(), base_property::get(), base_property::get_name(), base_property::set_name(), base_property::values_as_cell(), and base_property::values_as_string().

◆ parent

graphics_handle base_property::parent
privateinherited

Definition at line 426 of file graphics.in.h.

Referenced by base_property::get_parent(), base_property::ok(), base_property::run_listeners(), base_property::set(), and base_property::set_parent().

The documentation for this class was generated from the following files: