GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
graphics_object Class Reference

#include "graphics.h"

Public Member Functions

 graphics_object ()
 
 graphics_object (base_graphics_object *new_rep)
 
 graphics_object (const graphics_object &)=default
 
 ~graphics_object ()=default
 
void add_property_listener (const std::string &nm, const octave_value &v, listener_mode mode=GCB_POSTSET)
 
void adopt (const graphics_handle &h)
 
void build_user_defaults_map (property_list::pval_map_type &def, const std::string go_name) const
 
void defaults () const
 
void delete_property_listener (const std::string &nm, const octave_value &v, listener_mode mode=GCB_POSTSET)
 
void finalize ()
 
octave_value get (bool all=false) const
 
octave_value get (const caseless_str &name) const
 
octave_value get (const char *name) const
 
octave_value get (const std::string &name) const
 
octave_value get_alim () const
 
graphics_object get_ancestor (const std::string &type) const
 
octave_value get_clim () const
 
octave_value get_default (const caseless_str &name) const
 
octave_value get_defaults () const
 
property_list get_defaults_list () const
 
octave_value get_factory_default (const caseless_str &name) const
 
octave_value get_factory_defaults () const
 
property_list get_factory_defaults_list () const
 
graphics_handle get_handle () const
 
graphics_handle get_parent () const
 
base_propertiesget_properties ()
 
const base_propertiesget_properties () const
 
octave::graphics_toolkit get_toolkit () const
 
octave_value get_xlim () const
 
octave_value get_ylim () const
 
octave_value get_zlim () const
 
bool has_readonly_property (const caseless_str &pname) const
 
void initialize ()
 
bool is_aliminclude () const
 
bool is_climinclude () const
 
bool is_handle_visible () const
 
bool is_xliminclude () const
 
bool is_yliminclude () const
 
bool is_zliminclude () const
 
bool isa (const std::string &go_name) const
 
void mark_modified ()
 
 operator bool () const
 
graphics_objectoperator= (const graphics_object &)=default
 
void override_defaults ()
 
void override_defaults (base_graphics_object &obj)
 
void remove_all_listeners ()
 
void remove_child (const graphics_handle &h)
 
void reparent (const graphics_handle &h)
 
void reset_default_properties ()
 
void set (const Array< std::string > &names, const Cell &values, octave_idx_type row)
 
void set (const caseless_str &name, const octave_value &val)
 
void set (const octave_map &m)
 
void set (const octave_value_list &args)
 
void set_defaults (const std::string &mode)
 
void set_from_list (property_list &plist)
 
void set_value_or_default (const caseless_str &name, const octave_value &val)
 
std::string type () const
 
void update (int id)
 
void update_axis_limits (const std::string &axis_type)
 
void update_axis_limits (const std::string &axis_type, const graphics_handle &h)
 
bool valid_object () const
 
std::string value_as_string (const std::string &prop)
 
std::string values_as_string ()
 
octave_map values_as_struct ()
 

Detailed Description

Definition at line 2986 of file graphics.h.

Constructor & Destructor Documentation

◆ graphics_object() [1/3]

graphics_object::graphics_object ( )
inline

Definition at line 2990 of file graphics.h.

◆ graphics_object() [2/3]

graphics_object::graphics_object ( base_graphics_object new_rep)
inline

Definition at line 2992 of file graphics.h.

◆ graphics_object() [3/3]

graphics_object::graphics_object ( const graphics_object )
default

◆ ~graphics_object()

graphics_object::~graphics_object ( )
default

Member Function Documentation

◆ add_property_listener()

void graphics_object::add_property_listener ( const std::string &  nm,
const octave_value v,
listener_mode  mode = GCB_POSTSET 
)
inline

Definition at line 3185 of file graphics.h.

Referenced by Faddlistener().

◆ adopt()

void graphics_object::adopt ( const graphics_handle h)
inline

Definition at line 3112 of file graphics.h.

◆ build_user_defaults_map()

void graphics_object::build_user_defaults_map ( property_list::pval_map_type def,
const std::string  go_name 
) const
inline

Definition at line 3012 of file graphics.h.

Referenced by base_graphics_object::build_user_defaults_map().

◆ defaults()

void graphics_object::defaults ( ) const
inline

Definition at line 3116 of file graphics.h.

◆ delete_property_listener()

void graphics_object::delete_property_listener ( const std::string &  nm,
const octave_value v,
listener_mode  mode = GCB_POSTSET 
)
inline

Definition at line 3189 of file graphics.h.

Referenced by Fdellistener().

◆ finalize()

void graphics_object::finalize ( )
inline

Definition at line 3197 of file graphics.h.

◆ get() [1/4]

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

