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

#include "graphics.in.h"

Inheritance diagram for handle_property:
Collaboration diagram for handle_property:

Public Member Functions

 handle_property (const handle_property &p)
 
 handle_property (const std::string &nm, const graphics_handle &h, const graphics_handle &val=graphics_handle())
 
void add_constraint (const std::string &type)
 
void add_listener (const octave_value &v, listener_mode mode=GCB_POSTSET)
 
base_propertyclone (void) const
 
void delete_listener (const octave_value &v=octave_value(), listener_mode mode=GCB_POSTSET)
 
octave_value get (void) const
 
int get_id (void) const
 
std::string get_name (void) const
 
graphics_handle get_parent (void) const
 
graphics_handle handle_value (void) const
 
void invalidate (void)
 
bool is_hidden (void) const
 
virtual bool is_radio (void) const
 
bool ok (void) const
 
handle_propertyoperator= (const graphics_handle &h)
 
handle_propertyoperator= (const octave_value &val)
 
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

OCTINTERP_API bool do_set (const octave_value &v)
 

Protected Attributes

std::set< std::string > type_constraints
 

Private Types

typedef std::map< listener_mode, octave_value_listlistener_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 Attributes

octave::refcount< octave_idx_typecount
 
graphics_handle current_val
 
bool hidden
 
int id
 
listener_map listeners
 
std::string name
 
graphics_handle parent
 

Detailed Description

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

Member Typedef Documentation

◆ 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

◆ handle_property() [1/2]

handle_property::handle_property ( const std::string &  nm,
const graphics_handle h,
const graphics_handle val = graphics_handle () 
)
inline

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

Referenced by clone().

◆ handle_property() [2/2]

handle_property::handle_property ( const handle_property p)
inline

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

Member Function Documentation

◆ add_constraint()

void handle_property::add_constraint ( const std::string &  type)
inline

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

References type_constraints.

◆ add_listener()

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

◆ clone()

base_property* handle_property::clone ( void  ) const
inlinevirtual

Reimplemented from base_property.

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

References handle_property().

◆ delete_listener()

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

◆ do_set()

◆ get()

octave_value handle_property::get ( void  ) const
inlinevirtual

Reimplemented from base_property.

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

References octave_handle::as_octave_value(), and current_val.

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()

◆ 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().

◆ handle_value()

graphics_handle handle_property::handle_value ( void  ) const
inline

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

References current_val.

Referenced by axes::properties::delete_text_child(), and axes::properties::set_text_child().

◆ invalidate()

void handle_property::invalidate ( void  )
inline

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

References current_val, and NaN.

◆ 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=() [1/2]

handle_property& handle_property::operator= ( const graphics_handle h)
inline

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

References base_property::set(), and octave_handle::value().

◆ operator=() [2/2]

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

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

References base_property::set().

◆ run_listeners()

◆ 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

◆ 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=().

◆ current_val

graphics_handle handle_property::current_val
private

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

Referenced by do_set(), get(), handle_value(), and invalidate().

◆ 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

◆ name

◆ parent

◆ type_constraints

std::set<std::string> handle_property::type_constraints
protected

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

Referenced by add_constraint(), and do_set().


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