GNU Octave  4.4.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
figure::properties Class Reference

#include "graphics.in.h"

Inheritance diagram for figure::properties:
Collaboration diagram for figure::properties:

Public Member Functions

virtual void add_listener (const caseless_str &, const octave_value &, listener_mode=POSTSET)
 
void adopt (const graphics_handle &h)
 
array_property closereq color_property color_property (color_values(1, 1, 1), radio_values("none")) array_property colormap
 
virtual void delete_children (bool clear=false)
 
virtual void delete_listener (const caseless_str &, const octave_value &, listener_mode=POSTSET)
 
std::set< std::stringdynamic_property_names (void) const
 
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 octave_value get_alim (void) const
 
Matrix get_all_children (void) const
 
Matrix get_boundingbox (bool internal=false, const Matrix &parent_pix_size=Matrix()) const
 
Matrix get_children (void) const
 
virtual octave_value get_clim (void) const
 
Matrix get_hidden_children (void) const
 
virtual property get_property (const caseless_str &pname)
 
std::string get_title (void) const
 
graphics_toolkit get_toolkit (void) const
 
virtual octave_value get_xlim (void) const
 
virtual octave_value get_ylim (void) const
 
virtual octave_value get_zlim (void) const
 
array_property closereq color_property graphics_handle () string_property currentcharacter r
 
array_property closereq color_property handle_property currentobject graphics_handle () array_property currentpoint r
 
virtual std::string graphics_object_name (void) const
 
bool has_dynamic_property (const std::string &pname)
 
virtual bool has_property (const caseless_str &) const
 
void init_integerhandle (const octave_value &val)
 
void insert_property (const std::string &name, property p)
 
virtual bool is_aliminclude (void) const
 
virtual bool is_climinclude (void) const
 
bool is_handle_visible (void) const
 
bool is_modified (void) const
 
virtual bool is_xliminclude (void) const
 
virtual bool is_yliminclude (void) const
 
virtual bool is_zliminclude (void) const
 
Matrix map_from_boundingbox (double x, double y) const
 
Matrix map_to_boundingbox (double x, double y) const
 
void mark_modified (void)
 
array_property Matrix (64, 1, 1) callback_property buttondownfcn
 
array_property Matrix () callback_property closerequestfcn
 
array_property closereq color_property handle_property currentobject Matrix (2, 1, 0) bool_property dockcontrols
 
array_property closereq color_property handle_property currentobject off string_property bool_property on bool_property integerhandle on bool_property on callback_property Matrix () callback_property keyreleasefcn
 
array_property closereq color_property handle_property currentobject off string_property bool_property on bool_property integerhandle on bool_property on callback_property Matrix () radio_property menubar
 
void override_defaults (base_graphics_object &obj)
 
void remove_child (const graphics_handle &h)
 
void renumber_child (graphics_handle old_gh, graphics_handle new_gh)
 
void renumber_parent (graphics_handle new_gh)
 
void reparent (const graphics_handle &new_parent)
 
virtual void set (const caseless_str &, const octave_value &)
 
void set___graphics_toolkit__ (const octave_value &val)
 
void set___modified__ (const octave_value &val)
 
void set_boundingbox (const Matrix &bb, bool internal=false, bool do_notify_toolkit=true)
 
void set_from_list (base_graphics_object &obj, property_list &defaults)
 
void set_modified (const octave_value &val)
 
void set_outerposition (const octave_value &val, bool do_notify_toolkit=true)
 
void set_parent (const octave_value &val)
 
void set_position (const octave_value &val, bool do_notify_toolkit=true)
 
void set_tag (const octave_value &val)
 
void set_toolkit (const graphics_toolkit &b)
 
void set_visible (const octave_value &val)
 
virtual void update_autopos (const std::string &elem_type)
 
virtual void update_axis_limits (const std::string &axis_type) const
 
virtual void update_axis_limits (const std::string &axis_type, const graphics_handle &h) const
 
virtual void update_boundingbox (void)
 
void update_paperunits (const caseless_str &old_paperunits)
 
virtual void update_uicontextmenu (void) const
 
void update_units (const caseless_str &old_units)
 
array_property closereq color_property viridis_colormap () handle_property currentaxes S
 

Static Public Member Functions

static property_list::pval_map_type factory_defaults (void)
 

Public Attributes

array_property alphamap
 
array_property closereq color_property color
 
array_property closereq color_property handle_property currentobject off string_property filename
 