◆ get() [2/4]

octave_value graphics_object::get ( const caseless_str name) const
inline

Definition at line 3039 of file graphics.h.

References caseless_str::compare().

◆ get() [3/4]

octave_value graphics_object::get ( const char *  name) const
inline

Definition at line 3052 of file graphics.h.

◆ get() [4/4]

octave_value graphics_object::get ( const std::string &  name) const
inline

Definition at line 3047 of file graphics.h.

◆ get_alim()

octave_value graphics_object::get_alim ( ) const
inline

Definition at line 3149 of file graphics.h.

◆ get_ancestor()

◆ get_clim()

octave_value graphics_object::get_clim ( ) const
inline

Definition at line 3152 of file graphics.h.

◆ get_default()

octave_value graphics_object::get_default ( const caseless_str name) const
inline

◆ get_defaults()

octave_value graphics_object::get_defaults ( ) const
inline

Definition at line 3067 of file graphics.h.

◆ get_defaults_list()

property_list graphics_object::get_defaults_list ( ) const
inline

Definition at line 3069 of file graphics.h.

◆ get_factory_default()

octave_value graphics_object::get_factory_default ( const caseless_str name) const
inline

Definition at line 3062 of file graphics.h.

Referenced by base_graphics_object::get_factory_default().

◆ get_factory_defaults()

octave_value graphics_object::get_factory_defaults ( ) const
inline

Definition at line 3074 of file graphics.h.

◆ get_factory_defaults_list()

property_list graphics_object::get_factory_defaults_list ( ) const
inline

Definition at line 3079 of file graphics.h.

Referenced by base_graphics_object::reset_default_properties().

◆ get_handle()

graphics_handle graphics_object::get_handle ( ) const
inline

Definition at line 3106 of file graphics.h.

Referenced by base_properties::set_parent().

◆ get_parent()

graphics_handle graphics_object::get_parent ( ) const
inline

Definition at line 3104 of file graphics.h.

Referenced by F__get_position__(), and base_properties::set_parent().

◆ get_properties() [1/2]

base_properties& graphics_object::get_properties ( )
inline

Definition at line 3120 of file graphics.h.

Referenced by base_graphics_object::add_property_listener(), base_graphics_object::adopt(), axes::properties::adopt(), hggroup::properties::adopt(), uibuttongroup::properties::adopt(), calc_dimensions(), delete_graphics_object(), base_graphics_object::delete_property_listener(), opengl_renderer::draw(), opengl_renderer::draw_scatter(), opengl_renderer::draw_uibuttongroup(), opengl_renderer::draw_uipanel(), F__get_position__(), F__go_figure__(), F__image_pixel_size__(), F__show_figure__(), F__update_normals__(), F__zoom__(), Faddproperty(), Fdrawnow(), base_graphics_object::get(), text::properties::get___fontsize_points__(), axes::properties::get_boundingbox(), uicontrol::properties::get_boundingbox(), uibuttongroup::properties::get_boundingbox(), uipanel::properties::get_boundingbox(), uitable::properties::get_boundingbox(), base_properties::get_children_of_type(), patch::properties::get_do_lighting(), surface::properties::get_do_lighting(), uicontrol::properties::get_extent(), uitable::properties::get_extent(), axes::properties::get_extent(), base_graphics_object::get_handle(), base_graphics_object::get_parent(), base_graphics_object::get_toolkit(), light::initialize(), scatter::initialize(), gh_manager::make_graphics_handle(), base_graphics_object::mark_modified(), base_graphics_object::override_defaults(), gh_manager::post_callback(), gh_manager::process_events(), base_graphics_object::remove_child(), axes::properties::remove_child(), hggroup::properties::remove_child(), base_graphics_object::reparent(), base_graphics_object::set(), base_graphics_object::set_from_list(), figure::properties::set_integerhandle(), base_properties::set_parent(), uibuttongroup::properties::set_selectedobject(), uicontrol::properties::set_style(), axes::properties::trigger_normals_calc(), base_graphics_object::type(), base_properties::update_autopos(), base_properties::update_boundingbox(), base_properties::update_contextmenu(), uicontrol::properties::update_units(), axes::properties::update_units(), uibuttongroup::properties::update_units(), uipanel::properties::update_units(), and uitable::properties::update_units().

◆ get_properties() [2/2]

const base_properties& graphics_object::get_properties ( ) const
inline

Definition at line 3122 of file graphics.h.

◆ get_toolkit()

◆ get_xlim()

octave_value graphics_object::get_xlim ( ) const
inline

Definition at line 3155 of file graphics.h.

Referenced by get_children_limits().

◆ get_ylim()

octave_value graphics_object::get_ylim ( ) const
inline

