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

#include "graphics.h"

Inheritance diagram for root_figure::properties:
base_properties

Public Types

enum  {
  ID_CALLBACKOBJECT = 1000 , ID_COMMANDWINDOWSIZE = 1001 , ID_CURRENTFIGURE = 1002 , ID_FIXEDWIDTHFONTNAME = 1003 ,
  ID_MONITORPOSITIONS = 1004 , ID_POINTERLOCATION = 1005 , ID_POINTERWINDOW = 1006 , ID_SCREENDEPTH = 1007 ,
  ID_SCREENPIXELSPERINCH = 1008 , ID_SCREENSIZE = 1009 , ID_SHOWHIDDENHANDLES = 1010 , ID_UNITS = 1011
}
 
- Public Types inherited from base_properties
enum  {
  ID_BEINGDELETED = 0 , ID_BUSYACTION = 1 , ID_BUTTONDOWNFCN = 2 , ID_CHILDREN = 3 ,
  ID_CLIPPING = 4 , ID_CONTEXTMENU = 5 , ID_CREATEFCN = 6 , ID_DELETEFCN = 7 ,
  ID_HANDLEVISIBILITY = 8 , ID_HITTEST = 9 , ID_INTERRUPTIBLE = 10 , ID_PARENT = 11 ,
  ID_PICKABLEPARTS = 12 , ID_SELECTED = 13 , ID_SELECTIONHIGHLIGHT = 14 , ID_TAG = 15 ,
  ID_TYPE = 16 , ID_UICONTEXTMENU = 17 , ID_USERDATA = 18 , ID_VISIBLE = 19 ,
  ID___APPDATA__ = 20 , ID___MODIFIED__ = 21 , ID___MYHANDLE__ = 22
}
 

Public Member Functions

 properties ()=delete
 
 properties (const graphics_handle &mh, const graphics_handle &p)
 
 ~properties ()=default
 
std::set< std::string > all_property_names () const
 
octave_value get (bool all=false) const
 
octave_value get (const caseless_str &pname) const
 
octave_value get (const char *pname) const
 
octave_value get (const std::string &pname) const
 
Matrix get_boundingbox (bool internal=false, const Matrix &parent_pix_size=Matrix()) const
 
graphics_handle get_callbackobject () const
 
octave_value get_commandwindowsize () const
 
graphics_handle get_currentfigure () const
 
std::string get_fixedwidthfontname () const
 
octave_value get_monitorpositions () const
 
octave_value get_pointerlocation () const
 
double get_pointerwindow () const
 
property get_property (const caseless_str &pname)
 
double get_screendepth () const
 
double get_screenpixelsperinch () const
 
octave_value get_screensize () const
 
std::string get_showhiddenhandles () const
 
std::string get_units () const
 
std::string graphics_object_name () const
 
bool has_property (const caseless_str &pname) const
 
bool is_showhiddenhandles () const
 
void remove_child (const graphics_handle &h, bool from_root=false)
 
void set (const caseless_str &pname, const octave_value &val)
 
void set_callbackobject (const octave_value &val)
 
void set_commandwindowsize (const octave_value &val)
 
void set_currentfigure (const octave_value &val)
 
void set_fixedwidthfontname (const octave_value &val)
 
void set_monitorpositions (const octave_value &val)
 
void set_pointerlocation (const octave_value &val)
 
void set_pointerwindow (const octave_value &val)
 
void set_screendepth (const octave_value &val)
 
void set_screenpixelsperinch (const octave_value &val)
 
void set_screensize (const octave_value &val)
 
void set_showhiddenhandles (const octave_value &val)
 
void set_units (const octave_value &val)
 
bool units_is (const std::string &v) const
 
void update_units ()
 
- Public Member Functions inherited from base_properties
 base_properties (const std::string &ty="unknown", const graphics_handle &mh=graphics_handle(), const graphics_handle &p=graphics_handle())
 
virtual ~base_properties ()=default
 
virtual void add_listener (const caseless_str &, const octave_value &, listener_mode=GCB_POSTSET)
 
virtual void adopt (const graphics_handle &h)
 
std::set< std::string > all_property_names () const
 
bool busyaction_is (const std::string &v) const
 
virtual void delete_children (bool clear=false, bool from_root=false)
 
virtual void delete_listener (const caseless_str &, const octave_value &, listener_mode=GCB_POSTSET)
 
std::set< std::string > dynamic_property_names () const
 
void execute_buttondownfcn (const octave_value &new_data=octave_value()) const
 
void execute_createfcn (const octave_value &new_data=octave_value()) const
 
