This class centralizes the formatting information (color, line width, alpha) for the Guidelines. More...

#include <GuidelineFormat.h>

Collaboration diagram for GuidelineFormat:

Public Types
enum	HoverOption { HOVER_OFF , HOVER_ON }
	Public enum. More...

Public Member Functions
	GuidelineFormat (ColorPalette color)
	Single constructor.

	~GuidelineFormat ()

QColor	colorDeployedHover () const
	Guideline color when hovering.

QColor	colorDeployedNonHover () const
	Guideline color when not hovering.

QColor	colorHidden () const
	Color when object is transparent but still handling (probably hover) events.

double	lineWidthHover () const
	Guideline line width.

double	lineWidthNonHover () const
	Guideline line width for narrow lines.

Detailed Description

This class centralizes the formatting information (color, line width, alpha) for the Guidelines.

Definition at line 14 of file GuidelineFormat.h.

Member Enumeration Documentation

◆ HoverOption

enum GuidelineFormat::HoverOption

Public enum.

Enumerator
HOVER_OFF
HOVER_ON

Definition at line 22 of file GuidelineFormat.h.

                   {
    HOVER_OFF,
    HOVER_ON
  };

Constructor & Destructor Documentation

◆ GuidelineFormat()

GuidelineFormat::GuidelineFormat ( ColorPalette color )

Single constructor.

Definition at line 11 of file GuidelineFormat.cpp.

                                                   :
  m_color (ColorPaletteToQColor (color))
{
}

◆ ~GuidelineFormat()

GuidelineFormat::~GuidelineFormat ( )

Definition at line 16 of file GuidelineFormat.cpp.

17{

18}

Member Function Documentation

◆ colorDeployedHover()

QColor GuidelineFormat::colorDeployedHover ( ) const

Guideline color when hovering.

Definition at line 20 of file GuidelineFormat.cpp.

{
  QColor color (m_color);
  color.setAlphaF (0.8);
 
  return color;
}

◆ colorDeployedNonHover()

QColor GuidelineFormat::colorDeployedNonHover ( ) const

Guideline color when not hovering.

Definition at line 28 of file GuidelineFormat.cpp.

{
  return m_color;
}

◆ colorHidden()

QColor GuidelineFormat::colorHidden ( ) const

Color when object is transparent but still handling (probably hover) events.

Definition at line 33 of file GuidelineFormat.cpp.

{
  return QColor (Qt::transparent);
}

◆ lineWidthHover()

double GuidelineFormat::lineWidthHover ( ) const

Guideline line width.

Definition at line 38 of file GuidelineFormat.cpp.

{
  return 5.0; // Wide so easy to see and click on
}

◆ lineWidthNonHover()

double GuidelineFormat::lineWidthNonHover ( ) const

Guideline line width for narrow lines.

Definition at line 43 of file GuidelineFormat.cpp.

{
  return 0.8; // Narrow for precision
}

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

Guideline/GuidelineFormat.h
Guideline/GuidelineFormat.cpp

Public Types

Public Member Functions