array_property closereq color_property handle_property currentobject off string_property bool_property graphicssmoothing
 
array_property closereq color_property handle_property currentobject off string_property bool_property on bool_property integerhandle on bool_property inverthardcopy
 
array_property closereq color_property handle_property currentobject off string_property bool_property on bool_property integerhandle on bool_property on callback_property keypressfcn
 
array_property closereq color_property handle_property currentobject r
 
array_property closereq color_property handle_property currentobject off string_property bool_property on bool_property integerhandle S
 

Protected Member Functions

octave_value get_dynamic (const caseless_str &pname) const
 
octave_value get_dynamic (bool all=false) const
 
property get_property_dynamic (const caseless_str &pname)
 
void set_dynamic (const caseless_str &pname, const octave_value &val)
 

Protected Attributes

BEGIN_BASE_PROPERTIES bool_property beingdeleted
 
BEGIN_BASE_PROPERTIES bool_property off radio_property busyaction
 
std::set< std::stringdynamic_properties
 

Detailed Description

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

Member Function Documentation

◆ add_listener()

void base_properties::add_listener ( const caseless_str pname,
const octave_value val,
listener_mode  mode = POSTSET 
)
virtualinherited

Definition at line 3380 of file graphics.cc.

References mode, p, pname, and val.

◆ adopt()

void figure::properties::adopt ( const graphics_handle h)
virtual

Reimplemented from base_properties.

Definition at line 3894 of file graphics.cc.

References base_properties::adopt(), gh_manager::get_object(), h, and graphics_object::type().

◆ color_property()

array_property closereq color_property figure::properties::color_property ( color_values(1, 1, 1)  ,
radio_values("none")   
)

◆ delete_children()

virtual void base_properties::delete_children ( bool  clear = false)
inlinevirtualinherited

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

Referenced by gh_manager::do_free().

◆ delete_listener()

void base_properties::delete_listener ( const caseless_str pname,
const octave_value val,
listener_mode  mode = POSTSET 
)
virtualinherited

Definition at line 3391 of file graphics.cc.

References mode, p, pname, and val.

Referenced by do_cleanup_waitfor_listener().

◆ dynamic_property_names()

std::set< std::string > base_properties::dynamic_property_names ( void  ) const
inherited

Definition at line 3117 of file graphics.cc.

◆ factory_defaults()

◆ get() [1/4]

virtual octave_value base_properties::get ( const caseless_str pname) const
virtualinherited

◆ get() [2/4]

virtual octave_value base_properties::get ( const std::string pname) const
inlinevirtualinherited

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

References pname.

◆ get() [3/4]

virtual octave_value base_properties::get ( const char *  pname) const
inlinevirtualinherited

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

References pname.

◆ get() [4/4]

virtual octave_value base_properties::get ( bool  all = false) const
virtualinherited

◆ get_alim()

virtual octave_value base_properties::get_alim ( void  ) const
inlinevirtualinherited

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

References octave_value().

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

◆ get_all_children()

◆ get_boundingbox()

Matrix figure::properties::get_boundingbox ( bool  internal = false,
const Matrix parent_pix_size = Matrix () 
) const
virtual

Reimplemented from base_properties.

Definition at line 3937 of file graphics.cc.

References convert_position(), and screen_size_pixels().

Referenced by QtHandles::Figure::Figure(), G__osmesa_print__(), and QtHandles::Figure::update().

◆ get_children()

◆ get_clim()

virtual octave_value base_properties::get_clim ( void  ) const
inlinevirtualinherited

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

References octave_value().

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

◆ get_dynamic() [1/2]

octave_value base_properties::get_dynamic ( const caseless_str pname) const
protectedinherited

Definition at line 3092 of file graphics.cc.

References error(), and pname.

◆ get_dynamic() [2/2]

octave_value base_properties::get_dynamic ( bool  all = false) const
protectedinherited

Definition at line 3104 of file graphics.cc.

References octave_scalar_map::assign().

◆ get_hidden_children()

Matrix base_properties::get_hidden_children ( void  ) const
inlineinherited

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

◆ get_property()

◆ get_property_dynamic()

property base_properties::get_property_dynamic ( const caseless_str pname)
protectedinherited

Definition at line 3151 of file graphics.cc.

References error(), and pname.

◆ get_title()

std::string figure::properties::get_title ( void  ) const

Definition at line 4671 of file graphics.cc.

References octave_value_list::empty(), nm, os, and string.

