Axis title and its drawing attributes.

Author: Sergey Linev s.lin.nosp@m.ev@g.nosp@m.si.de

Date: 2021-06-28

Warning: This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!

Definition at line 49 of file RAttrAxis.hxx.

Public Types
enum	EAlign { kLeftBottom = 11 , kLeftCenter = 12 , kLeftTop = 13 , kCenterBottom = 21 , kCenter = 22 , kCenterTop = 23 , kRightBottom = 31 , kRightCenter = 32 , kRightTop = 33 }

Public Member Functions
	RAttrAxisTitle ()=default

	RAttrAxisTitle (const RAttrAxisTitle &src)

	RAttrAxisTitle (RAttrBase parent, const char prefix="title")

	RAttrAxisTitle (RDrawable drawable, const char prefix="title")

void	Clear () override
	Clear all respective values from drawable. Only defaults can be used.

RAttrAxisTitle &	operator= (const RAttrAxisTitle &src)

RAttrAxisTitle &	operator= (const std::string &_title)

void	SetCenter ()

void	SetLeft ()

void	SetRight ()

Public Attributes
RAttrValue< EAlign >	align {this, "align", kCenter}
	! text align

RAttrValue< double >	angle {this, "angle", 0.}
	! text angle

RAttrValue< RColor >	color {this, "color", RColor::kBlack}
	! text color

RAttrFont	font {this, "font"}
	! text font

RAttrValue< RPadLength >	offset {this, "offset", {}}
	! axis title offset - relative to "default" position

RAttrValue< std::string >	position {this, "position", "right"}
	! axis title position - left, right, center

RAttrValue< double >	size {this, "size", 12.}
	! text size

RAttrValue< std::string >	value {this, "value", ""}
	! axis title value

Protected Member Functions
const Rec_t	AccessAttr (const std::string &name) const
	Find attributes container and full-qualified name for value.

const Val_t	AccessValue (const std::string &name, bool use_style=true) const
	Search value with given name in attributes.

void	ClearValue (const std::string &name)
	Clear value if any with specified name.

RAttrMap	CollectDefaults () const override
	Collect all attributes in derived class Works only if such class has dictionary.

void	CopyTo (RAttrAggregation &tgt, bool use_style=true) const
	Copy attributes into target object.

bool	CopyValue (const std::string &name, const RAttrMap::Value_t &value, bool check_type=true)
	Copy attributes from other object.

Rec_t	EnsureAttr (const std::string &name)
	Ensure attribute with give name exists - creates container for attributes if required.

const RAttrMap &	GetDefaults () const override
	Return default values for attributes, empty for base class.

RDrawable *	GetDrawable () const

RAttrMap *	GetOwnAttr () const

RAttrBase *	GetParent () const

const char *	GetPrefix () const

bool	IsAggregation () const final

bool	IsSame (const RAttrAggregation &src, bool use_style=true) const
	Check if all values which are evaluated in this object are exactly the same as in tgt object.

bool	IsValueEqual (const std::string &name, const RAttrMap::Value_t &value, bool use_style=false) const
	Check if provided value equal to attribute in the map.

void	MoveTo (RAttrBase &tgt)
	Move all fields into target object.

void	SetNoValue (const std::string &name)
	Set `<NoValue>` for attribute.

Private Types
enum	{ kDrawable , kParent , kOwnAttr }

Private Member Functions
void	ClearData ()
	Clear internal data.

RAttrMap *	CreateOwnAttr ()
	Creates own attribute - only if no drawable and no parent are assigned.

Private Attributes
const char *	fPrefix {nullptr}
	! name prefix for all attributes values

enum ROOT::Experimental::RAttrBase:: { ... }	kDrawable
	! kind of data

union {

RDrawable * drawable

RAttrMap * ownattr

RAttrBase * parent

}	nullptr
	! data

#include <ROOT/RAttrAxis.hxx>

Inheritance diagram for ROOT::Experimental::RAttrAxisTitle:

