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 | Protected Attributes | Friends | List of all members
base_graphics_object Class Reference

#include "graphics.in.h"

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

Public Member Functions

 base_graphics_object (const base_graphics_object &)=delete
 
 base_graphics_object (void)
 
virtual ~base_graphics_object (void)=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 (void) 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 (const caseless_str &pname) const
 
virtual octave_value get_default (const caseless_str &) const
 
virtual octave_value get_defaults (void) const
 
virtual property_list get_defaults_list (void) const
 
virtual octave_value get_factory_default (const caseless_str &) const
 
virtual octave_value get_factory_defaults (void) const
 
virtual property_list get_factory_defaults_list (void) const
 
graphics_handle get_handle (void) const
 
virtual graphics_handle get_parent (void) const
 
virtual base_properties & get_properties (void)
 
virtual const base_properties & get_properties (void) const
 
virtual octave::graphics_toolkit get_toolkit (void) const
 
virtual bool has_readonly_property (const caseless_str &pname) const
 
bool isa (const std::string &go_name) const
 
virtual void mark_modified (void)
 
base_graphics_object & operator= (const base_graphics_object &)=delete
 
virtual void override_defaults (base_graphics_object &obj)
 
virtual void remove_all_listeners (void)
 
virtual void remove_child (const graphics_handle &h, bool from_root=false)
 
virtual void reparent (const graphics_handle &np)
 
virtual void reset_default_properties (void)
 
virtual void set (const caseless_str &pname, const octave_value &pval)
 
virtual void set_defaults (const std::string &)
 
virtual void set_from_list (property_list &plist)
 
virtual std::string type (void) 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)
 
virtual bool valid_object (void) const
 
bool valid_toolkit_object (void) const
 
virtual std::string value_as_string (const std::string &prop)
 
virtual std::string values_as_string (void)
 
virtual octave_scalar_map values_as_struct (void)
 

Protected Member Functions

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

bool toolkit_flag
 

Friends

class graphics_object
 

Detailed Description

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

Constructor & Destructor Documentation

◆ base_graphics_object() [1/2]

base_graphics_object::base_graphics_object ( void  )
inline

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

◆ base_graphics_object() [2/2]

base_graphics_object::base_graphics_object ( const base_graphics_object &  )
delete

◆ ~base_graphics_object()

virtual base_graphics_object::~base_graphics_object ( void  )
virtualdefault

Member Function Documentation

◆ add_property_listener()

virtual void base_graphics_object::add_property_listener ( const std::string &  nm,
const octave_value &  v,
listener_mode  mode = GCB_POSTSET 
)
inlinevirtual

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

◆ adopt()

virtual void base_graphics_object::adopt ( const graphics_handle &  h)
inlinevirtual

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

Referenced by axes::properties::delete_text_child(), reparent(), base_properties::set_parent(), and axes::properties::set_text_child().

◆ build_user_defaults_map()

void base_graphics_object::build_user_defaults_map ( property_list::pval_map_type &  def,
const std::string  go_name 
) const

Definition at line 3742 of file graphics.cc.

References octave::__get_gh_manager__(), graphics_object::build_user_defaults_map(), property_list::end(), property_list::find(), pval_vector::find(), figure::get_defaults_list(), gh_manager::get_object(), and get_parent().

◆ defaults()

virtual void base_graphics_object::defaults ( void  ) const
inlinevirtual

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

Referenced by base_properties::set_from_list().

◆ delete_property_listener()

virtual void base_graphics_object::delete_property_listener ( const std::string &  nm,
const octave_value &  v,
listener_mode  mode = GCB_POSTSET 
)
inlinevirtual

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

◆ finalize()

virtual void base_graphics_object::finalize ( const graphics_object &  go)
inlineprotectedvirtual

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

◆ get() [1/2]

octave_value base_graphics_object::get ( bool  all = false) const
inline

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

Referenced by base_properties::update_uicontextmenu().

◆ get() [2/2]

virtual octave_value base_graphics_object::get ( const caseless_str &  pname) const
inlinevirtual

Reimplemented in uitoolbar, axes, figure, and root_figure.

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

◆ get_default()

octave_value base_graphics_object::get_default ( const caseless_str &  pname) const
virtual

Reimplemented in uitoolbar, axes, figure, and root_figure.

Definition at line 11697 of file graphics.cc.

References octave::__get_gh_manager__(), graphics_object::get_default(), gh_manager::get_object(), get_parent(), and type().

◆ get_defaults()

virtual octave_value base_graphics_object::get_defaults ( void  ) const
inlinevirtual

Reimplemented in uitoolbar, axes, figure, and root_figure.

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

