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 Attributes | List of all members
bool_property Class Reference

#include "graphics.in.h"

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

Public Member Functions

 bool_property (const bool_property &p)
 
 bool_property (const std::string &nm, const graphics_handle &h, bool val)
 
 bool_property (const std::string &nm, const graphics_handle &h, const char *val)
 
void add_listener (const octave_value &v, listener_mode mode=GCB_POSTSET)
 
base_property * clone (void) const
 
const std::string & current_value (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
 
bool is (const caseless_str &v) const
 
bool is_hidden (void) const
 
bool is_on (void) const
 
bool is_radio (void) const
 
bool ok (void) const
 
bool_property & operator= (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)
 
Cell values_as_cell (void) const
 
std::string values_as_string (void) const
 

Protected Member Functions

bool do_set (const octave_value &val)
 

Private Types

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 Attributes

octave::refcount< octave_idx_type > count
 
std::string current_val
 
bool hidden
 
int id
 
listener_map listeners
 
std::string name
 
graphics_handle parent
 
radio_values vals
 

Detailed Description

Definition at line 1594 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

◆ bool_property() [1/3]

bool_property::bool_property ( const std::string &  nm,
const graphics_handle &  h,
bool  val 
)
inline

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

Referenced by clone().

◆ bool_property() [2/3]

bool_property::bool_property ( const std::string &  nm,
const graphics_handle &  h,
const char *  val 
)
inline

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

◆ bool_property() [3/3]

bool_property::bool_property ( const bool_property &  p)
inline

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

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

◆ clone()

base_property* bool_property::clone ( void  ) const
inlinevirtual

Reimplemented from radio_property.

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

References bool_property().

◆ current_value()

const std::string& radio_property::current_value ( void  ) const
inlineinherited

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

References radio_property::current_val.

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

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

Reimplemented from radio_property.

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

References octave_value::bool_value(), radio_property::do_set(), and octave_value::is_bool_scalar().

◆ get()

octave_value radio_property::get ( void  ) const
inlinevirtualinherited

Reimplemented from base_property.

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

References radio_property::current_val, and octave_value().

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

bool radio_property::is ( const caseless_str &  v) const
inlineinherited

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

References caseless_str::compare(), and radio_property::current_val.

Referenced by is_on().

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

bool bool_property::is_on ( void  ) const
inline

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

References radio_property::is().

◆ is_radio()

bool radio_property::is_radio ( void  ) const
inlinevirtualinherited

Reimplemented from base_property.

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

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

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

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

References base_property::set().

◆ 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=(), operator=(), handle_property::operator=(), any_property::operator=(), children_property::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()

Cell radio_property::values_as_cell ( void  ) const
inlinevirtualinherited

Reimplemented from base_property.

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

References radio_property::vals, and radio_values::values_as_cell().

◆ values_as_string()

std::string radio_property::values_as_string ( void  ) const
inlinevirtualinherited

Reimplemented from base_property.

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

References radio_property::vals, and radio_values::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

std::string radio_property::current_val
privateinherited

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

Referenced by radio_property::current_value(), radio_property::do_set(), radio_property::get(), and radio_property::is().

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

◆ vals

radio_values radio_property::vals
privateinherited

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

Referenced by radio_property::do_set(), radio_property::values_as_cell(), and radio_property::values_as_string().

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