Rise
The Vieneo Province
Classes | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
InformationDialog Class Reference

#include <InformationDialog.h>

Inheritance diagram for InformationDialog:
[legend]
Collaboration diagram for InformationDialog:
[legend]

Classes

struct  HelpContainer
 

Public Member Functions

 InformationDialog (short id)
 
void RefreshHelpText ()
 
bool PopUpHelp (short helpId, bool allowDismiss=true, bool isLearnMore=false)
 
bool DismissHelp (int helpId, int nControlID=GUI_UNDERSTOOD)
 
void ClearHelp ()
 
void FrameMove (float fElapsedTime)
 
void SetHelpText (WCHAR *str)
 
void ActiveTab () override
 
void UpdateMenu (short tab) override
 
bool IsActive (ActiveHelp helpId) const
 
void Draw (D3DXVECTOR3 *tracked)
 
- Public Member Functions inherited from DialogBase
 DialogBase (short id)
 
virtual void Update ()
 
virtual void DoubleClickLine ()
 
virtual void DragDropItem (short s)
 
virtual void ClearEdit ()
 
virtual void OnCreateDevice ()
 
virtual void ActionIconClick (long icon_id)
 
virtual void Close (bool minimize)
 
void PopUpDialog ()
 

Static Public Member Functions

static void CALLBACK DialogCallback (UINT nEvent, int nControlID, CDXUTControl *pControl, void *pUserContext)
 
- Static Public Member Functions inherited from DialogBase
static void Initialize (HMI *gui)
 
static void DrawAllActiveDialogs (float fElapsedTime)
 
static void UpdateAllActiveDialogs (float fElapsedTime)
 
static void IconClick (short icon_id)
 
static void CheckDialogMouse ()
 
static bool DraggingItem (short t, short s)
 
static void BringToFront (short t)
 
static void SortDialogs ()
 
static void OnDeviceReset ()
 
static bool OnEnter ()
 
static void UpdateScrollBar (short t)
 
static short CheckWidth (short dialogid)
 
static short CheckHeight (short t)
 
static void InitializeDialog (short t)
 

Private Attributes

std::vector< HelpContainer > activehelpqueue
 
int activehelp = 0
 
bool canDismiss = true
 
bool learnMore = false
 
float timeSinceLastDismiss = 0.0f
 
WCHAR activeHelpText [512] = { 0 }
 
WCHAR activeHelpTextFormatted [512] = { 0 }
 

Additional Inherited Members

- Public Attributes inherited from DialogBase
short fields
 
bool showfields
 
bool allowresize
 
bool allowmove
 
bool allowclose
 
bool allowscroll
 
short fieldwidth [MAX_FIELDS]
 
short fieldtype [MAX_FIELDS]
 
short fieldcontent [MAX_FIELDS]
 
short actions
 
short action [MAX_ACTION]
 
short tabusedefaultlang [MAX_TAB]
 
short defaultwidth
 
short defaultheight
 
D3DXVECTOR3 windowdefaultlocation
 
short icon
 
RECT iconsource
 
bool normalinterlace
 
short dockedto
 
bool usesHUD
 
D3DXVECTOR3 windowlocation
 
short width
 
short height
 
short tabs
 
short activetab
 
WCHAR tabstr [MAX_TAB][MAX_TAB_CHARS]
 
short sortfield
 
char sortdirection
 
D3DXVECTOR3 windowseeklocation
 
short text
 
long layer
 
bool enabled
 
bool active
 
short linedsp
 
int linetot
 
int linecursel
 
int lineact
 
int linetop
 
short scrollbarheight
 
short scrollbartop
 
short actionsvisible
 
short actionoffset
 
bool actionenabled [MAX_ACTION]
 
bool actiontoggle [MAX_ACTION]
 
float actionslider
 
long editfield
 
long editline
 
long edittab
 
char msgbarcolor
 
WCHAR msgbartext [HELP_SIZE]
 
unsigned short clipboardrecord
 
char clipboardsourcetab
 
short tabflash [MAX_TAB]
 
short tabwidth [MAX_TAB]
 
short tabx [MAX_TAB]
 
WCHAR tabeffectivestr [MAX_TAB][MAX_TAB_CHARS]
 