void execute_deletefcn (const octave_value &new_data=octave_value()) const
 
octave_value get___appdata__ () const
 
std::string get___modified__ () const
 
graphics_handle get___myhandle__ () const
 
virtual octave_value get_alim () const
 
Matrix get_all_children () const
 
std::string get_beingdeleted () const
 
std::string get_busyaction () const
 
octave_value get_buttondownfcn () const
 
Matrix get_children () const
 
void get_children_of_type (const caseless_str &type, bool get_invisible, bool traverse, std::list< graphics_object > &children_list) const
 
virtual octave_value get_clim () const
 
std::string get_clipping () const
 
graphics_handle get_contextmenu () const
 
octave_value get_createfcn () const
 
octave_value get_deletefcn () const
 
std::string get_handlevisibility () const
 
Matrix get_hidden_children () const
 
std::string get_hittest () const
 
std::string get_interruptible () const
 
graphics_handle get_parent () const
 
std::string get_pickableparts () const
 
std::string get_selected () const
 
std::string get_selectionhighlight () const
 
std::string get_tag () const
 
virtual octave::graphics_toolkit get_toolkit () const
 
std::string get_type () const
 
graphics_handle get_uicontextmenu () const
 
octave_value get_userdata () const
 
std::string get_visible () const
 
virtual octave_value get_xlim () const
 
virtual octave_value get_ylim () const
 
virtual octave_value get_zlim () const
 
bool handlevisibility_is (const std::string &v) const
 
bool has_dynamic_property (const std::string &pname) const
 
virtual void init_integerhandle (const octave_value &)
 
void insert_property (const std::string &name, property p)
 
bool is___modified__ () const
 
virtual bool is_aliminclude () const
 
bool is_beingdeleted () const
 
virtual bool is_climinclude () const
 
bool is_clipping () const
 
bool is_handle_visible () const
 
bool is_hittest () const
 
bool is_interruptible () const
 
bool is_modified () const
 
bool is_selected () const
 
bool is_selectionhighlight () const
 
bool is_visible () const
 
virtual bool is_xliminclude () const
 
virtual bool is_yliminclude () const
 
virtual bool is_zliminclude () const
 
void mark_modified ()
 
void override_defaults (base_graphics_object &obj)
 
bool pickableparts_is (const std::string &v) const
 
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)
 
void set___appdata__ (const octave_value &val)
 
void set___modified__ (const octave_value &val)
 
void set_beingdeleted (const octave_value &val)
 
void set_busyaction (const octave_value &val)
 
void set_buttondownfcn (const octave_value &val)
 
void set_children (const octave_value &val)
 
void set_clipping (const octave_value &val)
 
void set_contextmenu (const octave_value &val)
 
void set_createfcn (const octave_value &val)
 
void set_deletefcn (const octave_value &val)
 
void set_from_list (base_graphics_object &obj, property_list &defaults)
 
void set_handlevisibility (const octave_value &val)
 
void set_hittest (const octave_value &val)
 
void set_interruptible (const octave_value &val)
 
void set_modified (const octave_value &val)
 
void set_parent (const octave_value &val)
 
void set_pickableparts (const octave_value &val)
 
void set_selected (const octave_value &val)
 
void set_selectionhighlight (const octave_value &val)
 
void set_tag (const octave_value &val)
 
void set_uicontextmenu (const octave_value &val)
 
void set_userdata (const octave_value &val)
 
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_beingdeleted ()
 
virtual void update_boundingbox ()
 
virtual void update_contextmenu () const
 
virtual void update_handlevisibility ()
 
virtual void update_visible ()
 

Static Public Member Functions

static std::set< std::string > core_property_names ()
 
static property_list::pval_map_type factory_defaults ()
 
static bool has_core_property (const caseless_str &pname)
 
static bool has_readonly_property (const caseless_str &pname)
 
static std::set< std::string > readonly_property_names ()
 
- Static Public Member Functions inherited from base_properties
static std::set< std::string > core_property_names ()
 
static property_list::pval_map_type factory_defaults ()
 
static bool has_core_property (const caseless_str &pname)
 
static bool has_readonly_property (const caseless_str &pname)
 
static std::set< std::string > readonly_property_names ()
 

Additional Inherited Members

- Protected Member Functions inherited from base_properties
octave_value get_dynamic (bool all=false) const
 
octave_value get_dynamic (const caseless_str &pname) const
 
property get_property_dynamic (const caseless_str &pname) const
 
virtual void init ()
 
void set_dynamic (const caseless_str &pname, const octave_value &val)
 
