GNU Octave  9.1.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.h"

Inheritance diagram for base_graphics_object:
axes figure hggroup image light line patch root_figure scatter surface text uibuttongroup uicontextmenu uicontrol uimenu uipanel uipushtool uitable uitoggletool uitoolbar

Public Member Functions

 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 (const caseless_str &pname) const
 
virtual octave_value get_default (const caseless_str &) const
 
virtual octave_value get_defaults () const
 
virtual property_list get_defaults_list () 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 base_properties & get_properties ()
 
virtual const base_properties & get_properties () const
 
virtual octave::graphics_toolkit get_toolkit () const
 
virtual bool has_readonly_property (const caseless_str &pname) const
 
bool isa (const std::string &go_name) const
 
virtual void mark_modified ()
 
virtual void override_defaults (base_graphics_object &obj)
 
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 reset_default_properties ()
 
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 () 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 () const
 
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 ()
 

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 m_toolkit_flag
 

Friends

class graphics_object
 

Detailed Description

Definition at line 2733 of file graphics.h.

Constructor & Destructor Documentation

◆ base_graphics_object()

base_graphics_object::base_graphics_object ( )
inline

Definition at line 2738 of file graphics.h.

◆ ~base_graphics_object()

virtual base_graphics_object::~base_graphics_object ( )
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 2937 of file graphics.h.

References base_properties::add_listener(), graphics_object::get_properties(), and graphics_object::valid_object().

◆ adopt()

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

Definition at line 2870 of file graphics.h.

References base_properties::adopt(), error(), graphics_object::get_properties(), and graphics_object::valid_object().

Referenced by F__go_figure__(), and axes::properties::init().

◆ 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 3405 of file graphics.cc.

References __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 ( ) const
inlinevirtual

Definition at line 2886 of file graphics.h.

References err_not_implemented(), error(), graphics_object::type(), and graphics_object::valid_object().

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 2945 of file graphics.h.

References base_properties::delete_listener(), graphics_object::get_properties(), and graphics_object::valid_object().

◆ finalize()

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

Definition at line 2964 of file graphics.h.

References graphics_object::get_toolkit().

◆ get() [1/2]

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

Definition at line 2786 of file graphics.h.

References error(), base_properties::get(), graphics_object::get_properties(), and graphics_object::valid_object().

◆ 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 2794 of file graphics.h.

References error(), base_properties::get(), graphics_object::get_properties(), and graphics_object::valid_object().

◆ 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 11601 of file graphics.cc.

References __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 ( ) const
inlinevirtual

Reimplemented in uitoolbar, axes, figure, and root_figure.

Definition at line 2806 of file graphics.h.

References error().

◆ get_defaults_list()

virtual property_list base_graphics_object::get_defaults_list ( ) const
inlinevirtual

Reimplemented in uitoolbar, axes, figure, and root_figure.

Definition at line 2811 of file graphics.h.

References error(), and graphics_object::valid_object().

◆ get_factory_default()

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

Reimplemented in root_figure.

Definition at line 11613 of file graphics.cc.

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

Referenced by graphics_object::set_value_or_default().

◆ get_factory_defaults()

virtual octave_value base_graphics_object::get_factory_defaults ( ) const
inlinevirtual

Reimplemented in root_figure.

Definition at line 2819 of file graphics.h.

References error().

◆ get_factory_defaults_list()

virtual property_list base_graphics_object::get_factory_defaults_list ( ) const
inlinevirtual

Reimplemented in root_figure.

Definition at line 2824 of file graphics.h.

References error().

◆ get_handle()

graphics_handle base_graphics_object::get_handle ( ) const
inline

Definition at line 2854 of file graphics.h.

References error(), base_properties::get___myhandle__(), graphics_object::get_properties(), and graphics_object::valid_object().

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

◆ get_parent()

virtual graphics_handle base_graphics_object::get_parent ( ) const
inlinevirtual

Definition at line 2846 of file graphics.h.

References error(), base_properties::get_parent(), graphics_object::get_properties(), and graphics_object::valid_object().

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(), uicontrol::properties::get_extent(), uitable::properties::get_extent(), base_properties::get_toolkit(), base_properties::mark_modified(), base_properties::override_defaults(), figure::properties::set_integerhandle(), base_properties::set_parent(), uicontrol::properties::set_style(), base_properties::update_autopos(), update_axis_limits(), uicontrol::properties::update_units(), axes::properties::update_units(), uibuttongroup::properties::update_units(), uipanel::properties::update_units(), and uitable::properties::update_units().

◆ get_properties() [1/2]

virtual base_properties& base_graphics_object::get_properties ( )
inlinevirtual

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

Definition at line 2895 of file graphics.h.

References warning().

Referenced by gh_manager::make_graphics_handle().