◆ get_defaults_list()

virtual property_list base_graphics_object::get_defaults_list ( void  ) const
inlinevirtual

Reimplemented in uitoolbar, axes, figure, and root_figure.

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

◆ get_factory_default()

octave_value base_graphics_object::get_factory_default ( const caseless_str &  name) const
virtual

Reimplemented in root_figure.

Definition at line 11710 of file graphics.cc.

References octave::__get_gh_manager__(), graphics_object::get_factory_default(), gh_manager::get_object(), name, and type().

Referenced by graphics_object::set_value_or_default().

◆ get_factory_defaults()

virtual octave_value base_graphics_object::get_factory_defaults ( void  ) const
inlinevirtual

Reimplemented in root_figure.

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

◆ get_factory_defaults_list()

virtual property_list base_graphics_object::get_factory_defaults_list ( void  ) const
inlinevirtual

Reimplemented in root_figure.

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

◆ get_handle()

graphics_handle base_graphics_object::get_handle ( void  ) const
inline

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

Referenced by reset_default_properties(), root_figure::reset_default_properties(), figure::reset_default_properties(), patch::reset_default_properties(), uitoolbar::reset_default_properties(), axes::update_axis_limits(), value_as_string(), values_as_string(), and values_as_struct().

◆ get_parent()

virtual graphics_handle base_graphics_object::get_parent ( void  ) const
inlinevirtual

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

Referenced by build_user_defaults_map(), graphics_object::get_ancestor(), axes::properties::get_boundingbox(), uicontrol::properties::get_boundingbox(), uibuttongroup::properties::get_boundingbox(), uipanel::properties::get_boundingbox(), uitable::properties::get_boundingbox(), get_default(), figure::get_default(), axes::get_default(), uitoolbar::get_default(), base_properties::get_toolkit(), base_properties::mark_modified(), base_properties::override_defaults(), base_properties::set_parent(), base_properties::update_autopos(), update_axis_limits(), axes::properties::update_units(), and uicontrol::properties::update_units().

◆ get_properties() [1/2]

virtual base_properties& base_graphics_object::get_properties ( void  )
inlinevirtual

Reimplemented in uitoggletool, uipushtool, uitoolbar, uitable, uipanel, uibuttongroup, uicontrol, uicontextmenu, uimenu, hggroup, surface, patch, light, image, text, line, axes, figure, and root_figure.

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

Referenced by gh_manager::make_graphics_handle().

◆ get_properties() [2/2]

virtual const base_properties& base_graphics_object::get_properties ( void  ) const
inlinevirtual

Reimplemented in uitoggletool, uipushtool, uitoolbar, uitable, uipanel, uibuttongroup, uicontrol, uicontextmenu, uimenu, hggroup, surface, patch, light, image, text, line, axes, figure, and root_figure.

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

◆ get_toolkit()

virtual octave::graphics_toolkit base_graphics_object::get_toolkit ( void  ) const
inlinevirtual

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

◆ has_readonly_property()

virtual bool base_graphics_object::has_readonly_property ( const caseless_str &  pname) const
inlinevirtual

Reimplemented in uitoggletool, uipushtool, uitoolbar, uitable, uipanel, uibuttongroup, uicontrol, uicontextmenu, uimenu, hggroup, surface, patch, light, image, text, line, axes, figure, and root_figure.

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

◆ initialize()

virtual void base_graphics_object::initialize ( const graphics_object &  go)
inlineprotectedvirtual

Reimplemented in patch, light, and axes.

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

Referenced by axes::initialize(), light::initialize(), and patch::initialize().

◆ isa()

bool base_graphics_object::isa ( const std::string &  go_name) const
inline

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

Referenced by graphics_object::get_ancestor().

◆ mark_modified()

virtual void base_graphics_object::mark_modified ( void  )
inlinevirtual

Reimplemented in root_figure.

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

Referenced by figure::properties::set___graphics_toolkit__(), base_properties::set_dynamic(), figure::properties::set_outerposition(), and figure::properties::set_position().

◆ operator=()

base_graphics_object& base_graphics_object::operator= ( const base_graphics_object &  )
delete

◆ override_defaults()

virtual void base_graphics_object::override_defaults ( base_graphics_object &  obj)
inlinevirtual

Reimplemented in uitoolbar, axes, figure, and root_figure.

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

◆ remove_all_listeners()

void base_graphics_object::remove_all_listeners ( void  )
virtual

Definition at line 3708 of file graphics.cc.

References octave::__get_interpreter__(), property::delete_listener(), figure::get(), figure::get_properties(), base_properties::get_property(), interpreter_try(), m, octave_value::map_value(), octave::interpreter::recover_from_exception(), octave::state, and toggle_warn().

