KDChart::Position Class Reference

#include <KDChartPosition.h>

Collaboration diagram for KDChart::Position:

[legend]List of all members.

---

Detailed Description

Defines a position, using compass terminology.

Using KDChartPosition you can specify one of nine pre-defined, logical points (see the static const getter methods below), in a similar way, as you would use a compass to navigate on a map.

Note:

Often you will declare a Position together with the RelativePosition class, to specify a logical point, which then will be used to layout your chart at runtime, e.g. for specifying the location of a floating Legend box.

For comparing a Position's value with a switch() statement, you can use numeric values defined in KDChartEnums, like this:

switch( yourPosition().value() ) {
    case KDChartEnums::PositionNorthWest:
        // your code ...
        break;
    case KDChartEnums::PositionNorth:
        // your code ...
        break;
}

See also:

RelativePosition, KDChartEnums::PositionValue

Definition at line 75 of file KDChartPosition.h.

Public Types
enum	Option {   IncludeCenter = 0,   ExcludeCenter = 1 }
Public Member Functions
bool	isCorner () const
bool	isEastSide () const
bool	isFloating () const
bool	isNorthSide () const
bool	isPole () const
bool	isSouthSide () const
bool	isUnknown () const
bool	isWestSide () const
const char *	name () const
	Returns a non-translated string in English language, corresponding to this Position.
bool	operator!= (int) const
bool	operator!= (const Position &) const
bool	operator== (int) const
bool	operator== (const Position &) const
	Position (KDChartEnums::PositionValue value)
	Constructor.
	Position ()
	Default constructor.
QString	printableName () const
	Returns a translated string, corresponding to this Position.
KDChartEnums::PositionValue	value () const
	Returns an integer value corresponding to this Position.
Static Public Member Functions
static Position	fromName (const QByteArray &name)
static Position	fromName (const char *name)
static QList< QByteArray >	names (Options options=IncludeCenter)
	Returns a list of all string, corresponding to the pre-defined positions.
static QStringList	printableNames (Options options=IncludeCenter)
	Returns a list of all translated string, corresponding to the pre-defined positions.
Static Public Attributes
static const Position &	Center
static const Position &	East
static const Position &	Floating
static const Position &	North
static const Position &	NorthEast
static const Position &	NorthWest
static const Position &	South
static const Position &	SouthEast
static const Position &	SouthWest
static const Position &	Unknown
static const Position &	West

---

Member Enumeration Documentation

enum KDChart::Position::Option

Enumerator:

IncludeCenter
ExcludeCenter

Definition at line 113 of file KDChartPosition.h.

{ IncludeCenter=0, ExcludeCenter=1 };

---

Constructor & Destructor Documentation

Position::Position

(

)

Default constructor.

Creates a new Position, defaulting it to Position::Unknown.

Definition at line 100 of file KDChartPosition.cpp.

Referenced by fromName().

    : m_value( KDChartEnums::PositionUnknown )
{

}

Position::Position

(

KDChartEnums::PositionValue

value

)

Constructor.

Creates a new Position, defaulting it to the respective value.

Valid values ranging from zero (unknown value) to 10. If invalid value is passed, a Position::Unknown is created.

Note:

Normally there is no need to call this constructor, but you would rather use one of the nine pre-defined, static values, e.g. like this:

 * const KDChart::Position myPosition = KDChart::Position::NorthEast;
 * 

Definition at line 124 of file KDChartPosition.cpp.

    : m_value( value )
{

}

---

Member Function Documentation

Position Position::fromName

(

const QByteArray &

name

)

[static]

Definition at line 243 of file KDChartPosition.cpp.

References fromName().

                                                     {
    return fromName( name.data() );
}

Position Position::fromName

(

const char *

name

)

[static]

Definition at line 235 of file KDChartPosition.cpp.

References maxPositionValue, Position(), and staticPositionNames.

Referenced by fromName().

{
    for( int i=1; i<=maxPositionValue; ++i)
        if ( !qstricmp( name, staticPositionNames[i] ) )
            return Position(i);
    return Position(0);
}

bool Position::isCorner

(

)

const

Definition at line 168 of file KDChartPosition.cpp.

References NorthEast, NorthWest, SouthEast, SouthWest, and value().

{
    return  m_value == Position::NorthWest.value() ||
            m_value == Position::NorthEast.value() ||
            m_value == Position::SouthEast.value() ||
            m_value == Position::SouthWest.value();
}

bool Position::isEastSide

(

)

const

Definition at line 155 of file KDChartPosition.cpp.

References East, NorthEast, SouthEast, and value().

{
    return  m_value == Position::NorthEast.value() ||
            m_value == Position::East.value() ||
            m_value == Position::SouthEast.value();
}

bool Position::isFloating

(

)

const

Definition at line 181 of file KDChartPosition.cpp.

References Floating, and value().

Referenced by KDChart::Chart::reLayoutFloatingLegends().

{
    return  m_value == Position::Floating.value();
}

bool Position::isNorthSide

(

)

const

Definition at line 149 of file KDChartPosition.cpp.

References North, NorthEast, NorthWest, and value().

{
    return  m_value == Position::NorthWest.value() ||
            m_value == Position::North.value() ||
            m_value == Position::NorthEast.value();
}

bool Position::isPole

(

)

const

Definition at line 175 of file KDChartPosition.cpp.

References North, South, and value().

{
    return  m_value == Position::North.value() ||
        m_value == Position::South.value();
}

bool Position::isSouthSide

(

)

const

Definition at line 161 of file KDChartPosition.cpp.

References South, SouthEast, SouthWest, and value().

