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

#include "graphics.h"

Inheritance diagram for color_property:
base_property

Public Member Functions

 color_property ()=delete
 
 color_property (const color_values &c, const radio_values &v)
 
 color_property (const radio_values &v, const color_values &c)
 
 color_property (const std::string &nm, const graphics_handle &h, const color_property &v)
 
 color_property (const std::string &nm, const graphics_handle &h, const color_values &c=color_values(), const radio_values &v=radio_values())
 
 color_property (const std::string &nm, const graphics_handle &h, const radio_values &v)
 
 color_property (const std::string &nm, const graphics_handle &h, const std::string &v)
 
 ~color_property ()=default
 
base_propertyclone () const
 
const std::string & current_value () const
 
octave_value get () const
 
bool is (const std::string &v) const
 
bool is_radio () const
 
bool is_rgb () const
 
 operator octave_value () const
 
color_propertyoperator= (const octave_value &val)
 
Matrix rgb () const
 
Cell values_as_cell () const
 
std::string values_as_string () const
 
- Public Member Functions inherited from base_property
 base_property ()
 
 base_property (const base_property &p)
 
 base_property (const std::string &s, const graphics_handle &h)
 
virtual ~base_property ()=default
 
void add_listener (const octave_value &v, listener_mode mode=GCB_POSTSET)
 
void delete_listener (const octave_value &v=octave_value(), listener_mode mode=GCB_POSTSET)
 
int get_id () const
 
std::string get_name () const
 
graphics_handle get_parent () const
 
bool is_hidden () const
 
bool ok () const
 
base_propertyoperator= (const base_property &)=delete
 
base_propertyoperator= (const octave_value &val)
 
void run_listeners (listener_mode mode=GCB_POSTSET)
 
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)
 

Protected Member Functions

bool do_set (const octave_value &newval)
 

Detailed Description

Definition at line 1069 of file graphics.h.

Constructor & Destructor Documentation

◆ color_property() [1/7]

color_property::color_property ( )
delete

◆ color_property() [2/7]

color_property::color_property ( const color_values c,
const radio_values v 
)
inline

Definition at line 1075 of file graphics.h.

◆ color_property() [3/7]

color_property::color_property ( const radio_values v,
const color_values c 
)
inline

Definition at line 1081 of file graphics.h.

◆ color_property() [4/7]

color_property::color_property ( const std::string &  nm,
const graphics_handle h,
const color_values c = color_values (),
const radio_values v = radio_values () 
)
inline

Definition at line 1087 of file graphics.h.

◆ color_property() [5/7]

color_property::color_property ( const std::string &  nm,
const graphics_handle h,
const radio_values v 
)
inline

Definition at line 1095 of file graphics.h.

◆ color_property() [6/7]

color_property::color_property ( const std::string &  nm,
const graphics_handle h,
const std::string &  v 
)
inline

Definition at line 1102 of file graphics.h.

◆ color_property() [7/7]

color_property::color_property ( const std::string &  nm,
const graphics_handle h,
const color_property v 
)
inline

Definition at line 1109 of file graphics.h.

◆ ~color_property()

color_property::~color_property ( )
default

Member Function Documentation

◆ clone()

base_property* color_property::clone ( ) const
inlinevirtual

Reimplemented from base_property.

Definition at line 1160 of file graphics.h.

◆ current_value()

const std::string& color_property::current_value ( ) const
inline

Definition at line 1144 of file graphics.h.

References error().

◆ do_set()

bool color_property::do_set ( const octave_value newval)
protectedvirtual

◆ get()

octave_value color_property::get ( ) const
inlinevirtual

Reimplemented from base_property.

Definition at line 1121 of file graphics.h.

Referenced by axes::properties::get_ambientlightcolor(), text::properties::get_backgroundcolor(), uicontrol::properties::get_backgroundcolor(), uibuttongroup::properties::get_backgroundcolor(), uipanel::properties::get_backgroundcolor(), figure::properties::get_color(), axes::properties::get_color(), line::properties::get_color(), text::properties::get_color(), light::properties::get_color(), text::properties::get_edgecolor(), patch::properties::get_edgecolor(), surface::properties::get_edgecolor(), patch::properties::get_facecolor(), surface::properties::get_facecolor(), uimenu::properties::get_foregroundcolor(), uicontrol::properties::get_foregroundcolor(), uibuttongroup::properties::get_foregroundcolor(), uipanel::properties::get_foregroundcolor(), uitable::properties::get_foregroundcolor(), axes::properties::get_gridcolor(), uibuttongroup::properties::get_highlightcolor(), uipanel::properties::get_highlightcolor(), line::properties::get_markeredgecolor(), patch::properties::get_markeredgecolor(), scatter::properties::get_markeredgecolor(), surface::properties::get_markeredgecolor(), line::properties::get_markerfacecolor(), patch::properties::get_markerfacecolor(), scatter::properties::get_markerfacecolor(), surface::properties::get_markerfacecolor(), axes::properties::get_minorgridcolor(), uibuttongroup::properties::get_shadowcolor(), uipanel::properties::get_shadowcolor(), axes::properties::get_xcolor(), axes::properties::get_ycolor(), and axes::properties::get_zcolor().

