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 | Private Types | Private Member Functions | Private Attributes | List of all members
children_property Class Reference

#include "graphics.in.h"

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

Public Member Functions

 children_property (const children_property &p)
 
 children_property (const std::string &nm, const graphics_handle &h, const Matrix &val)
 
 children_property (void)
 
void add_listener (const octave_value &v, listener_mode mode=GCB_POSTSET)
 
void adopt (double val)
 
base_property * clone (void) const
 
void delete_children (bool clear=false, bool from_root=false)
 
void delete_listener (const octave_value &v=octave_value(), listener_mode mode=GCB_POSTSET)
 
octave_value get (void) const
 
Matrix get_all (void) const
 
Matrix get_children (void) const
 
Matrix get_hidden (void) const
 
int get_id (void) const
 
std::string get_name (void) const
 
graphics_handle get_parent (void) const
 
bool is_hidden (void) const
 
virtual bool is_radio (void) const
 
bool ok (void) const
 
children_property & operator= (const octave_value &val)
 
bool remove_child (double val)
 
void renumber (graphics_handle old_gh, graphics_handle new_gh)
 
OCTINTERP_API void run_listeners (listener_mode mode=GCB_POSTSET)
 
OCTINTERP_API bool set (const octave_value &v, bool do_run=true, bool do_notify_toolkit=true)
 
void set_hidden (bool flag)
 
void set_id (int d)
 
void set_name (const std::string &s)
 
void set_parent (const graphics_handle &h)
 
virtual Cell values_as_cell (void) const
 
virtual std::string values_as_string (void) const
 

Protected Member Functions

bool do_set (const octave_value &val)
 

Private Types

typedef std::list< double >::iterator children_list_iterator
 
typedef std::list< double >::const_iterator const_children_list_iterator
 
typedef std::map< listener_mode, octave_value_list > listener_map
 
typedef std::map< listener_mode, octave_value_list >::const_iterator listener_map_const_iterator
 
typedef std::map< listener_mode, octave_value_list >::iterator listener_map_iterator
 

Private Member Functions

void do_adopt_child (double val)
 
void do_delete_children (bool clear, bool from_root)
 
Matrix do_get_all_children (void) const
 
Matrix do_get_children (bool return_hidden) const
 
void do_init_children (const Matrix &val)
 
void do_init_children (const std::list< double > &val)
 
bool do_remove_child (double child)
 

Private Attributes

std::list< double > children_list
 
octave::refcount< octave_idx_type > count
 
bool hidden
 
int id
 
listener_map listeners
 
std::string name
 
graphics_handle parent
 

Detailed Description

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

Member Typedef Documentation

◆ children_list_iterator

typedef std::list<double>::iterator children_property::children_list_iterator
private

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

◆ const_children_list_iterator

typedef std::list<double>::const_iterator children_property::const_children_list_iterator
private

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

◆ listener_map

typedef std::map<listener_mode, octave_value_list> base_property::listener_map
privateinherited

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

◆ listener_map_const_iterator

typedef std::map<listener_mode, octave_value_list>::const_iterator base_property::listener_map_const_iterator
privateinherited

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

◆ listener_map_iterator

typedef std::map<listener_mode, octave_value_list>::iterator base_property::listener_map_iterator
privateinherited

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

Constructor & Destructor Documentation

◆ children_property() [1/3]

children_property::children_property ( void  )
inline

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

References do_init_children().

Referenced by clone().

◆ children_property() [2/3]

children_property::children_property ( const std::string &  nm,
const graphics_handle &  h,
const Matrix &  val 
)
inline

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

References do_init_children().

◆ children_property() [3/3]

children_property::children_property ( const children_property &  p)
inline

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

References children_list, and do_init_children().

Member Function Documentation

◆ add_listener()

void base_property::add_listener ( const octave_value &  v,
listener_mode  mode = GCB_POSTSET 
)
inlineinherited

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

References octave_value_list::length(), base_property::listeners, and octave_value_list::resize().

Referenced by property::add_listener().

◆ adopt()

void children_property::adopt ( double  val)
inline

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