- Protected Attributes inherited from base_properties
any_property m___appdata__
 
bool_property m___modified__
 
graphics_handle m___myhandle__
 
std::map< caseless_str, property, cmp_caseless_strm_all_props
 
bool_property m_beingdeleted
 
radio_property m_busyaction
 
callback_property m_buttondownfcn
 
children_property m_children
 
bool_property m_clipping
 
handle_property m_contextmenu
 
callback_property m_createfcn
 
callback_property m_deletefcn
 
std::set< std::string > m_dynamic_properties
 
radio_property m_handlevisibility
 
bool_property m_hittest
 
bool_property m_interruptible
 
handle_property m_parent
 
radio_property m_pickableparts
 
bool_property m_selected
 
bool_property m_selectionhighlight
 
string_property m_tag
 
string_property m_type
 
handle_property m_uicontextmenu
 
any_property m_userdata
 
bool_property m_visible
 

Detailed Description

Definition at line 3220 of file graphics.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
ID_CALLBACKOBJECT 
ID_COMMANDWINDOWSIZE 
ID_CURRENTFIGURE 
ID_FIXEDWIDTHFONTNAME 
ID_MONITORPOSITIONS 
ID_POINTERLOCATION 
ID_POINTERWINDOW 
ID_SCREENDEPTH 
ID_SCREENPIXELSPERINCH 
ID_SCREENSIZE 
ID_SHOWHIDDENHANDLES 
ID_UNITS 

Definition at line 3310 of file graphics.h.

Constructor & Destructor Documentation

◆ properties() [1/2]

root_figure::properties::properties ( const graphics_handle mh,
const graphics_handle p 
)

Definition at line 369 of file graphics-props.cc.

◆ properties() [2/2]

root_figure::properties::properties ( )
delete

◆ ~properties()

root_figure::properties::~properties ( )
default

Member Function Documentation

◆ all_property_names()

std::set< std::string > root_figure::properties::all_property_names ( ) const

Definition at line 618 of file graphics-props.cc.

References base_properties::all_property_names().

◆ core_property_names()

std::set< std::string > root_figure::properties::core_property_names ( )
static

Definition at line 545 of file graphics-props.cc.

References base_properties::core_property_names().

◆ factory_defaults()

property_list::pval_map_type root_figure::properties::factory_defaults ( )
static

◆ get() [1/4]

octave_value root_figure::properties::get ( bool  all = false) const
virtual

Reimplemented from base_properties.

Definition at line 427 of file graphics-props.cc.

References base_properties::get(), m, and octave_value::map_value().

◆ get() [2/4]

octave_value root_figure::properties::get ( const caseless_str pname) const
virtual

Reimplemented from base_properties.

Definition at line 448 of file graphics-props.cc.

◆ get() [3/4]

octave_value root_figure::properties::get ( const char *  pname) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 3264 of file graphics.h.

◆ get() [4/4]

octave_value root_figure::properties::get ( const std::string &  pname) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 3259 of file graphics.h.

◆ get_boundingbox()

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

Reimplemented from base_properties.

Definition at line 3720 of file graphics.cc.

◆ get_callbackobject()

graphics_handle root_figure::properties::get_callbackobject ( ) const
inline

Definition at line 3326 of file graphics.h.

References handle_property::handle_value().

◆ get_commandwindowsize()

octave_value root_figure::properties::get_commandwindowsize ( ) const
inline

Definition at line 3328 of file graphics.h.

References array_property::get().

◆ get_currentfigure()

graphics_handle root_figure::properties::get_currentfigure ( ) const
inline

Definition at line 3330 of file graphics.h.

References handle_property::handle_value().

◆ get_fixedwidthfontname()

std::string root_figure::properties::get_fixedwidthfontname ( ) const
inline

Definition at line 3332 of file graphics.h.

References string_property::string_value().

◆ get_monitorpositions()

octave_value root_figure::properties::get_monitorpositions ( ) const
inline

Definition at line 3334 of file graphics.h.

References array_property::get().

◆ get_pointerlocation()

octave_value root_figure::properties::get_pointerlocation ( ) const
inline

Definition at line 3336 of file graphics.h.

References array_property::get().

◆ get_pointerwindow()

double root_figure::properties::get_pointerwindow ( ) const
inline

Definition at line 3338 of file graphics.h.

References double_property::double_value().

◆ get_property()

property root_figure::properties::get_property ( const caseless_str pname)
virtual

Reimplemented from base_properties.

Definition at line 487 of file graphics-props.cc.

◆ get_screendepth()