◆ is()

bool color_property::is ( const std::string &  v) const
inline

Definition at line 1133 of file graphics.h.

Referenced by axes::properties::ambientlightcolor_is(), text::properties::backgroundcolor_is(), uicontrol::properties::backgroundcolor_is(), uibuttongroup::properties::backgroundcolor_is(), uipanel::properties::backgroundcolor_is(), figure::properties::color_is(), axes::properties::color_is(), line::properties::color_is(), text::properties::color_is(), light::properties::color_is(), text::properties::edgecolor_is(), patch::properties::edgecolor_is(), surface::properties::edgecolor_is(), patch::properties::facecolor_is(), surface::properties::facecolor_is(), uimenu::properties::foregroundcolor_is(), uicontrol::properties::foregroundcolor_is(), uibuttongroup::properties::foregroundcolor_is(), uipanel::properties::foregroundcolor_is(), uitable::properties::foregroundcolor_is(), axes::properties::gridcolor_is(), uibuttongroup::properties::highlightcolor_is(), uipanel::properties::highlightcolor_is(), line::properties::markeredgecolor_is(), patch::properties::markeredgecolor_is(), scatter::properties::markeredgecolor_is(), surface::properties::markeredgecolor_is(), line::properties::markerfacecolor_is(), patch::properties::markerfacecolor_is(), scatter::properties::markerfacecolor_is(), surface::properties::markerfacecolor_is(), axes::properties::minorgridcolor_is(), uibuttongroup::properties::shadowcolor_is(), uipanel::properties::shadowcolor_is(), axes::properties::xcolor_is(), axes::properties::ycolor_is(), and axes::properties::zcolor_is().

◆ is_radio()

bool color_property::is_radio ( ) const
inlinevirtual

Reimplemented from base_property.

Definition at line 1131 of file graphics.h.

◆ is_rgb()

bool color_property::is_rgb ( ) const
inline

Definition at line 1129 of file graphics.h.

