figure Class Reference

#include "graphics.h"

Inheritance diagram for figure:

Classes
class	properties

Public Member Functions
	figure (const graphics_handle &mh, const graphics_handle &p)
	~figure ()=default
octave_value	get (const caseless_str &name) const
octave_value	get_default (const caseless_str &name) const
octave_value	get_defaults () const
property_list	get_defaults_list () const
base_properties &	get_properties ()
const base_properties &	get_properties () const
bool	has_readonly_property (const caseless_str &pname) const
void	override_defaults (base_graphics_object &obj)
void	reset_default_properties ()
void	set (const caseless_str &name, const octave_value &value)
bool	valid_object () const
Public Member Functions inherited from base_graphics_object
	base_graphics_object ()
virtual	~base_graphics_object ()=default
virtual void	add_property_listener (const std::string &nm, const octave_value &v, listener_mode mode=GCB_POSTSET)
virtual void	adopt (const graphics_handle &h)
void	build_user_defaults_map (property_list::pval_map_type &def, const std::string go_name) const
virtual void	defaults () const
virtual void	delete_property_listener (const std::string &nm, const octave_value &v, listener_mode mode=GCB_POSTSET)
octave_value	get (bool all=false) const
virtual octave_value	get_factory_default (const caseless_str &) const
virtual octave_value	get_factory_defaults () const
virtual property_list	get_factory_defaults_list () const
graphics_handle	get_handle () const
virtual graphics_handle	get_parent () const
virtual octave::graphics_toolkit	get_toolkit () const
bool	isa (const std::string &go_name) const
virtual void	mark_modified ()
virtual void	remove_all_listeners ()
virtual void	remove_child (const graphics_handle &h, bool from_root=false)
virtual void	reparent (const graphics_handle &np)
virtual void	set_defaults (const std::string &)
virtual void	set_from_list (property_list &plist)
virtual std::string	type () const
virtual void	update_axis_limits (const std::string &axis_type)
virtual void	update_axis_limits (const std::string &axis_type, const graphics_handle &h)
bool	valid_toolkit_object () const
virtual std::string	value_as_string (const std::string &prop)
virtual std::string	values_as_string ()
virtual octave_scalar_map	values_as_struct ()

Additional Inherited Members
Protected Member Functions inherited from base_graphics_object
virtual void	finalize (const graphics_object &go)
virtual void	initialize (const graphics_object &go)
virtual void	update (const graphics_object &go, int id)
Protected Attributes inherited from base_graphics_object
bool	m_toolkit_flag

Detailed Description

Definition at line 3570 of file graphics.h.

Constructor & Destructor Documentation

figure()

figure::figure ( const graphics_handle &  mh, const graphics_handle &  p  )

inline

Definition at line 4492 of file graphics.h.

~figure()

figure::~figure ( )

default

Member Function Documentation

get()

octave_value figure::get ( const caseless_str &  name ) const

inlinevirtual

Reimplemented from base_graphics_object.

Definition at line 4525 of file graphics.h.

References caseless_str::compare().

Referenced by axes::properties::update_font(), base_graphics_object::values_as_string(), and base_graphics_object::values_as_struct().

get_default()

octave_value figure::get_default ( const caseless_str &  name ) const

virtual

Reimplemented from base_graphics_object.

Definition at line 4683 of file graphics.cc.

References __get_gh_manager__(), graphics_object::get_default(), gh_manager::get_object(), base_graphics_object::get_parent(), octave_value::is_undefined(), and property_list::lookup().

Referenced by graphics_object::set_value_or_default().

get_defaults()

octave_value figure::get_defaults ( ) const

inlinevirtual

Reimplemented from base_graphics_object.

Definition at line 4539 of file graphics.h.

get_defaults_list()

property_list figure::get_defaults_list ( ) const

inlinevirtual

Reimplemented from base_graphics_object.

Definition at line 4544 of file graphics.h.

Referenced by base_graphics_object::build_user_defaults_map().

get_properties() [1/2]

base_properties& figure::get_properties ( )

inlinevirtual

Reimplemented from base_graphics_object.

Definition at line 4549 of file graphics.h.

Referenced by base_graphics_object::value_as_string(), base_graphics_object::values_as_string(), and base_graphics_object::values_as_struct().

get_properties() [2/2]

const base_properties& figure::get_properties ( ) const

inlinevirtual

Reimplemented from base_graphics_object.

Definition at line 4551 of file graphics.h.

has_readonly_property()

bool figure::has_readonly_property ( const caseless_str &  pname ) const

inlinevirtual

Reimplemented from base_graphics_object.

Definition at line 4557 of file graphics.h.

References base_properties::has_readonly_property().

override_defaults()

void figure::override_defaults ( base_graphics_object &  obj )

inlinevirtual

Reimplemented from base_graphics_object.

Definition at line 4500 of file graphics.h.

References base_graphics_object::set_from_list().

reset_default_properties()

void figure::reset_default_properties ( )

virtual

Reimplemented from base_graphics_object.

Definition at line 4702 of file graphics.cc.

References pval_vector::erase(), figure::properties::factory_defaults(), and base_graphics_object::remove_all_listeners().

set()

void figure::set ( const caseless_str &  name, const octave_value &  value  )

inlinevirtual

Reimplemented from base_graphics_object.

Definition at line 4514 of file graphics.h.

References caseless_str::compare().

Referenced by graphics_object::set().

valid_object()

bool figure::valid_object ( ) const

inlinevirtual

Reimplemented from base_graphics_object.

Definition at line 4553 of file graphics.h.

Referenced by graphics_object::get_ancestor(), base_graphics_object::reset_default_properties(), base_graphics_object::update_axis_limits(), base_graphics_object::value_as_string(), base_graphics_object::values_as_string(), and base_graphics_object::values_as_struct().

---

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

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