Definition at line 3158 of file graphics.h.

◆ get_zlim()

octave_value graphics_object::get_zlim ( ) const
inline

Definition at line 3161 of file graphics.h.

◆ has_readonly_property()

bool graphics_object::has_readonly_property ( const caseless_str pname) const
inline

◆ initialize()

void graphics_object::initialize ( )
inline

◆ is_aliminclude()

bool graphics_object::is_aliminclude ( ) const
inline

Definition at line 3164 of file graphics.h.

◆ is_climinclude()

bool graphics_object::is_climinclude ( ) const
inline

Definition at line 3167 of file graphics.h.

◆ is_handle_visible()

bool graphics_object::is_handle_visible ( ) const
inline

Definition at line 3179 of file graphics.h.

Referenced by gh_manager::is_handle_visible().

◆ is_xliminclude()

bool graphics_object::is_xliminclude ( ) const
inline

Definition at line 3170 of file graphics.h.

Referenced by get_children_limits().

◆ is_yliminclude()

bool graphics_object::is_yliminclude ( ) const
inline

Definition at line 3173 of file graphics.h.

◆ is_zliminclude()

bool graphics_object::is_zliminclude ( ) const
inline

Definition at line 3176 of file graphics.h.

◆ isa()

◆ mark_modified()

void graphics_object::mark_modified ( )
inline

Definition at line 3000 of file graphics.h.

Referenced by base_properties::mark_modified().

◆ operator bool()

graphics_object::operator bool ( ) const
inline

Definition at line 3142 of file graphics.h.

◆ operator=()

graphics_object& graphics_object::operator= ( const graphics_object )
default

◆ override_defaults() [1/2]

void graphics_object::override_defaults ( )
inline

Definition at line 3007 of file graphics.h.

◆ override_defaults() [2/2]

void graphics_object::override_defaults ( base_graphics_object obj)
inline

◆ remove_all_listeners()

void graphics_object::remove_all_listeners ( )
inline

Definition at line 3193 of file graphics.h.

◆ remove_child()

void graphics_object::remove_child ( const graphics_handle h)
inline

Definition at line 3110 of file graphics.h.

Referenced by gh_manager::free(), and base_properties::set_parent().

◆ reparent()

void graphics_object::reparent ( const graphics_handle h)
inline

Definition at line 3114 of file graphics.h.

◆ reset_default_properties()

void graphics_object::reset_default_properties ( )
inline

Definition at line 3201 of file graphics.h.

Referenced by Freset().

◆ set() [1/4]

void graphics_object::set ( const Array< std::string > &  names,
const Cell values,
octave_idx_type  row 
)

Definition at line 2607 of file graphics.cc.

References Array< T, Alloc >::columns(), error(), and Array< T, Alloc >::numel().

◆ set() [2/4]

void graphics_object::set ( const caseless_str name,
const octave_value val 
)
inline

Definition at line 3020 of file graphics.h.

Referenced by Fset(), set_property_in_handle(), axes::properties::update_font(), and xset().

◆ set() [3/4]

void graphics_object::set ( const octave_map m)

Definition at line 2674 of file graphics.cc.

References m, and octave_value().

◆ set() [4/4]

void graphics_object::set ( const octave_value_list args)

Definition at line 2566 of file graphics.cc.

References error(), octave_value_list::length(), and figure::set().

◆ set_defaults()

void graphics_object::set_defaults ( const std::string &  mode)
inline

Definition at line 3035 of file graphics.h.

◆ set_from_list()

void graphics_object::set_from_list ( property_list plist)
inline

Definition at line 3018 of file graphics.h.

◆ set_value_or_default()

void graphics_object::set_value_or_default ( const caseless_str name,
const octave_value val 
)

◆ type()

std::string graphics_object::type ( ) const
inline

◆ update()

void graphics_object::update ( int  id)
inline

◆ update_axis_limits() [1/2]

void graphics_object::update_axis_limits ( const std::string &  axis_type)
inline

◆ update_axis_limits() [2/2]

void graphics_object::update_axis_limits ( const std::string &  axis_type,
const graphics_handle h 
)
inline

Definition at line 3132 of file graphics.h.

◆ valid_object()

◆ value_as_string()

std::string graphics_object::value_as_string ( const std::string &  prop)
inline

Definition at line 3095 of file graphics.h.

Referenced by Fset().

◆ values_as_string()

std::string graphics_object::values_as_string ( )
inline

Definition at line 3091 of file graphics.h.

Referenced by Fset().

◆ values_as_struct()

octave_map graphics_object::values_as_struct ( )
inline

Definition at line 3102 of file graphics.h.

Referenced by Fset().


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