Referenced by reset_default_properties(), root_figure::reset_default_properties(), figure::reset_default_properties(), axes::reset_default_properties(), and uitoolbar::reset_default_properties().

◆ remove_child()

virtual void base_graphics_object::remove_child ( const graphics_handle &  h,
bool  from_root = false 
)
inlinevirtual

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

◆ reparent()

virtual void base_graphics_object::reparent ( const graphics_handle &  np)
inlinevirtual

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

Referenced by axes::properties::set_text_child().

◆ reset_default_properties()

void base_graphics_object::reset_default_properties ( void  )
virtual

Reimplemented in uitoolbar, patch, axes, figure, and root_figure.

Definition at line 3768 of file graphics.cc.

References octave::__get_gh_manager__(), property_list::find(), graphics_object::get_factory_defaults_list(), get_handle(), gh_manager::get_object(), remove_all_listeners(), type(), figure::valid_object(), and xreset_default_properties().

◆ set()

virtual void base_graphics_object::set ( const caseless_str &  pname,
const octave_value &  pval 
)
inlinevirtual

Reimplemented in uitoolbar, axes, figure, and root_figure.

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

Referenced by base_properties::set_from_list().

◆ set_defaults()

virtual void base_graphics_object::set_defaults ( const std::string &  )
inlinevirtual

Reimplemented in axes.

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

Referenced by axes::reset_default_properties().

◆ set_from_list()

virtual void base_graphics_object::set_from_list ( property_list &  plist)
inlinevirtual

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

◆ type()

virtual std::string base_graphics_object::type ( void  ) const
inlinevirtual

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

Referenced by get_default(), get_factory_default(), and reset_default_properties().

◆ update()

virtual void base_graphics_object::update ( const graphics_object &  go,
int  id 
)
inlineprotectedvirtual

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

◆ update_axis_limits() [1/2]

void base_graphics_object::update_axis_limits ( const std::string &  axis_type)
virtual

Reimplemented in hggroup, and axes.

Definition at line 3677 of file graphics.cc.

References octave::__get_gh_manager__(), error(), gh_manager::get_object(), get_parent(), graphics_object::update_axis_limits(), and figure::valid_object().

Referenced by axes::properties::adopt(), and hggroup::update_axis_limits().

◆ update_axis_limits() [2/2]

void base_graphics_object::update_axis_limits ( const std::string &  axis_type,
const graphics_handle &  h 
)
virtual

Reimplemented in hggroup, and axes.

Definition at line 3692 of file graphics.cc.

References octave::__get_gh_manager__(), error(), gh_manager::get_object(), get_parent(), graphics_object::update_axis_limits(), and figure::valid_object().

◆ valid_object()

virtual bool base_graphics_object::valid_object ( void  ) const
inlinevirtual

Reimplemented in uitoggletool, uipushtool, uitoolbar, uitable, uipanel, uibuttongroup, uicontrol, uicontextmenu, uimenu, hggroup, surface, patch, light, image, text, line, axes, figure, and root_figure.

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

◆ valid_toolkit_object()

bool base_graphics_object::valid_toolkit_object ( void  ) const
inline

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

◆ value_as_string()

std::string base_graphics_object::value_as_string ( const std::string &  prop)
virtual

Definition at line 3820 of file graphics.cc.

References octave::__get_gh_manager__(), error(), get_handle(), gh_manager::get_object(), figure::get_properties(), base_properties::get_property(), graphics_object::has_readonly_property(), retval, and figure::valid_object().

◆ values_as_string()

std::string base_graphics_object::values_as_string ( void  )
virtual

Definition at line 3784 of file graphics.cc.

References octave::__get_gh_manager__(), error(), figure::get(), get_handle(), gh_manager::get_object(), figure::get_properties(), base_properties::get_property(), graphics_object::has_readonly_property(), m, octave_value::map_value(), retval, and figure::valid_object().

◆ values_as_struct()

octave_scalar_map base_graphics_object::values_as_struct ( void  )
virtual

Definition at line 3850 of file graphics.cc.

References octave::__get_gh_manager__(), Array< T >::assign(), error(), figure::get(), get_handle(), gh_manager::get_object(), figure::get_properties(), base_properties::get_property(), graphics_object::has_readonly_property(), m, retval, octave_value::scalar_map_value(), and figure::valid_object().

Friends And Related Function Documentation

◆ graphics_object

friend class graphics_object
friend

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

Referenced by graphics_object::get_ancestor().

Member Data Documentation

◆ toolkit_flag

bool base_graphics_object::toolkit_flag
protected

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

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