base_properties Class Reference

#include <graphics.h>

Inherited by axes::axes::properties, figure::figure::properties, hggroup::hggroup::properties, image::image::properties, line::line::properties, patch::patch::properties, root_figure::root_figure::properties, surface::surface::properties, and text::text::properties.

Collaboration diagram for base_properties:

[legend]

List of all members.

Classes
struct	cmp_caseless_str
Public Types
enum	{   BEINGDELETED = 0, BUSYACTION = 1, BUTTONDOWNFCN = 2, CHILDREN = 3,   CLIPPING = 4, CREATEFCN = 5, DELETEFCN = 6, HANDLEVISIBILITY = 7,   HITTEST = 8, INTERRUPTIBLE = 9, PARENT = 10, SELECTED = 11,   SELECTIONHIGHLIGHT = 12, TAG = 13, TYPE = 14, USERDATA = 15,   VISIBLE = 16, __MODIFIED__ = 17, __MYHANDLE__ = 18, UICONTEXTMENU = 19 }
Public Member Functions
	base_properties (const std::string &ty="unknown", const graphics_handle &mh=graphics_handle(), const graphics_handle &p=graphics_handle())
virtual	~base_properties (void)
virtual std::string	graphics_object_name (void) const
void	mark_modified (void)
void	override_defaults (base_graphics_object &obj)
void	set_from_list (base_graphics_object &obj, property_list &defaults)
void	insert_property (const std::string &name, property p)
virtual void	set (const caseless_str &, const octave_value &)
void	set (const caseless_str &pname, const std::string &cname, const octave_value &val)
virtual octave_value	get (const caseless_str &pname) const
virtual octave_value	get (const std::string &pname) const
virtual octave_value	get (const char *pname) const
virtual octave_value	get (bool all=false) const
virtual property	get_property (const caseless_str &pname)
virtual bool	has_property (const caseless_str &) const
bool	is_modified (void) const
virtual void	remove_child (const graphics_handle &h)
virtual void	adopt (const graphics_handle &h)
virtual graphics_backend	get_backend (void) const
virtual Matrix	get_boundingbox (bool=false) const
virtual void	update_boundingbox (void)
virtual void	add_listener (const caseless_str &, const octave_value &, listener_mode=POSTSET)
virtual void	delete_listener (const caseless_str &, const octave_value &, listener_mode=POSTSET)
void	set_tag (const octave_value &val)
void	set_parent (const octave_value &val)
Matrix	get_all_children (void) const
void	set_children (const octave_value &val)
void	set_modified (const octave_value &val)
void	set___modified__ (const octave_value &val)
void	reparent (const graphics_handle &new_parent)
virtual void	update_axis_limits (const std::string &axis_type) const
virtual void	delete_children (void)
virtual octave_value	get_xlim (void) const
virtual octave_value	get_ylim (void) const
virtual octave_value	get_zlim (void) const
virtual octave_value	get_clim (void) const
virtual octave_value	get_alim (void) const
virtual bool	is_xliminclude (void) const
virtual bool	is_yliminclude (void) const
virtual bool	is_zliminclude (void) const
virtual bool	is_climinclude (void) const
virtual bool	is_aliminclude (void) const
bool	is_handle_visible (void) const
std::set< std::string >	all_property_names (const std::string &cname) const
bool	is_beingdeleted (void) const
std::string	get_beingdeleted (void) const
bool	busyaction_is (const std::string &v) const
std::string	get_busyaction (void) const
void	execute_buttondownfcn (const octave_value &data=octave_value()) const
octave_value	get_buttondownfcn (void) const
Matrix	get_children (void) const
bool	is_clipping (void) const
std::string	get_clipping (void) const
void	execute_createfcn (const octave_value &data=octave_value()) const
octave_value	get_createfcn (void) const
void	execute_deletefcn (const octave_value &data=octave_value()) const
octave_value	get_deletefcn (void) const
bool	handlevisibility_is (const std::string &v) const
std::string	get_handlevisibility (void) const
bool	is_hittest (void) const
std::string	get_hittest (void) const
bool	is_interruptible (void) const
std::string	get_interruptible (void) const
graphics_handle	get_parent (void) const
bool	is_selected (void) const
std::string	get_selected (void) const
bool	is_selectionhighlight (void) const
std::string	get_selectionhighlight (void) const
std::string	get_tag (void) const
std::string	get_type (void) const
octave_value	get_userdata (void) const
bool	is_visible (void) const
std::string	get_visible (void) const
bool	is___modified__ (void) const
std::string	get___modified__ (void) const
graphics_handle	get___myhandle__ (void) const
graphics_handle	get_uicontextmenu (void) const
void	set_beingdeleted (const octave_value &val)
void	set_busyaction (const octave_value &val)
void	set_buttondownfcn (const octave_value &val)
void	set_clipping (const octave_value &val)
void	set_createfcn (const octave_value &val)
void	set_deletefcn (const octave_value &val)
void	set_handlevisibility (const octave_value &val)
void	set_hittest (const octave_value &val)
void	set_interruptible (const octave_value &val)
void	set_selected (const octave_value &val)
void	set_selectionhighlight (const octave_value &val)
void	set_userdata (const octave_value &val)
void	set_visible (const octave_value &val)
void	set_uicontextmenu (const octave_value &val)
Static Public Member Functions
static property_list::pval_map_type	factory_defaults (void)
static std::set< std::string >	dynamic_property_names (const std::string &cname)
static bool	has_dynamic_property (const std::string &pname, const std::string &cname)
static std::set< std::string >	core_property_names (void)
static bool	has_core_property (const caseless_str &pname)
Static Public Attributes
static std::map< std::string, std::set< std::string > >	all_dynamic_properties
Protected Member Functions
void	set_dynamic (const caseless_str &pname, const std::string &cname, const octave_value &val)
octave_value	get_dynamic (const caseless_str &pname) const
octave_value	get_dynamic (bool all=false) const
	get_property_dynamic (const caseless_str &pname)