[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

privateinherited

Enumerator
kDrawable
kParent
kOwnAttr

Definition at line 37 of file RAttrBase.hxx.

◆ EAlign

enum ROOT::Experimental::RAttrText::EAlign

inherited

Enumerator
kLeftBottom
kLeftCenter
kLeftTop
kCenterBottom
kCenter
kCenterTop
kRightBottom
kRightCenter
kRightTop

Definition at line 33 of file RAttrText.hxx.

Constructor & Destructor Documentation

◆ RAttrAxisTitle() [1/4]

ROOT::Experimental::RAttrAxisTitle::RAttrAxisTitle ( )

default

◆ RAttrAxisTitle() [2/4]

ROOT::Experimental::RAttrAxisTitle::RAttrAxisTitle	(	RDrawable *	drawable,
		const char *	prefix = "title" )

inline

Definition at line 51 of file RAttrAxis.hxx.

◆ RAttrAxisTitle() [3/4]

ROOT::Experimental::RAttrAxisTitle::RAttrAxisTitle	(	RAttrBase *	parent,
		const char *	prefix = "title" )

inline

Definition at line 51 of file RAttrAxis.hxx.

◆ RAttrAxisTitle() [4/4]

ROOT::Experimental::RAttrAxisTitle::RAttrAxisTitle ( const RAttrAxisTitle & src )

inline

Definition at line 51 of file RAttrAxis.hxx.

Member Function Documentation

◆ AccessAttr()

const Rec_t ROOT::Experimental::RAttrBase::AccessAttr ( const std::string & name ) const

inlineprotectedinherited

Find attributes container and full-qualified name for value.

Definition at line 70 of file RAttrBase.hxx.

◆ AccessValue()

const Val_t ROOT::Experimental::RAttrBase::AccessValue	(	const std::string &	name,
		bool	use_style = true ) const

inlineprotectedinherited

Search value with given name in attributes.

Definition at line 95 of file RAttrBase.hxx.

◆ Clear()

void RAttrAggregation::Clear ( )

overridevirtualinherited

Clear all respective values from drawable. Only defaults can be used.

Implements ROOT::Experimental::RAttrBase.

Definition at line 118 of file RAttrAggregation.cxx.

◆ ClearData()

void RAttrBase::ClearData ( )

privateinherited

Clear internal data.

Definition at line 26 of file RAttrBase.cxx.

◆ ClearValue()

void RAttrBase::ClearValue ( const std::string & name )

protectedinherited

Clear value if any with specified name.

Definition at line 54 of file RAttrBase.cxx.

◆ CollectDefaults()

RAttrMap RAttrAggregation::CollectDefaults ( ) const

overrideprotectedvirtualinherited

Collect all attributes in derived class Works only if such class has dictionary.

In special cases one has to provide special implementation directly

Implements ROOT::Experimental::RAttrBase.

Definition at line 37 of file RAttrAggregation.cxx.

◆ CopyTo()

void RAttrAggregation::CopyTo	(	RAttrAggregation &	tgt,
		bool	use_style = true ) const

protectedinherited

Copy attributes into target object.

Definition at line 60 of file RAttrAggregation.cxx.

◆ CopyValue()

bool RAttrAggregation::CopyValue	(	const std::string &	name,
		const RAttrMap::Value_t &	value,
		bool	check_type = true )

protectedinherited

Copy attributes from other object.

Definition at line 71 of file RAttrAggregation.cxx.

◆ CreateOwnAttr()

RAttrMap * RAttrBase::CreateOwnAttr ( )

privateinherited

Creates own attribute - only if no drawable and no parent are assigned.

Definition at line 37 of file RAttrBase.cxx.

◆ EnsureAttr()

Rec_t ROOT::Experimental::RAttrBase::EnsureAttr ( const std::string & name )

inlineprotectedinherited

Ensure attribute with give name exists - creates container for attributes if required.

Definition at line 112 of file RAttrBase.hxx.

◆ GetDefaults()

const RAttrMap & ROOT::Experimental::RAttrAxisTitle::GetDefaults ( ) const

inlineoverrideprotectedvirtual

Return default values for attributes, empty for base class.

Reimplemented from ROOT::Experimental::RAttrAggregation.

Definition at line 51 of file RAttrAxis.hxx.

◆ GetDrawable()

RDrawable * ROOT::Experimental::RAttrBase::GetDrawable ( ) const

inlineprotectedinherited

Definition at line 52 of file RAttrBase.hxx.

◆ GetOwnAttr()

RAttrMap * ROOT::Experimental::RAttrBase::GetOwnAttr ( ) const

inlineprotectedinherited

Definition at line 54 of file RAttrBase.hxx.

◆ GetParent()

RAttrBase * ROOT::Experimental::RAttrBase::GetParent ( ) const

inlineprotectedinherited

Definition at line 53 of file RAttrBase.hxx.

◆ GetPrefix()

const char * ROOT::Experimental::RAttrBase::GetPrefix ( ) const

inlineprotectedinherited

Definition at line 153 of file RAttrBase.hxx.

◆ IsAggregation()

bool ROOT::Experimental::RAttrAggregation::IsAggregation ( ) const

inlinefinalprotectedvirtualinherited

Reimplemented from ROOT::Experimental::RAttrBase.

Definition at line 33 of file RAttrAggregation.hxx.

◆ IsSame()

bool RAttrAggregation::IsSame	(	const RAttrAggregation &	src,
		bool	use_style = true ) const

protectedinherited

Check if all values which are evaluated in this object are exactly the same as in tgt object.

Definition at line 103 of file RAttrAggregation.cxx.

◆ IsValueEqual()

bool RAttrAggregation::IsValueEqual	(	const std::string &	name,
		const RAttrMap::Value_t &	value,
		bool	use_style = false ) const

protectedinherited

Check if provided value equal to attribute in the map.

Definition at line 91 of file RAttrAggregation.cxx.

◆ MoveTo()

void RAttrBase::MoveTo ( RAttrBase & tgt )

protectedinherited

Move all fields into target object.

Definition at line 73 of file RAttrBase.cxx.

◆ operator=() [1/2]

RAttrAxisTitle & ROOT::Experimental::RAttrAxisTitle::operator= ( const RAttrAxisTitle & src )

inline

Definition at line 51 of file RAttrAxis.hxx.

◆ operator=() [2/2]

RAttrAxisTitle & ROOT::Experimental::RAttrAxisTitle::operator= ( const std::string & _title )

inline

Definition at line 59 of file RAttrAxis.hxx.

◆ SetCenter()

void ROOT::Experimental::RAttrAxisTitle::SetCenter ( )

inline

Definition at line 62 of file RAttrAxis.hxx.

◆ SetLeft()

void ROOT::Experimental::RAttrAxisTitle::SetLeft ( )

inline

Definition at line 61 of file RAttrAxis.hxx.

◆ SetNoValue()

void RAttrBase::SetNoValue ( const std::string & name )

protectedinherited

Set <NoValue> for attribute.

Ensure that value can not be configured via style - defaults will be used Equivalent to css syntax { attrname:; }

Definition at line 64 of file RAttrBase.cxx.

◆ SetRight()

void ROOT::Experimental::RAttrAxisTitle::SetRight ( )

inline

Definition at line 63 of file RAttrAxis.hxx.

Member Data Documentation

◆ align

RAttrValue<EAlign> ROOT::Experimental::RAttrText::align {this, "align", kCenter}

inherited

! text align

Definition at line 48 of file RAttrText.hxx.

◆ angle

RAttrValue<double> ROOT::Experimental::RAttrText::angle {this, "angle", 0.}

inherited

! text angle

Definition at line 47 of file RAttrText.hxx.

◆ color

RAttrValue<RColor> ROOT::Experimental::RAttrText::color {this, "color", RColor::kBlack}

inherited

! text color

Definition at line 45 of file RAttrText.hxx.

◆ drawable

RDrawable* ROOT::Experimental::RAttrBase::drawable

inherited

Definition at line 40 of file RAttrBase.hxx.

◆ font

RAttrFont ROOT::Experimental::RAttrText::font {this, "font"}

inherited

! text font

Definition at line 49 of file RAttrText.hxx.

◆ fPrefix

const char* ROOT::Experimental::RAttrBase::fPrefix {nullptr}

privateinherited

! name prefix for all attributes values

Definition at line 45 of file RAttrBase.hxx.

◆ []

enum { ... } ROOT::Experimental::RAttrBase::kDrawable

! kind of data

◆ [union]

union { ... } ROOT::Experimental::RAttrBase::nullptr

! data

◆ offset

RAttrValue<RPadLength> ROOT::Experimental::RAttrAxisTitle::offset {this, "offset", {}}

! axis title offset - relative to "default" position

Definition at line 57 of file RAttrAxis.hxx.

◆ ownattr

RAttrMap* ROOT::Experimental::RAttrBase::ownattr

inherited

Definition at line 42 of file RAttrBase.hxx.

◆ parent

RAttrBase* ROOT::Experimental::RAttrBase::parent

inherited

Definition at line 41 of file RAttrBase.hxx.

◆ position

RAttrValue<std::string> ROOT::Experimental::RAttrAxisTitle::position {this, "position", "right"}

! axis title position - left, right, center

Definition at line 56 of file RAttrAxis.hxx.

◆ size

RAttrValue<double> ROOT::Experimental::RAttrText::size {this, "size", 12.}

inherited

! text size

Definition at line 46 of file RAttrText.hxx.

◆ value

RAttrValue<std::string> ROOT::Experimental::RAttrAxisTitle::value {this, "value", ""}

! axis title value

Definition at line 55 of file RAttrAxis.hxx.

Libraries for ROOT::Experimental::RAttrAxisTitle:

[legend]

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

graf2d/gpadv7/inc/ROOT/RAttrAxis.hxx

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Member Enumeration Documentation

◆ anonymous enum

◆ EAlign

Constructor & Destructor Documentation

◆ RAttrAxisTitle() [1/4]

◆ RAttrAxisTitle() [2/4]

◆ RAttrAxisTitle() [3/4]

◆ RAttrAxisTitle() [4/4]

Member Function Documentation

◆ AccessAttr()

◆ AccessValue()

◆ Clear()

◆ ClearData()

◆ ClearValue()

◆ CollectDefaults()

◆ CopyTo()

◆ CopyValue()

◆ CreateOwnAttr()

◆ EnsureAttr()

◆ GetDefaults()

◆ GetDrawable()

◆ GetOwnAttr()

◆ GetParent()

◆ GetPrefix()

◆ IsAggregation()

◆ IsSame()

◆ IsValueEqual()

◆ MoveTo()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ SetCenter()

◆ SetLeft()

◆ SetNoValue()

◆ SetRight()

Member Data Documentation

◆ align

◆ angle

◆ color

◆ drawable

◆ font

◆ fPrefix

◆ []

◆ [union]

◆ offset

◆ ownattr

◆ parent

◆ position

◆ size

◆ value