References do_adopt_child().

◆ clone()

base_property* children_property::clone ( void  ) const
inlinevirtual

Reimplemented from base_property.

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

References children_property().

◆ delete_children()

void children_property::delete_children ( bool  clear = false,
bool  from_root = false 
)
inline

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

References do_delete_children().

◆ delete_listener()

void base_property::delete_listener ( const octave_value &  v = octave_value (),
listener_mode  mode = GCB_POSTSET 
)
inlineinherited

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

References GCB_PERSISTENT, octave_value_list::length(), base_property::listeners, and octave_value_list::resize().

Referenced by property::delete_listener().

◆ do_adopt_child()

void children_property::do_adopt_child ( double  val)
inlineprivate

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

References children_list.

Referenced by adopt().

◆ do_delete_children()

void children_property::do_delete_children ( bool  clear,
bool  from_root 
)
private

Definition at line 1845 of file graphics.cc.

References octave::__get_gh_manager__(), children_list, gh_manager::free(), gh_manager::get_object(), graphics_object::get_properties(), and graphics_object::valid_object().

Referenced by delete_children().

◆ do_get_all_children()

Matrix children_property::do_get_all_children ( void  ) const
inlineprivate

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

References children_list, and retval.

Referenced by get_all().

◆ do_get_children()

Matrix children_property::do_get_children ( bool  return_hidden) const
private

Definition at line 1805 of file graphics.cc.

References octave::__get_gh_manager__(), children_list, gh_manager::get_object(), graphics_object::get_properties(), gh_manager::is_handle_visible(), Array< T >::resize(), and retval.

Referenced by do_set(), get_children(), and get_hidden().

◆ do_init_children() [1/2]

void children_property::do_init_children ( const Matrix &  val)
inlineprivate

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

References children_list, Array< T >::numel(), and Array< T >::xelem().

Referenced by children_property().

◆ do_init_children() [2/2]

void children_property::do_init_children ( const std::list< double > &  val)
inlineprivate

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

References children_list.

◆ do_remove_child()

bool children_property::do_remove_child ( double  child)
inlineprivate

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

References children_list.

Referenced by remove_child().

◆ do_set()

bool children_property::do_set ( const octave_value &  val)
inlineprotectedvirtual

Reimplemented from base_property.

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

References children_list, do_get_children(), error(), get_hidden(), octave_value::matrix_value(), Array< T >::numel(), MArray< T >::reshape(), Array< T >::sort(), Matrix::stack(), and Array< T >::xelem().

◆ get()

octave_value children_property::get ( void  ) const
inlinevirtual

Reimplemented from base_property.

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

References get_children(), and octave_value().

◆ get_all()

Matrix children_property::get_all ( void  ) const
inline

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

References do_get_all_children().

◆ get_children()

Matrix children_property::get_children ( void  ) const
inline

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

References do_get_children().

Referenced by get().

◆ get_hidden()

Matrix children_property::get_hidden ( void  ) const
inline

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

References do_get_children().

Referenced by do_set().

◆ get_id()

int base_property::get_id ( void  ) const
inlineinherited

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

References base_property::id.

Referenced by property::get_id().

◆ get_name()

std::string base_property::get_name ( void  ) const
inlineinherited

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

References base_property::name.

Referenced by string_array_property::string_array_property(), double_radio_property::current_value(), radio_property::do_set(), color_property::do_set(), double_property::do_set(), double_radio_property::do_set(), array_property::do_set(), handle_property::do_set(), callback_property::do_set(), string_property::do_set(), string_array_property::do_set(), text_label_property::do_set(), double_radio_property::double_value(), property::get_name(), and array_property::validate().

◆ get_parent()

graphics_handle base_property::get_parent ( void  ) const
inlineinherited

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

References base_property::parent.

Referenced by callback_property::execute(), and property::get_parent().

◆ is_hidden()

bool base_property::is_hidden ( void  ) const
inlineinherited

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

References base_property::hidden.

Referenced by property::is_hidden().

◆ is_radio()