WCHAR fieldeffectivetitle [MAX_FIELDS][HELP_SIZE]
 
short fieldeffectivewidth [MAX_FIELDS]
 
short fieldx [MAX_FIELDS]
 
WCHAR fieldline [MAX_LINES][MAX_FIELDS][HELP_SIZE]
 
WCHAR fieldeffectiveline [MAX_LINES][MAX_FIELDS][HELP_SIZE]
 
bool fieldsortable [MAX_FIELDS]
 
CDXUTDialog HUD
 
short dialogid
 
bool minimized = false
 
- Static Public Attributes inherited from DialogBase
static DialogBase * dialogs [D_ENUMERATION]
 
static HMI * gui = nullptr
 
static Logger * logger = nullptr
 
static short draworder [D_ENUMERATION]
 
- Protected Member Functions inherited from DialogBase
virtual void TabClick (short clicked_tab)
 
- Static Protected Member Functions inherited from DialogBase
static void CheckMoved (short t)
 

Detailed Description

Definition at line 6 of file InformationDialog.h.

Constructor & Destructor Documentation

◆ InformationDialog()

InformationDialog::InformationDialog ( short  id)

Definition at line 7 of file InformationDialog.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ ActiveTab()

void InformationDialog::ActiveTab ( )
overridevirtual

Reimplemented from DialogBase.

Definition at line 196 of file InformationDialog.cpp.

Here is the call graph for this function:

◆ ClearHelp()

void InformationDialog::ClearHelp ( )

Definition at line 171 of file InformationDialog.cpp.

Here is the caller graph for this function:

◆ DialogCallback()

void CALLBACK InformationDialog::DialogCallback ( UINT  nEvent,
int  nControlID,
CDXUTControl *  pControl,
void *  pUserContext 
)
static

Definition at line 315 of file InformationDialog.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ DismissHelp()

bool InformationDialog::DismissHelp ( int  helpId,
int  nControlID = GUI_UNDERSTOOD 
)

Definition at line 84 of file InformationDialog.cpp.

Here is the call graph for this function:

◆ Draw()

void InformationDialog::Draw ( D3DXVECTOR3 *  tracked)
virtual

Reimplemented from DialogBase.

Definition at line 323 of file InformationDialog.cpp.

Here is the call graph for this function:

◆ FrameMove()

void InformationDialog::FrameMove ( float  fElapsedTime)

Definition at line 179 of file InformationDialog.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IsActive()

bool InformationDialog::IsActive ( ActiveHelp  helpId) const

Definition at line 310 of file InformationDialog.cpp.

Here is the caller graph for this function:

◆ PopUpHelp()

bool InformationDialog::PopUpHelp ( short  helpId,
bool  allowDismiss = true,
bool  isLearnMore = false 
)

Definition at line 38 of file InformationDialog.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ RefreshHelpText()

void InformationDialog::RefreshHelpText ( )

Definition at line 29 of file InformationDialog.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetHelpText()

void InformationDialog::SetHelpText ( WCHAR *  str)

Definition at line 190 of file InformationDialog.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ UpdateMenu()

void InformationDialog::UpdateMenu ( short  tab)
overridevirtual

Reimplemented from DialogBase.

Definition at line 210 of file InformationDialog.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ activehelp

int InformationDialog::activehelp = 0
private

Definition at line 15 of file InformationDialog.h.

◆ activehelpqueue

std::vector<HelpContainer> InformationDialog::activehelpqueue
private

Definition at line 14 of file InformationDialog.h.

◆ activeHelpText

WCHAR InformationDialog::activeHelpText[512] = { 0 }
private

Definition at line 19 of file InformationDialog.h.

◆ activeHelpTextFormatted

WCHAR InformationDialog::activeHelpTextFormatted[512] = { 0 }
private

Definition at line 20 of file InformationDialog.h.

◆ canDismiss

bool InformationDialog::canDismiss = true
private

Definition at line 16 of file InformationDialog.h.

◆ learnMore

bool InformationDialog::learnMore = false
private

Definition at line 17 of file InformationDialog.h.

◆ timeSinceLastDismiss

float InformationDialog::timeSinceLastDismiss = 0.0f
private

Definition at line 18 of file InformationDialog.h.

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