{
    return  m_value == Position::SouthWest.value() ||
            m_value == Position::South.value() ||
            m_value == Position::SouthEast.value();
}

bool Position::isUnknown

(

)

const

Definition at line 138 of file KDChartPosition.cpp.

References Unknown, and value().

{
    return  m_value == Position::Unknown.value();
}

bool Position::isWestSide

(

)

const

Definition at line 143 of file KDChartPosition.cpp.

References NorthWest, SouthWest, value(), and West.

{
    return  m_value == Position::SouthWest.value() ||
            m_value == Position::West.value() ||
            m_value == Position::NorthWest.value();
}

const char * Position::name

(

)

const

Returns a non-translated string in English language, corresponding to this Position.

Definition at line 189 of file KDChartPosition.cpp.

References staticPositionNames.

Referenced by operator<<().

{
    return staticPositionNames[m_value];
}

QList< QByteArray > Position::names

(

Options

options = IncludeCenter

)

[static]

Returns a list of all string, corresponding to the pre-defined positions.

Parameters:

options

if set to ExcludeCenter, the returned list does not contain the Center position.

Definition at line 210 of file KDChartPosition.cpp.

References IncludeCenter, maxPositionValue, and staticPositionNames.

{
    QList<QByteArray> list;
    const int start = ( options & IncludeCenter ) ? 1 : 2;
    for( int i=start; i<=maxPositionValue; ++i)
        list.append( staticPositionNames[i] );
    return list;
}

bool KDChart::Position::operator!=

(

int

)

const

Definition at line 132 of file KDChartPosition.h.

References operator==().

{ return !operator==( other ); }

bool KDChart::Position::operator!=

(

const Position &

)

const

Definition at line 131 of file KDChartPosition.h.

{ return !operator==( other ); }

bool Position::operator==

(

int

)

const

Definition at line 253 of file KDChartPosition.cpp.

References value().

{
    return ( value() == value_ );
}

bool Position::operator==

(

const Position &

)

const

Definition at line 247 of file KDChartPosition.cpp.

References value().

Referenced by operator!=().

{
    return ( value() == r.value() );
}

QString Position::printableName

(

)

const

Returns a translated string, corresponding to this Position.

Definition at line 197 of file KDChartPosition.cpp.

References staticPositionNames.

Referenced by printableNames().

{
    return tr(staticPositionNames[m_value]);
}

QStringList Position::printableNames

(

Options

options = IncludeCenter

)

[static]

Returns a list of all translated string, corresponding to the pre-defined positions.

Parameters:

options

if set to ExcludeCenter, the returned list does not contain the Center position.

Definition at line 226 of file KDChartPosition.cpp.

References IncludeCenter, maxPositionValue, and printableName().

{
    QStringList list;
    const int start = ( options & IncludeCenter ) ? 1 : 2;
    for( int i=start; i<=maxPositionValue; ++i)
        list.append( Position(i).printableName() );
    return list;
}

KDChartEnums::PositionValue Position::value

(

)

const

Returns an integer value corresponding to this Position.

Definition at line 133 of file KDChartPosition.cpp.

Referenced by isCorner(), isEastSide(), isFloating(), isNorthSide(), isPole(), isSouthSide(), isUnknown(), isWestSide(), operator==(), KDChart::TernaryAxis::setPosition(), KDChart::PolarDiagram::setShowDelimitersAtPosition(), KDChart::PolarDiagram::setShowLabelsAtPosition(), KDChart::PolarDiagram::showDelimitersAtPosition(), and KDChart::PolarDiagram::showLabelsAtPosition().

{
    return static_cast<KDChartEnums::PositionValue>( m_value );
}

---

Member Data Documentation

const Position & Position::Center [static]

Definition at line 101 of file KDChartPosition.h.

Referenced by KDChart::PositionPoints::point().

const Position & Position::East [static]

Definition at line 105 of file KDChartPosition.h.

Referenced by isEastSide(), and KDChart::PositionPoints::point().

const Position & Position::Floating [static]

Definition at line 111 of file KDChartPosition.h.

Referenced by isFloating(), and KDChart::Legend::setFloatingPosition().

const Position & Position::North [static]

Definition at line 103 of file KDChartPosition.h.

Referenced by isNorthSide(), isPole(), and KDChart::PositionPoints::point().

const Position & Position::NorthEast [static]

Definition at line 104 of file KDChartPosition.h.

Referenced by isCorner(), isEastSide(), isNorthSide(), and KDChart::PositionPoints::point().

const Position & Position::NorthWest [static]

Definition at line 102 of file KDChartPosition.h.

Referenced by isCorner(), isNorthSide(), isWestSide(), and KDChart::PositionPoints::point().

const Position & Position::South [static]

Definition at line 107 of file KDChartPosition.h.

Referenced by isPole(), isSouthSide(), and KDChart::PositionPoints::point().

const Position & Position::SouthEast [static]

Definition at line 106 of file KDChartPosition.h.

Referenced by isCorner(), isEastSide(), isSouthSide(), and KDChart::PositionPoints::point().

const Position & Position::SouthWest [static]

Definition at line 108 of file KDChartPosition.h.

Referenced by isCorner(), isSouthSide(), isWestSide(), and KDChart::PositionPoints::point().

const Position & Position::Unknown [static]

Definition at line 100 of file KDChartPosition.h.

Referenced by isUnknown(), and KDChart::RelativePosition::resetReferencePosition().

const Position & Position::West [static]

Definition at line 109 of file KDChartPosition.h.

Referenced by isWestSide(), and KDChart::PositionPoints::point().

---

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

• KDChartPosition.h
• KDChartPosition.cpp

---