Om  1.0.0
A universal framework for multimedia simulation
Public Types | Public Member Functions | List of all members
om::graphics::gui::base::BorderType Class Reference

A class that represents the type of visual appearance of a rectangular border. More...

#include <omGraphicsGUIBorderType.h>

Public Types

enum  Enum {
  SOLID, DOTTED, FADE, RAISED,
  SUNKEN, NONE
}
 An enum that specifies the different kinds of borders. More...
 

Public Member Functions

 BorderType (Enum newType)
 Create a new border type using the specified border type enum value. More...
 
 operator Enum () const
 Convert this border type to an enum value. More...
 
String toString () const
 Return a string representation of the border type. More...
 
 operator String () const
 Convert this border type into a string representation. More...
 

Detailed Description

A class that represents the type of visual appearance of a rectangular border.

Member Enumeration Documentation

An enum that specifies the different kinds of borders.

Enumerator
SOLID 

A border type where the border is a solid line.

DOTTED 

A border type where the border is a dotted line.

FADE 

A border type where the border uses a color fade on all sides.

The content area's background color is smoothly faded to the border color.

RAISED 

A border type where border has a raised appearance.

This is usually accomplished by using two-sided border lighting to give the impression of a raised border.

SUNKEN 

A border type where border has a sunken appearance.

This is usually accomplished by using two-sided lighting to give the impression of a sunken border.

NONE 

A border type which indicates that there should be no border.

Constructor & Destructor Documentation

om::graphics::gui::base::BorderType::BorderType ( Enum  newType)
inline

Create a new border type using the specified border type enum value.

Member Function Documentation

om::graphics::gui::base::BorderType::operator Enum ( ) const
inline

Convert this border type to an enum value.

String om::graphics::gui::base::BorderType::toString ( ) const

Return a string representation of the border type.

om::graphics::gui::base::BorderType::operator String ( ) const
inline

Convert this border type into a string representation.


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