Referenced by axes::initialize(), and QtHandles::Figure::update().

◆ get_toolkit()

graphics_toolkit figure::properties::get_toolkit ( void  ) const
virtual

Reimplemented from base_properties.

Definition at line 3857 of file graphics.cc.

References octave::__get_gtk_manager__(), and octave::gtk_manager::get_toolkit().

◆ get_xlim()

virtual octave_value base_properties::get_xlim ( void  ) const
inlinevirtualinherited

◆ get_ylim()

virtual octave_value base_properties::get_ylim ( void  ) const
inlinevirtualinherited

◆ get_zlim()

virtual octave_value base_properties::get_zlim ( void  ) const
inlinevirtualinherited

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

References octave_value().

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

◆ graphics_handle() [1/2]

array_property closereq color_property figure::properties::graphics_handle ( )

◆ graphics_handle() [2/2]

array_property closereq color_property handle_property currentobject figure::properties::graphics_handle ( )

◆ graphics_object_name()

virtual std::string base_properties::graphics_object_name ( void  ) const
inlinevirtualinherited

◆ has_dynamic_property()

bool base_properties::has_dynamic_property ( const std::string pname)
inherited

Definition at line 3123 of file graphics.cc.

References pname.

Referenced by if().

◆ has_property()

virtual bool base_properties::has_property ( const caseless_str ) const
inlinevirtualinherited

◆ init_integerhandle()

void figure::properties::init_integerhandle ( const octave_value val)
inlinevirtual

Reimplemented from base_properties.

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

◆ insert_property()

void base_properties::insert_property ( const std::string name,
property  p 
)
inlineinherited

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

References name, and p.

◆ is_aliminclude()

virtual bool base_properties::is_aliminclude ( void  ) const
inlinevirtualinherited

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

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

◆ is_climinclude()

virtual bool base_properties::is_climinclude ( void  ) const
inlinevirtualinherited

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

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

◆ is_handle_visible()

bool base_properties::is_handle_visible ( void  ) const
inherited

Definition at line 3267 of file graphics.cc.

References callback_props::empty(), and executing_callbacks.

◆ is_modified()

bool base_properties::is_modified ( void  ) const
inlineinherited

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

◆ is_xliminclude()

virtual bool base_properties::is_xliminclude ( void  ) const
inlinevirtualinherited

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

◆ is_yliminclude()

virtual bool base_properties::is_yliminclude ( void  ) const
inlinevirtualinherited

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

◆ is_zliminclude()

virtual bool base_properties::is_zliminclude ( void  ) const
inlinevirtualinherited

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

◆ map_from_boundingbox()

Matrix figure::properties::map_from_boundingbox ( double  x,
double  y 
) const

Definition at line 3972 of file graphics.cc.

References convert_position(), Matrix::extract_n(), x, and y.

◆ map_to_boundingbox()

Matrix figure::properties::map_to_boundingbox ( double  x,
double  y 
) const

Definition at line 3989 of file graphics.cc.

References convert_position(), Matrix::extract_n(), x, and y.

◆ mark_modified()

void base_properties::mark_modified ( void  )
inherited

◆ Matrix() [1/5]

array_property figure::properties::Matrix ( 64  ,
,
 
)

◆ Matrix() [2/5]

array_property figure::properties::Matrix ( void  )

Referenced by set_toolkit().

◆ Matrix() [3/5]

array_property closereq color_property handle_property currentobject figure::properties::Matrix ( ,
,
 
)

◆ Matrix() [4/5]

array_property closereq color_property handle_property currentobject off string_property bool_property on bool_property integerhandle on bool_property on callback_property figure::properties::Matrix ( void  )

◆ Matrix() [5/5]

array_property closereq color_property handle_property currentobject off string_property bool_property on bool_property integerhandle on bool_property on callback_property figure::properties::Matrix ( void  )

◆ override_defaults()

void base_properties::override_defaults ( base_graphics_object obj)
inherited

◆ remove_child()

void figure::properties::remove_child ( const graphics_handle h)
virtual

◆ renumber_child()

void base_properties::renumber_child ( graphics_handle  old_gh,
graphics_handle  new_gh 
)
inlineinherited

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

◆ renumber_parent()

void base_properties::renumber_parent ( graphics_handle  new_gh)
inlineinherited

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

◆ reparent()

void base_properties::reparent ( const graphics_handle new_parent)
inlineinherited

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

◆ set()

