FlightGear next
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties | List of all members
GettingStartedTip Class Reference

#include <GettingStartedTip.hxx>

Inherits QQuickItem.

Public Types

enum class  Arrow {
  TopCenter , LeftCenter , RightCenter , BottomCenter ,
  BottomRight , TopRight , TopLeft , LeftTop ,
  NoArrow
}
 

Public Slots

void setEnabled (bool enabled)
 
void showOneShot ()
 
void setStandalone (bool standalone)
 

Signals

void tipChanged ()
 
void enabledChanged ()
 
void controllerChanged ()
 
void standaloneChanged (bool standalone)
 

Public Member Functions

 GettingStartedTip (QQuickItem *parent=nullptr)
 
 ~GettingStartedTip () override
 
QString tipId () const
 
Arrow arrow () const
 
bool isEnabled () const
 
GettingStartedTipsController * controller () const
 
void componentComplete () override
 
bool standalone () const
 
QString nextTip () const
 

Static Public Member Functions

static void setGlobalTipsEnabled (bool enable)
 

Protected Member Functions

void itemChange (QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &value) override
 

Properties

QString tipId
 
QString text
 
QString nextTip
 
Arrow arrow
 
bool enabled
 
GettingStartedTipsController * controller
 
bool standalone
 standalone tips are excluded from their scope when activated; instead they need to be activated manually
 

Detailed Description

Definition at line 10 of file GettingStartedTip.hxx.

Member Enumeration Documentation

◆ Arrow

enum class GettingStartedTip::Arrow
strong
Enumerator
TopCenter 
LeftCenter 
RightCenter 
BottomCenter 
BottomRight 
TopRight 
TopLeft 
LeftTop 
NoArrow 

Definition at line 28 of file GettingStartedTip.hxx.

Constructor & Destructor Documentation

◆ GettingStartedTip()

GettingStartedTip::GettingStartedTip ( QQuickItem * parent = nullptr)
explicit

Definition at line 8 of file GettingStartedTip.cxx.

◆ ~GettingStartedTip()

GettingStartedTip::~GettingStartedTip ( )
override

Definition at line 21 of file GettingStartedTip.cxx.

Member Function Documentation

◆ arrow()

Arrow GettingStartedTip::arrow ( ) const
inline

Definition at line 51 of file GettingStartedTip.hxx.

◆ componentComplete()

void GettingStartedTip::componentComplete ( )
override

Definition at line 33 of file GettingStartedTip.cxx.

◆ controller()

GettingStartedTipsController * GettingStartedTip::controller ( ) const

Definition at line 28 of file GettingStartedTip.cxx.

◆ controllerChanged

void GettingStartedTip::controllerChanged ( )
signal

◆ enabledChanged

void GettingStartedTip::enabledChanged ( )
signal

◆ isEnabled()

bool GettingStartedTip::isEnabled ( ) const
inline

Definition at line 56 of file GettingStartedTip.hxx.

◆ itemChange()

void GettingStartedTip::itemChange ( QQuickItem::ItemChange change,
const QQuickItem::ItemChangeData & value )
overrideprotected

Definition at line 85 of file GettingStartedTip.cxx.

◆ nextTip()

QString GettingStartedTip::nextTip ( ) const
inline

Definition at line 70 of file GettingStartedTip.hxx.

◆ setEnabled

void GettingStartedTip::setEnabled ( bool enabled)
slot

Definition at line 47 of file GettingStartedTip.cxx.

◆ setGlobalTipsEnabled()

void GettingStartedTip::setGlobalTipsEnabled ( bool enable)
static

Definition at line 42 of file GettingStartedTip.cxx.

◆ setStandalone

void GettingStartedTip::setStandalone ( bool standalone)
slot

Definition at line 70 of file GettingStartedTip.cxx.

◆ showOneShot

void GettingStartedTip::showOneShot ( )
slot

Definition at line 62 of file GettingStartedTip.cxx.

◆ standalone()

bool GettingStartedTip::standalone ( ) const
inline

Definition at line 65 of file GettingStartedTip.hxx.

◆ standaloneChanged

void GettingStartedTip::standaloneChanged ( bool standalone)
signal

◆ tipChanged

void GettingStartedTip::tipChanged ( )
signal

◆ tipId()

QString GettingStartedTip::tipId ( ) const
inline

Definition at line 46 of file GettingStartedTip.hxx.

Property Documentation

◆ arrow

Arrow GettingStartedTip::arrow

Definition at line 18 of file GettingStartedTip.hxx.

◆ controller

GettingStartedTipsController* GettingStartedTip::controller
read

Definition at line 22 of file GettingStartedTip.hxx.

◆ enabled

bool GettingStartedTip::enabled
readwrite

Definition at line 20 of file GettingStartedTip.hxx.

◆ nextTip

QString GettingStartedTip::nextTip

Definition at line 16 of file GettingStartedTip.hxx.

◆ standalone

bool GettingStartedTip::standalone
readwrite

standalone tips are excluded from their scope when activated; instead they need to be activated manually

Definition at line 26 of file GettingStartedTip.hxx.

◆ text

QString GettingStartedTip::text

Definition at line 15 of file GettingStartedTip.hxx.

◆ tipId

QString GettingStartedTip::tipId

Definition at line 14 of file GettingStartedTip.hxx.

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