◆ get_properties() [2/2]

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

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

Definition at line 2902 of file graphics.h.

References warning().

◆ get_toolkit()

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

Definition at line 2929 of file graphics.h.

References error(), graphics_object::get_properties(), base_properties::get_toolkit(), and graphics_object::valid_object().

◆ 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, scatter, patch, light, image, text, line, axes, figure, and root_figure.

Definition at line 2829 of file graphics.h.

References base_properties::has_readonly_property().

◆ initialize()

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

Reimplemented in scatter, patch, light, and axes.

Definition at line 2958 of file graphics.h.

References graphics_object::get_toolkit().

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

◆ isa()

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

Definition at line 2924 of file graphics.h.

References graphics_object::type().

Referenced by graphics_object::get_ancestor().

◆ mark_modified()

virtual void base_graphics_object::mark_modified ( )
inlinevirtual

Reimplemented in root_figure.

Definition at line 2744 of file graphics.h.

References error(), graphics_object::get_properties(), base_properties::mark_modified(), and graphics_object::valid_object().

Referenced by figure::properties::set___graphics_toolkit__(), figure::properties::set___mouse_mode__(), uitable::properties::set_columnformat(), uitable::properties::set_columnwidth(), base_properties::set_dynamic(), axes::properties::set_fontunits(), text::properties::set_fontunits(), uicontrol::properties::set_fontunits(), uibuttongroup::properties::set_fontunits(), uipanel::properties::set_fontunits(), uitable::properties::set_fontunits(), figure::properties::set_integerhandle(), figure::properties::set_outerposition(), figure::properties::set_papertype(), figure::properties::set_paperunits(), uibuttongroup::properties::set_position(), uipanel::properties::set_position(), figure::properties::set_position(), uibuttongroup::properties::set_selectedobject(), figure::properties::set_units(), axes::properties::set_units(), uibuttongroup::properties::set_units(), uipanel::properties::set_units(), and uitable::properties::set_units().

◆ 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 2752 of file graphics.h.

References error(), graphics_object::get_properties(), base_properties::override_defaults(), and graphics_object::valid_object().

◆ remove_all_listeners()

void base_graphics_object::remove_all_listeners ( )
virtual

Definition at line 3372 of file graphics.cc.

Referenced by reset_default_properties(), root_figure::reset_default_properties(), figure::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 2862 of file graphics.h.

References error(), graphics_object::get_properties(), base_properties::remove_child(), and graphics_object::valid_object().

◆ reparent()

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

Definition at line 2878 of file graphics.h.

References error(), graphics_object::get_properties(), base_properties::reparent(), and graphics_object::valid_object().

◆ reset_default_properties()

void base_graphics_object::reset_default_properties ( )
virtual

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

Definition at line 3431 of file graphics.cc.

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

◆ 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 2770 of file graphics.h.

References error(), graphics_object::get_properties(), base_properties::set(), and graphics_object::valid_object().

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 2778 of file graphics.h.

References error().

◆ set_from_list()

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

Definition at line 2762 of file graphics.h.

References error(), graphics_object::get_properties(), base_properties::set_from_list(), and graphics_object::valid_object().

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

◆ type()

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

Definition at line 2918 of file graphics.h.

References graphics_object::get_properties(), and graphics_object::valid_object().

Referenced by Faddproperty(), 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 2973 of file graphics.h.

References graphics_object::get_toolkit().

◆ 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 3343 of file graphics.cc.

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

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

◆ 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 3357 of file graphics.cc.

References __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 ( ) const
inlinevirtual

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

Definition at line 2914 of file graphics.h.

◆ valid_toolkit_object()

bool base_graphics_object::valid_toolkit_object ( ) const
inline

Definition at line 2916 of file graphics.h.

◆ value_as_string()

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

Definition at line 3481 of file graphics.cc.

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

◆ values_as_string()

std::string base_graphics_object::values_as_string ( )
virtual

Definition at line 3446 of file graphics.cc.

References __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(), figure::valid_object(), and property::values_as_string().

◆ values_as_struct()

octave_scalar_map base_graphics_object::values_as_struct ( )
virtual

Definition at line 3510 of file graphics.cc.

References __get_gh_manager__(), octave_scalar_map::assign(), error(), figure::get(), get_handle(), gh_manager::get_object(), figure::get_properties(), base_properties::get_property(), graphics_object::has_readonly_property(), m, octave_value::scalar_map_value(), and figure::valid_object().

Friends And Related Function Documentation

◆ graphics_object

friend class graphics_object
friend

Definition at line 2736 of file graphics.h.

Referenced by graphics_object::get_ancestor().

Member Data Documentation

◆ m_toolkit_flag

bool base_graphics_object::m_toolkit_flag
protected

Definition at line 2983 of file graphics.h.

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