void	insert_static_property (const std::string &name, base_property &p)
virtual void	init (void)
Protected Attributes
bool_property	beingdeleted
radio_property	busyaction
callback_property	buttondownfcn
Matrix	children
bool_property	clipping
callback_property	createfcn
callback_property	deletefcn
radio_property	handlevisibility
bool_property	hittest
bool_property	interruptible
handle_property	parent
bool_property	selected
bool_property	selectionhighlight
string_property	tag
string_property	type
any_property	userdata
bool_property	visible
bool_property	__modified__
graphics_handle	__myhandle__
handle_property	uicontextmenu
std::map< caseless_str, property, cmp_caseless_str >	all_props

---

Member Enumeration Documentation

anonymous enum

Enumerator:

BEINGDELETED
BUSYACTION
BUTTONDOWNFCN
CHILDREN
CLIPPING
CREATEFCN
DELETEFCN
HANDLEVISIBILITY
HITTEST
INTERRUPTIBLE
PARENT
SELECTED
SELECTIONHIGHLIGHT
TAG
TYPE
USERDATA
VISIBLE
__MODIFIED__
__MYHANDLE__
UICONTEXTMENU

---

Constructor & Destructor Documentation

base_properties::base_properties	(	const std::string &	ty = "unknown",
		const graphics_handle &	mh = graphics_handle (),
		const graphics_handle &	p = graphics_handle ()
	)

virtual base_properties::~base_properties

(

void

)

[inline, virtual]

---

Member Function Documentation

void base_properties::add_listener	(	const caseless_str &	nm,
		const octave_value &	v,
		listener_mode	mode = POSTSET
	)			[virtual]

virtual void base_properties::adopt

(

const graphics_handle &

h

)

[inline, virtual]

Reimplemented in hggroup::hggroup::properties.

std::set< std::string > base_properties::all_property_names

(

const std::string &

cname

)

const

bool base_properties::busyaction_is

(

const std::string &

v

)

const [inline]

std::set< std::string > base_properties::core_property_names

(

void

)

[static]

Reimplemented in root_figure::root_figure::properties, figure::figure::properties, axes::axes::properties, line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

void base_properties::delete_children

(

void

)

[virtual]

void base_properties::delete_listener	(	const caseless_str &	nm,
		const octave_value &	v,
		listener_mode	mode = POSTSET
	)			[virtual]

std::set< std::string > base_properties::dynamic_property_names

(

const std::string &

cname

)

[static]

void base_properties::execute_buttondownfcn

(

const octave_value &

data = octave_value ()

)

const [inline]

Reimplemented in figure::figure::properties.

void base_properties::execute_createfcn

(

const octave_value &

data = octave_value ()

)

const [inline]

void base_properties::execute_deletefcn

(

const octave_value &

data = octave_value ()

)

const [inline]

property_list::pval_map_type base_properties::factory_defaults

(

void

)

[static]

Reimplemented in root_figure::root_figure::properties, figure::figure::properties, axes::axes::properties, line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

octave_value base_properties::get

(

bool

all = false

)

const [virtual]

Reimplemented in root_figure::root_figure::properties, figure::figure::properties, axes::axes::properties, line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

virtual octave_value base_properties::get

(

const char *

pname

)

const [inline, virtual]

Reimplemented in root_figure::root_figure::properties, figure::figure::properties, axes::axes::properties, line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

virtual octave_value base_properties::get

(

const std::string &

pname

)

const [inline, virtual]