virtual bool base_property::is_radio ( void  ) const
inlinevirtualinherited

Reimplemented in double_radio_property, color_property, and radio_property.

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

Referenced by property::is_radio().

◆ ok()

bool base_property::ok ( void  ) const
inlineinherited

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

References octave_handle::ok(), and base_property::parent.

Referenced by property::ok().

◆ operator=()

children_property& children_property::operator= ( const octave_value &  val)
inline

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

References base_property::set().

◆ remove_child()

bool children_property::remove_child ( double  val)
inline

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

References do_remove_child().

◆ renumber()

void children_property::renumber ( graphics_handle  old_gh,
graphics_handle  new_gh 
)
inline

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

References children_list, error(), and octave_handle::value().

◆ run_listeners()

void base_property::run_listeners ( listener_mode  mode = GCB_POSTSET)
inherited

Definition at line 1283 of file graphics.cc.

References octave::__get_gh_manager__(), gh_manager::execute_listener(), octave_value_list::length(), base_property::listeners, and base_property::parent.

Referenced by property::run_listeners(), and base_property::set().

◆ set()

bool base_property::set ( const octave_value &  v,
bool  do_run = true,
bool  do_notify_toolkit = true 
)
inherited

Definition at line 1257 of file graphics.cc.

References octave::__get_gh_manager__(), base_property::do_set(), GCB_POSTSET, gh_manager::get_object(), base_property::parent, base_property::run_listeners(), and graphics_object::update().

Referenced by base_property::operator=(), string_property::operator=(), string_array_property::operator=(), text_label_property::operator=(), radio_property::operator=(), color_property::operator=(), double_property::operator=(), double_radio_property::operator=(), array_property::operator=(), row_vector_property::operator=(), bool_property::operator=(), handle_property::operator=(), any_property::operator=(), operator=(), callback_property::operator=(), and property::set().

◆ set_hidden()

void base_property::set_hidden ( bool  flag)
inlineinherited

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

References base_property::hidden.

Referenced by property::set_hidden().

◆ set_id()

void base_property::set_id ( int  d)
inlineinherited

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

References d.

Referenced by property::set_id().

◆ set_name()

void base_property::set_name ( const std::string &  s)
inlineinherited

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

References base_property::name.

Referenced by property::set_name().

◆ set_parent()

void base_property::set_parent ( const graphics_handle &  h)
inlineinherited

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

References base_property::parent.

Referenced by property::set_parent().

◆ values_as_cell()

virtual Cell base_property::values_as_cell ( void  ) const
inlinevirtualinherited

Reimplemented in color_property, and radio_property.

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

References error(), and base_property::name.

Referenced by property::values_as_cell().

◆ values_as_string()

virtual std::string base_property::values_as_string ( void  ) const
inlinevirtualinherited

Reimplemented in color_property, and radio_property.

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

References error(), and base_property::name.

Referenced by property::values_as_string().

Member Data Documentation

◆ children_list

std::list<double> children_property::children_list
private

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

Referenced by children_property(), do_adopt_child(), do_delete_children(), do_get_all_children(), do_get_children(), do_init_children(), do_remove_child(), do_set(), and renumber().

◆ count

octave::refcount<octave_idx_type> base_property::count
privateinherited

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

Referenced by property::property(), property::~property(), and property::operator=().

◆ hidden

bool base_property::hidden
privateinherited

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

Referenced by base_property::is_hidden(), and base_property::set_hidden().

◆ id

int base_property::id
privateinherited

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

Referenced by base_property::get_id().

◆ listeners

listener_map base_property::listeners
privateinherited

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

Referenced by base_property::add_listener(), base_property::delete_listener(), and base_property::run_listeners().

◆ name

std::string base_property::name
privateinherited

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

Referenced by base_property::do_set(), base_property::get(), base_property::get_name(), base_property::set_name(), base_property::values_as_cell(), and base_property::values_as_string().

◆ parent

graphics_handle base_property::parent
privateinherited

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

Referenced by base_property::get_parent(), base_property::ok(), base_property::run_listeners(), base_property::set(), and base_property::set_parent().

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