virtual void base_properties::set ( const caseless_str ,
const octave_value  
)
virtualinherited

◆ set___graphics_toolkit__()

void figure::properties::set___graphics_toolkit__ ( const octave_value val)

◆ set___modified__()

void base_properties::set___modified__ ( const octave_value val)
inlineinherited

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

References val.

◆ set_boundingbox()

void figure::properties::set_boundingbox ( const Matrix bb,
bool  internal = false,
bool  do_notify_toolkit = true 
)

Definition at line 3954 of file graphics.cc.

References convert_position(), and screen_size_pixels().

Referenced by QtHandles::Figure::updateBoundingBoxHelper().

◆ set_dynamic()

void base_properties::set_dynamic ( const caseless_str pname,
const octave_value val 
)
protectedinherited

Definition at line 3134 of file graphics.cc.

References error(), base_graphics_object::mark_modified(), pname, and val.

◆ set_from_list()

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

◆ set_modified()

void base_properties::set_modified ( const octave_value val)
inlineinherited

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

References val.

◆ set_outerposition()

void figure::properties::set_outerposition ( const octave_value val,
bool  do_notify_toolkit = true 
)

Definition at line 4036 of file graphics.cc.

References base_graphics_object::mark_modified().

◆ set_parent()

◆ set_position()

void figure::properties::set_position ( const octave_value val,
bool  do_notify_toolkit = true 
)

Definition at line 4006 of file graphics.cc.

References base_graphics_object::mark_modified(), and POSTSET.

◆ set_tag()

void base_properties::set_tag ( const octave_value val)
inlineinherited

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

References val.

◆ set_toolkit()

void figure::properties::set_toolkit ( const graphics_toolkit b)

Definition at line 1987 of file graphics.cc.

References b, finalize_r(), initialize_r(), base_properties::mark_modified(), and Matrix().

◆ set_visible()

void figure::properties::set_visible ( const octave_value val)

Definition at line 3926 of file graphics.cc.

References string, val, and xset().

Referenced by G__osmesa_print__().

◆ update_autopos()

void base_properties::update_autopos ( const std::string elem_type)
virtualinherited

◆ update_axis_limits() [1/2]

void base_properties::update_axis_limits ( const std::string axis_type) const
virtualinherited

◆ update_axis_limits() [2/2]

void base_properties::update_axis_limits ( const std::string axis_type,
const graphics_handle h 
) const
virtualinherited

Definition at line 3242 of file graphics.cc.

References gh_manager::get_object(), h, and graphics_object::update_axis_limits().

◆ update_boundingbox()

◆ update_paperunits()

void figure::properties::update_paperunits ( const caseless_str old_paperunits)

Definition at line 4348 of file graphics.cc.

References caseless_str::compare(), papersize_from_type(), string, swap, and sz.

◆ update_uicontextmenu()

void base_properties::update_uicontextmenu ( void  ) const
virtualinherited

◆ update_units()

void figure::properties::update_units ( const caseless_str old_units)

Definition at line 4646 of file graphics.cc.

References convert_position(), and screen_size_pixels().

◆ viridis_colormap()

array_property closereq color_property figure::properties::viridis_colormap ( )

Member Data Documentation

◆ alphamap

array_property figure::properties::alphamap

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

◆ beingdeleted

BEGIN_BASE_PROPERTIES bool_property base_properties::beingdeleted
protectedinherited

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

◆ busyaction

BEGIN_BASE_PROPERTIES bool_property off radio_property base_properties::busyaction
protectedinherited

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

◆ color

array_property closereq color_property figure::properties::color

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

◆ dynamic_properties

std::set<std::string> base_properties::dynamic_properties
protectedinherited

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

◆ filename

array_property closereq color_property handle_property currentobject off string_property figure::properties::filename

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

◆ graphicssmoothing

array_property closereq color_property handle_property currentobject off string_property bool_property figure::properties::graphicssmoothing

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

◆ inverthardcopy

array_property closereq color_property handle_property currentobject off string_property bool_property on bool_property integerhandle on bool_property figure::properties::inverthardcopy

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

◆ keypressfcn

array_property closereq color_property handle_property currentobject off string_property bool_property on bool_property integerhandle on bool_property on callback_property figure::properties::keypressfcn

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

◆ r

array_property closereq color_property handle_property currentobject figure::properties::r

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

◆ S

array_property closereq color_property handle_property currentobject off string_property bool_property on bool_property integerhandle figure::properties::S

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


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