Reimplemented in root_figure::root_figure::properties, figure::figure::properties, axes::axes::properties, line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

octave_value base_properties::get

(

const caseless_str &

pname

)

const [virtual]

Reimplemented in root_figure::root_figure::properties, figure::figure::properties, axes::axes::properties, line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

std::string base_properties::get___modified__

(

void

)

const [inline]

graphics_handle base_properties::get___myhandle__

(

void

)

const [inline]

virtual octave_value base_properties::get_alim

(

void

)

const [inline, virtual]

Reimplemented in axes::axes::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

Matrix base_properties::get_all_children

(

void

)

const [inline]

graphics_backend base_properties::get_backend

(

void

)

const [virtual]

Reimplemented in figure::figure::properties.

std::string base_properties::get_beingdeleted

(

void

)

const [inline]

virtual Matrix base_properties::get_boundingbox

(

bool

= false

)

const [inline, virtual]

Reimplemented in figure::figure::properties, and axes::axes::properties.

std::string base_properties::get_busyaction

(

void

)

const [inline]

octave_value base_properties::get_buttondownfcn

(

void

)

const [inline]

Reimplemented in figure::figure::properties.

Matrix base_properties::get_children

(

void

)

const

virtual octave_value base_properties::get_clim

(

void

)

const [inline, virtual]

Reimplemented in axes::axes::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

std::string base_properties::get_clipping

(

void

)

const [inline]

octave_value base_properties::get_createfcn

(

void

)

const [inline]

octave_value base_properties::get_deletefcn

(

void

)

const [inline]

octave_value base_properties::get_dynamic

(

bool

all = false

)

const [protected]

octave_value base_properties::get_dynamic

(

const caseless_str &

pname

)

const [protected]

std::string base_properties::get_handlevisibility

(

void

)

const [inline]

std::string base_properties::get_hittest

(

void

)

const [inline]

std::string base_properties::get_interruptible

(

void

)

const [inline]

graphics_handle base_properties::get_parent

(

void

)

const [inline]

base_properties::get_property

(

const caseless_str &

pname

)

[virtual]

Reimplemented in root_figure::root_figure::properties, figure::figure::properties, axes::axes::properties, line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

base_properties::get_property_dynamic

(

const caseless_str &

pname

)

[protected]

std::string base_properties::get_selected

(

void

)

const [inline]

std::string base_properties::get_selectionhighlight

(

void

)

const [inline]

std::string base_properties::get_tag

(

void

)

const [inline]

std::string base_properties::get_type

(

void

)

const [inline]

graphics_handle base_properties::get_uicontextmenu

(

void

)

const [inline]

octave_value base_properties::get_userdata

(

void

)

const [inline]

std::string base_properties::get_visible

(

void

)

const [inline]

virtual octave_value base_properties::get_xlim

(

void

)

const [inline, virtual]

Reimplemented in axes::axes::properties, line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

virtual octave_value base_properties::get_ylim

(

void

)

const [inline, virtual]

Reimplemented in axes::axes::properties, line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

virtual octave_value base_properties::get_zlim

(

void

)

const [inline, virtual]

Reimplemented in axes::axes::properties, line::line::properties, text::text::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

virtual std::string base_properties::graphics_object_name

(

void

)

const [inline, virtual]

Reimplemented in root_figure::root_figure::properties, figure::figure::properties, axes::axes::properties, line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

bool base_properties::handlevisibility_is

(

const std::string &

v

)

const [inline]

bool base_properties::has_core_property

(

const caseless_str &

pname

)

[static]

Reimplemented in root_figure::root_figure::properties, figure::figure::properties, axes::axes::properties, line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

bool base_properties::has_dynamic_property	(	const std::string &	pname,
		const std::string &	cname
	)			[static]

virtual bool base_properties::has_property

(

const caseless_str &

)

const [inline, virtual]

Reimplemented in root_figure::root_figure::properties, figure::figure::properties, axes::axes::properties, line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

virtual void base_properties::init

(

void

)

[inline, protected, virtual]

Reimplemented in figure::figure::properties, axes::axes::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

void base_properties::insert_property	(	const std::string &	name,
		property	p
	)			[inline]

void base_properties::insert_static_property	(	const std::string &	name,
		base_property &	p
	)			[inline, protected]

bool base_properties::is___modified__

(

void

)

const [inline]

virtual bool base_properties::is_aliminclude

(

void

)

const [inline, virtual]

Reimplemented in patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

bool base_properties::is_beingdeleted

(

void

)

const [inline]

virtual bool base_properties::is_climinclude

(

void

)

const [inline, virtual]

Reimplemented in image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

bool base_properties::is_clipping

(

void

)

const [inline]

bool base_properties::is_handle_visible

(

void

)

const [inline]

bool base_properties::is_hittest