double root_figure::properties::get_screendepth ( ) const
inline

Definition at line 3340 of file graphics.h.

References double_property::double_value().

◆ get_screenpixelsperinch()

double root_figure::properties::get_screenpixelsperinch ( ) const
inline

Definition at line 3342 of file graphics.h.

References double_property::double_value().

◆ get_screensize()

octave_value root_figure::properties::get_screensize ( ) const
inline

Definition at line 3344 of file graphics.h.

References array_property::get().

◆ get_showhiddenhandles()

std::string root_figure::properties::get_showhiddenhandles ( ) const
inline

Definition at line 3347 of file graphics.h.

References radio_property::current_value().

◆ get_units()

std::string root_figure::properties::get_units ( ) const
inline

Definition at line 3350 of file graphics.h.

References radio_property::current_value().

◆ graphics_object_name()

std::string root_figure::properties::graphics_object_name ( ) const
inlinevirtual

Reimplemented from base_properties.

Definition at line 3271 of file graphics.h.

◆ has_core_property()

bool root_figure::properties::has_core_property ( const caseless_str pname)
static

Definition at line 576 of file graphics-props.cc.

◆ has_property()

bool root_figure::properties::has_property ( const caseless_str pname) const
virtual

Reimplemented from base_properties.

Definition at line 630 of file graphics-props.cc.

◆ has_readonly_property()

bool root_figure::properties::has_readonly_property ( const caseless_str pname)
static

Definition at line 610 of file graphics-props.cc.

◆ is_showhiddenhandles()

bool root_figure::properties::is_showhiddenhandles ( ) const
inline

Definition at line 3346 of file graphics.h.

References bool_property::is_on().

◆ readonly_property_names()

std::set< std::string > root_figure::properties::readonly_property_names ( )
static

Definition at line 584 of file graphics-props.cc.

References base_properties::readonly_property_names().

◆ remove_child()

void root_figure::properties::remove_child ( const graphics_handle h,
bool  from_root = false 
)
virtual

◆ set()

void root_figure::properties::set ( const caseless_str pname,
const octave_value val 
)
virtual

Reimplemented from base_properties.

Definition at line 400 of file graphics-props.cc.

◆ set_callbackobject()

void root_figure::properties::set_callbackobject ( const octave_value val)

Definition at line 3588 of file graphics.cc.

References isnan(), and octave_handle::value().

◆ set_commandwindowsize()

void root_figure::properties::set_commandwindowsize ( const octave_value val)
inline

Definition at line 3355 of file graphics.h.

References base_property::set().

◆ set_currentfigure()

void root_figure::properties::set_currentfigure ( const octave_value val)

Definition at line 3601 of file graphics.cc.

References isnan(), and octave_handle::value().

◆ set_fixedwidthfontname()

void root_figure::properties::set_fixedwidthfontname ( const octave_value val)
inline

Definition at line 3365 of file graphics.h.

References base_property::set().

◆ set_monitorpositions()

void root_figure::properties::set_monitorpositions ( const octave_value val)
inline

Definition at line 3373 of file graphics.h.

References base_property::set().

◆ set_pointerlocation()

void root_figure::properties::set_pointerlocation ( const octave_value val)
inline

Definition at line 3381 of file graphics.h.

References base_property::set().

◆ set_pointerwindow()

void root_figure::properties::set_pointerwindow ( const octave_value val)
inline

Definition at line 3389 of file graphics.h.

References base_property::set().

◆ set_screendepth()

void root_figure::properties::set_screendepth ( const octave_value val)
inline

Definition at line 3397 of file graphics.h.

References base_property::set().

◆ set_screenpixelsperinch()

void root_figure::properties::set_screenpixelsperinch ( const octave_value val)
inline

Definition at line 3405 of file graphics.h.

References base_property::set().

◆ set_screensize()

void root_figure::properties::set_screensize ( const octave_value val)
inline

Definition at line 3413 of file graphics.h.

References base_property::set().

◆ set_showhiddenhandles()

void root_figure::properties::set_showhiddenhandles ( const octave_value val)
inline

Definition at line 3421 of file graphics.h.

References base_property::set().

◆ set_units()

void root_figure::properties::set_units ( const octave_value val)
inline

Definition at line 3429 of file graphics.h.

References base_property::set().

◆ units_is()

bool root_figure::properties::units_is ( const std::string &  v) const
inline

Definition at line 3349 of file graphics.h.

References radio_property::is().

◆ update_units()

void root_figure::properties::update_units ( )

Definition at line 3666 of file graphics.cc.


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