NDEVR
API Documentation
PropertyInterface< PaperViewProperty >

Provides a compile-time property interface for reading and writing PaperViewProperty values on a DesignInfo object. More...

Inheritance diagram for PropertyInterface< PaperViewProperty >:
[legend]
Collaboration diagram for PropertyInterface< PaperViewProperty >:
[legend]

Static Public Member Functions

static TableColumncolumn (const DesignInfo *object, PaperViewProperty property)
 Retrieves the TableColumn pointer for a given property on the specified design object.
template<PaperViewProperty t_property, class t_value_type>
static decltype(auto) Get (const DesignInfo *object)
 Gets a PaperViewProperty value from the given design object (typed overload).
template<PaperViewProperty t_property>
static decltype(auto) Get (const DesignInfo *object)
 Gets a PaperViewProperty value from the given design object.
static uint04 index (const DesignInfo *object, PaperViewProperty property)
 Retrieves the row index for a given property on the specified design object.
static bool IsSame (const DesignInfo *object, t_value_type property, const StringView &value)
 Checks whether a property's stored value matches a given string representation.
template<PaperViewProperty t_property, class t_value_type>
static void Set (DesignInfo *object, const t_value_type &value)
 Sets a PaperViewProperty value on the given design object.

Detailed Description

Provides a compile-time property interface for reading and writing PaperViewProperty values on a DesignInfo object.

Delegates to the appropriate PaperView getter/setter based on the template property parameter.

Definition at line 267 of file PaperView.h.

Member Function Documentation

◆ column()

TableColumn * PropertyInterface< PaperViewProperty >::column ( const DesignInfo * object,
PaperViewProperty property )
inlinestatic

Retrieves the TableColumn pointer for a given property on the specified design object.


Parameters
[in]objectThe design object to query.
[in]propertyThe property enum value identifying the column.
Returns
Pointer to the TableColumn storing the property data.

Definition at line 133 of file DesignProperties.h.

◆ Get() [1/2]

template<PaperViewProperty t_property, class t_value_type>
decltype(auto) PropertyInterface< PaperViewProperty >::Get ( const DesignInfo * object)
inlinestatic

Gets a PaperViewProperty value from the given design object (typed overload).

Parameters
[in]objectThe DesignInfo object to read from.
Returns
The value of the specified property.

Definition at line 312 of file PaperView.h.

References Get().

◆ Get() [2/2]

template<PaperViewProperty t_property>
decltype(auto) PropertyInterface< PaperViewProperty >::Get ( const DesignInfo * object)
inlinestatic

Gets a PaperViewProperty value from the given design object.

Parameters
[in]objectThe DesignInfo object to read from.
Returns
The value of the specified property.

Definition at line 294 of file PaperView.h.

References PaperView::dotsPerMeter(), PaperView::margins(), PaperView::paperSize(), and PaperView::worldBounds().

Referenced by Get().

◆ index()

uint04 PropertyInterface< PaperViewProperty >::index ( const DesignInfo * object,
PaperViewProperty property )
inlinestatic

Retrieves the row index for a given property on the specified design object.


Parameters
[in]objectThe design object to query.
[in]propertyThe property enum value.
Returns
The row index into the property column.

Definition at line 144 of file DesignProperties.h.

◆ IsSame()

bool PropertyInterface< PaperViewProperty >::IsSame ( const DesignInfo * object,
t_value_type property,
const StringView & value )
inlinestatic

Checks whether a property's stored value matches a given string representation.


Template Parameters
t_value_typeThe property enum type.
Parameters
[in]objectThe design object to query.
[in]propertyThe property enum value identifying which property to compare.
[in]valueThe string to compare against.
Returns
True if the stored value matches the given string.

Definition at line 222 of file DesignProperties.h.

◆ Set()

template<PaperViewProperty t_property, class t_value_type>
void PropertyInterface< PaperViewProperty >::Set ( DesignInfo * object,
const t_value_type & value )
inlinestatic

Sets a PaperViewProperty value on the given design object.

Parameters
[in]objectThe DesignInfo object to modify.
[in]valueThe value to assign to the specified property.

Definition at line 276 of file PaperView.h.

References PaperView::setDotsPerMeter(), PaperView::setMargins(), PaperView::setPaperSize(), and PaperView::setWorldBounds().


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