base_property Class Reference

#include "graphics.in.h"

Inheritance diagram for base_property:

Collaboration diagram for base_property:

Public Member Functions
	base_property (const base_property &p)
	base_property (const std::string &s, const graphics_handle &h)
	base_property (void)
virtual	~base_property (void)=default
void	add_listener (const octave_value &v, listener_mode mode=GCB_POSTSET)
virtual base_property *	clone (void) const
void	delete_listener (const octave_value &v=octave_value(), listener_mode mode=GCB_POSTSET)
virtual octave_value	get (void) const
int	get_id (void) const
std::string	get_name (void) const
graphics_handle	get_parent (void) const
bool	is_hidden (void) const
virtual bool	is_radio (void) const
bool	ok (void) const
base_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
virtual bool	do_set (const octave_value &)

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 Attributes
octave::refcount< octave_idx_type >	count
bool	hidden
int	id
listener_map	listeners
std::string	name
graphics_handle	parent

Friends
class	property

Detailed Description

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

Member Typedef Documentation

listener_map

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

private

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

private

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

private

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

Constructor & Destructor Documentation

base_property() [1/3]

base_property::base_property ( void  )

inline

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

Referenced by clone().

base_property() [2/3]

base_property::base_property ( const std::string &  s, const graphics_handle &  h  )

inline

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

base_property() [3/3]

base_property::base_property ( const base_property &  p )

inline

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

~base_property()

virtual base_property::~base_property ( void  )

virtualdefault

Member Function Documentation

add_listener()

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

inline

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

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

Referenced by property::add_listener().

clone()

virtual base_property* base_property::clone ( void  ) const

inlinevirtual

Reimplemented in callback_property, children_property, any_property, handle_property, bool_property, row_vector_property, array_property, double_radio_property, double_property, color_property, radio_property, text_label_property, string_array_property, and string_property.

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

References base_property().

Referenced by property::clone().

delete_listener()

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

inline

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

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

Referenced by property::delete_listener().

do_set()

virtual bool base_property::do_set ( const octave_value &  )

inlineprotectedvirtual

Reimplemented in children_property, bool_property, text_label_property, string_array_property, string_property, callback_property, any_property, handle_property, row_vector_property, array_property, double_radio_property, double_property, color_property, and radio_property.

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

References error(), and name.

Referenced by set().

get()

virtual octave_value base_property::get ( void  ) const

inlinevirtual

Reimplemented in callback_property, children_property, any_property, handle_property, array_property, double_radio_property, double_property, color_property, radio_property, text_label_property, string_array_property, and string_property.

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

References error(), and name.

Referenced by property::get().

get_id()

int base_property::get_id ( void  ) const

inline

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

References id.

Referenced by property::get_id().

get_name()

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

inline

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

References 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(), callback_property::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

inline

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

References parent.

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

is_hidden()

bool base_property::is_hidden ( void  ) const

inline

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

References hidden.

Referenced by property::is_hidden().

is_radio()

virtual bool base_property::is_radio ( void  ) const

inlinevirtual

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

inline

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

References octave_handle::ok(), and parent.

Referenced by property::ok().

operator=()

base_property& base_property::operator= ( const octave_value &  val )

inline

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

References set().

run_listeners()

void base_property::run_listeners

(

listener_mode

mode = GCB_POSTSET

)

Definition at line 1283 of file graphics.cc.

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

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

set()

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

Definition at line 1257 of file graphics.cc.

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

Referenced by 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=(), callback_property::operator=(), and property::set().

set_hidden()

void base_property::set_hidden ( bool  flag )

inline

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

References hidden.

Referenced by property::set_hidden().

set_id()

void base_property::set_id ( int  d )

inline

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 )

inline

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

References name.

Referenced by property::set_name().

set_parent()

void base_property::set_parent ( const graphics_handle &  h )

inline

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

References parent.

Referenced by property::set_parent().

values_as_cell()

virtual Cell base_property::values_as_cell ( void  ) const

inlinevirtual

Reimplemented in color_property, and radio_property.

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

References error(), and name.

Referenced by property::values_as_cell().

values_as_string()

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

inlinevirtual

Reimplemented in color_property, and radio_property.

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

References error(), and name.

Referenced by property::values_as_string().

Friends And Related Function Documentation

property

friend class property

friend

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

Member Data Documentation

count

octave::refcount<octave_idx_type> base_property::count

private

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

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

hidden

bool base_property::hidden

private

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

Referenced by is_hidden(), and set_hidden().

id

int base_property::id

private

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

Referenced by get_id().

listeners

listener_map base_property::listeners

private

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

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

name

std::string base_property::name

private

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

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

parent

graphics_handle base_property::parent

private

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

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

---

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

• libinterp/corefcn/graphics.in.h
• libinterp/corefcn/graphics.cc