(

void

)

const [inline]

bool base_properties::is_interruptible

(

void

)

const [inline]

bool base_properties::is_modified

(

void

)

const [inline]

bool base_properties::is_selected

(

void

)

const [inline]

bool base_properties::is_selectionhighlight

(

void

)

const [inline]

bool base_properties::is_visible

(

void

)

const [inline]

virtual bool base_properties::is_xliminclude

(

void

)

const [inline, virtual]

Reimplemented in line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

virtual bool base_properties::is_yliminclude

(

void

)

const [inline, virtual]

Reimplemented in line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

virtual bool base_properties::is_zliminclude

(

void

)

const [inline, virtual]

Reimplemented in line::line::properties, text::text::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

void base_properties::mark_modified

(

void

)

void base_properties::override_defaults

(

base_graphics_object &

obj

)

void base_properties::remove_child

(

const graphics_handle &

h

)

[virtual]

Reimplemented in root_figure::root_figure::properties, figure::figure::properties, axes::axes::properties, and hggroup::hggroup::properties.

void base_properties::reparent

(

const graphics_handle &

new_parent

)

[inline]

void base_properties::set	(	const caseless_str &	pname,
		const std::string &	cname,
		const octave_value &	val
	)

virtual void base_properties::set	(	const caseless_str &	,
		const octave_value &
	)			[inline, virtual]

Reimplemented in root_figure::root_figure::properties, figure::figure::properties, axes::axes::properties, line::line::properties, text::text::properties, image::image::properties, patch::patch::properties, surface::surface::properties, and hggroup::hggroup::properties.

void base_properties::set___modified__

(

const octave_value &

val

)

[inline]

void base_properties::set_beingdeleted

(

const octave_value &

val

)

[inline]

void base_properties::set_busyaction

(

const octave_value &

val

)

[inline]

void base_properties::set_buttondownfcn

(

const octave_value &

val

)

[inline]

Reimplemented in figure::figure::properties.

void base_properties::set_children

(

const octave_value &

val

)

void base_properties::set_clipping

(

const octave_value &

val

)

[inline]

void base_properties::set_createfcn

(

const octave_value &

val

)

[inline]

void base_properties::set_deletefcn

(

const octave_value &

val

)

[inline]

void base_properties::set_dynamic	(	const caseless_str &	pname,
		const std::string &	cname,
		const octave_value &	val
	)			[protected]

void base_properties::set_from_list	(	base_graphics_object &	obj,
		property_list &	defaults
	)

void base_properties::set_handlevisibility

(

const octave_value &

val

)

[inline]

void base_properties::set_hittest

(

const octave_value &

val

)

[inline]

void base_properties::set_interruptible

(

const octave_value &

val

)

[inline]

void base_properties::set_modified

(

const octave_value &

val

)

[inline]

void base_properties::set_parent

(

const octave_value &

val

)

void base_properties::set_selected

(

const octave_value &

val

)

[inline]

void base_properties::set_selectionhighlight

(

const octave_value &

val

)

[inline]

void base_properties::set_tag

(

const octave_value &

val

)

[inline]

void base_properties::set_uicontextmenu

(

const octave_value &

val

)

[inline]

void base_properties::set_userdata

(

const octave_value &

val

)

[inline]

void base_properties::set_visible

(

const octave_value &

val

)

[inline]

Reimplemented in figure::figure::properties.

void base_properties::update_axis_limits

(

const std::string &

axis_type

)

const [virtual]

void base_properties::update_boundingbox

(

void

)

[virtual]

Reimplemented in axes::axes::properties.

---

Member Data Documentation

bool_property base_properties::__modified__ [protected]

graphics_handle base_properties::__myhandle__ [protected]

std::map< std::string, std::set< std::string > > base_properties::all_dynamic_properties [static]

std::map<caseless_str, property, cmp_caseless_str> base_properties::all_props [protected]

bool_property base_properties::beingdeleted [protected]

radio_property base_properties::busyaction [protected]

callback_property base_properties::buttondownfcn [protected]

Matrix base_properties::children [protected]

bool_property base_properties::clipping [protected]

callback_property base_properties::createfcn [protected]

callback_property base_properties::deletefcn [protected]

radio_property base_properties::handlevisibility [protected]

bool_property base_properties::hittest [protected]

bool_property base_properties::interruptible [protected]

handle_property base_properties::parent [protected]

bool_property base_properties::selected [protected]

bool_property base_properties::selectionhighlight [protected]

string_property base_properties::tag [protected]

string_property base_properties::type [protected]

handle_property base_properties::uicontextmenu [protected]

any_property base_properties::userdata [protected]

bool_property base_properties::visible [protected]

---

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

• graphics.h
• graphics-props.cc
• graphics.cc