Referenced by axes::properties::ambientlightcolor_is_rgb(), text::properties::backgroundcolor_is_rgb(), uicontrol::properties::backgroundcolor_is_rgb(), uibuttongroup::properties::backgroundcolor_is_rgb(), uipanel::properties::backgroundcolor_is_rgb(), figure::properties::color_is_rgb(), axes::properties::color_is_rgb(), line::properties::color_is_rgb(), text::properties::color_is_rgb(), light::properties::color_is_rgb(), text::properties::edgecolor_is_rgb(), patch::properties::edgecolor_is_rgb(), surface::properties::edgecolor_is_rgb(), patch::properties::facecolor_is_rgb(), surface::properties::facecolor_is_rgb(), uimenu::properties::foregroundcolor_is_rgb(), uicontrol::properties::foregroundcolor_is_rgb(), uibuttongroup::properties::foregroundcolor_is_rgb(), uipanel::properties::foregroundcolor_is_rgb(), uitable::properties::foregroundcolor_is_rgb(), axes::properties::get_ambientlightcolor_rgb(), text::properties::get_backgroundcolor_rgb(), uicontrol::properties::get_backgroundcolor_rgb(), uibuttongroup::properties::get_backgroundcolor_rgb(), uipanel::properties::get_backgroundcolor_rgb(), figure::properties::get_color_rgb(), axes::properties::get_color_rgb(), line::properties::get_color_rgb(), text::properties::get_color_rgb(), light::properties::get_color_rgb(), text::properties::get_edgecolor_rgb(), patch::properties::get_edgecolor_rgb(), surface::properties::get_edgecolor_rgb(), patch::properties::get_facecolor_rgb(), surface::properties::get_facecolor_rgb(), uimenu::properties::get_foregroundcolor_rgb(), uicontrol::properties::get_foregroundcolor_rgb(), uibuttongroup::properties::get_foregroundcolor_rgb(), uipanel::properties::get_foregroundcolor_rgb(), uitable::properties::get_foregroundcolor_rgb(), axes::properties::get_gridcolor_rgb(), uibuttongroup::properties::get_highlightcolor_rgb(), uipanel::properties::get_highlightcolor_rgb(), line::properties::get_markeredgecolor_rgb(), patch::properties::get_markeredgecolor_rgb(), scatter::properties::get_markeredgecolor_rgb(), surface::properties::get_markeredgecolor_rgb(), line::properties::get_markerfacecolor_rgb(), patch::properties::get_markerfacecolor_rgb(), scatter::properties::get_markerfacecolor_rgb(), surface::properties::get_markerfacecolor_rgb(), axes::properties::get_minorgridcolor_rgb(), uibuttongroup::properties::get_shadowcolor_rgb(), uipanel::properties::get_shadowcolor_rgb(), axes::properties::get_xcolor_rgb(), axes::properties::get_ycolor_rgb(), axes::properties::get_zcolor_rgb(), axes::properties::gridcolor_is_rgb(), uibuttongroup::properties::highlightcolor_is_rgb(), uipanel::properties::highlightcolor_is_rgb(), line::properties::markeredgecolor_is_rgb(), patch::properties::markeredgecolor_is_rgb(), scatter::properties::markeredgecolor_is_rgb(), surface::properties::markeredgecolor_is_rgb(), line::properties::markerfacecolor_is_rgb(), patch::properties::markerfacecolor_is_rgb(), scatter::properties::markerfacecolor_is_rgb(), surface::properties::markerfacecolor_is_rgb(), axes::properties::minorgridcolor_is_rgb(), uibuttongroup::properties::shadowcolor_is_rgb(), uipanel::properties::shadowcolor_is_rgb(), axes::properties::xcolor_is_rgb(), axes::properties::ycolor_is_rgb(), and axes::properties::zcolor_is_rgb().

◆ operator octave_value()

color_property::operator octave_value ( ) const
inline

Definition at line 1158 of file graphics.h.

◆ operator=()

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

Definition at line 1152 of file graphics.h.

◆ rgb()

Matrix color_property::rgb ( ) const
inline

Definition at line 1136 of file graphics.h.

References error().

Referenced by axes::properties::get_ambientlightcolor_rgb(), text::properties::get_backgroundcolor_rgb(), uicontrol::properties::get_backgroundcolor_rgb(), uibuttongroup::properties::get_backgroundcolor_rgb(), uipanel::properties::get_backgroundcolor_rgb(), figure::properties::get_color_rgb(), axes::properties::get_color_rgb(), line::properties::get_color_rgb(), text::properties::get_color_rgb(), light::properties::get_color_rgb(), text::properties::get_edgecolor_rgb(), patch::properties::get_edgecolor_rgb(), surface::properties::get_edgecolor_rgb(), patch::properties::get_facecolor_rgb(), surface::properties::get_facecolor_rgb(), uimenu::properties::get_foregroundcolor_rgb(), uicontrol::properties::get_foregroundcolor_rgb(), uibuttongroup::properties::get_foregroundcolor_rgb(), uipanel::properties::get_foregroundcolor_rgb(), uitable::properties::get_foregroundcolor_rgb(), axes::properties::get_gridcolor_rgb(), uibuttongroup::properties::get_highlightcolor_rgb(), uipanel::properties::get_highlightcolor_rgb(), line::properties::get_markeredgecolor_rgb(), patch::properties::get_markeredgecolor_rgb(), scatter::properties::get_markeredgecolor_rgb(), surface::properties::get_markeredgecolor_rgb(), line::properties::get_markerfacecolor_rgb(), patch::properties::get_markerfacecolor_rgb(), scatter::properties::get_markerfacecolor_rgb(), surface::properties::get_markerfacecolor_rgb(), axes::properties::get_minorgridcolor_rgb(), uibuttongroup::properties::get_shadowcolor_rgb(), uipanel::properties::get_shadowcolor_rgb(), axes::properties::get_xcolor_rgb(), axes::properties::get_ycolor_rgb(), and axes::properties::get_zcolor_rgb().

◆ values_as_cell()

Cell color_property::values_as_cell ( ) const
inlinevirtual

Reimplemented from base_property.

Definition at line 1165 of file graphics.h.

◆ values_as_string()

std::string color_property::values_as_string ( ) const
inlinevirtual

Reimplemented from base_property.

Definition at line 1162 of file graphics.h.


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