LuciadCPillar 2024.1.05
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
luciad::BackgroundStyle Class Referencefinal

This class contains styling properties related to a background (for a label for example). More...

#include <luciad/drawing/BackgroundStyle.h>

Classes

class  Builder
 A builder class for creating background styles. More...
 

Public Member Functions

Builder asBuilder () const
 Returns a BackgroundStyle builder that has all properties of this BackgroundStyle. More...
 
Color getBackgroundColor () const
 Returns the background color. More...
 
Color getFrameColor () const
 Returns the frame color. More...
 
double getFrameWidth () const
 Returns the frame width in device independent pixels. More...
 
double getPadding () const
 Returns the padding around the content in device independent pixels. More...
 

Static Public Member Functions

static Builder newBuilder ()
 Returns a new builder for creating a BackgroundStyle. More...
 

Detailed Description

This class contains styling properties related to a background (for a label for example).

Since
2024.1

Member Function Documentation

◆ asBuilder()

Builder luciad::BackgroundStyle::asBuilder ( ) const

Returns a BackgroundStyle builder that has all properties of this BackgroundStyle.

Returns
a BackgroundStyle builder that has all properties of this BackgroundStyle.

◆ getBackgroundColor()

Color luciad::BackgroundStyle::getBackgroundColor ( ) const

Returns the background color.

Returns
the background color.

◆ getFrameColor()

Color luciad::BackgroundStyle::getFrameColor ( ) const

Returns the frame color.

Returns
the frame color.

◆ getFrameWidth()

double luciad::BackgroundStyle::getFrameWidth ( ) const

Returns the frame width in device independent pixels.

Returns
the frame width in device independent pixels.

◆ getPadding()

double luciad::BackgroundStyle::getPadding ( ) const

Returns the padding around the content in device independent pixels.

Returns
the padding around the content in device independent pixels.

◆ newBuilder()

static Builder luciad::BackgroundStyle::newBuilder ( )
static

Returns a new builder for creating a BackgroundStyle.

Returns
a new builder for creating a BackgroundStyle.