Freeciv21
Develop your civilization from humble roots to a global empire
help_dialog Class Reference

#include <helpdlg.h>

+ Inheritance diagram for help_dialog:
+ Collaboration diagram for help_dialog:

Public Slots

void set_topic (const help_item *item)
 Changes the displayed topic. More...
 
void history_forward ()
 Goes to next topic in history. More...
 
void history_back ()
 Backs in history to previous topic. More...
 

Public Member Functions

 help_dialog (QWidget *parent=0)
 Constructor for help dialog. More...
 
void update_fonts ()
 Update fonts for help_wdg. More...
 
- Public Member Functions inherited from qfc_dialog
 qfc_dialog (QWidget *parent)
 Constructor for custom dialog with themed titlebar. More...
 
 ~qfc_dialog () override
 

Public Attributes

bool update_history
 

Protected Member Functions

void showEvent (QShowEvent *event) override
 Show event. More...
 
void hideEvent (QHideEvent *event) override
 Hide event. More...
 
void closeEvent (QCloseEvent *event) override
 Close event. More...
 
- Protected Member Functions inherited from qfc_dialog
void paintEvent (QPaintEvent *event) override
 Paint event for themed dialog. More...
 
void mouseMoveEvent (QMouseEvent *event) override
 Mouse move event for themed titlebar (moves dialog with left mouse) More...
 
void mousePressEvent (QMouseEvent *event) override
 Mouse press event - catches left click. More...
 
void mouseReleaseEvent (QMouseEvent *event) override
 Mouse release event for themed dialog. More...
 

Private Slots

void item_changed (QTreeWidgetItem *item, QTreeWidgetItem *prev)
 Called when a tree item is activated. More...
 

Private Member Functions

void make_tree ()
 Create the help tree. More...
 
void update_buttons ()
 Update buttons (back and next) More...
 

Private Attributes

QPushButton * prev_butt
 
QPushButton * next_butt
 
QTreeWidget * tree_wdg
 
help_widgethelp_wdg
 
QSplitter * splitter
 
QList< QTreeWidgetItem * > item_history
 
QHash< QTreeWidgetItem *, const help_item * > topics_map
 
int history_pos
 

Detailed Description

Definition at line 38 of file helpdlg.h.

Constructor & Destructor Documentation

◆ help_dialog()

help_dialog::help_dialog ( QWidget *  parent = 0)

Constructor for help dialog.

Definition at line 97 of file helpdlg.cpp.

Member Function Documentation

◆ closeEvent()

void help_dialog::closeEvent ( QCloseEvent *  event)
overrideprotected

Close event.

Definition at line 192 of file helpdlg.cpp.

◆ hideEvent()

void help_dialog::hideEvent ( QHideEvent *  event)
overrideprotected

Hide event.

Definition at line 162 of file helpdlg.cpp.

◆ history_back

void help_dialog::history_back ( )
slot

Backs in history to previous topic.

Definition at line 345 of file helpdlg.cpp.

Referenced by help_dialog().

◆ history_forward

void help_dialog::history_forward ( )
slot

Goes to next topic in history.

Definition at line 328 of file helpdlg.cpp.

Referenced by help_dialog().

◆ item_changed

void help_dialog::item_changed ( QTreeWidgetItem *  item,
QTreeWidgetItem *  prev 
)
privateslot

Called when a tree item is activated.

Definition at line 379 of file helpdlg.cpp.

Referenced by help_dialog().

◆ make_tree()

void help_dialog::make_tree ( )
private

Create the help tree.

Definition at line 202 of file helpdlg.cpp.

Referenced by help_dialog().

◆ set_topic

void help_dialog::set_topic ( const help_item item)
slot

Changes the displayed topic.

Definition at line 310 of file helpdlg.cpp.

Referenced by popup_help_dialog_typed().

◆ showEvent()

void help_dialog::showEvent ( QShowEvent *  event)
overrideprotected

Show event.

Definition at line 172 of file helpdlg.cpp.

◆ update_buttons()

void help_dialog::update_buttons ( )
private

Update buttons (back and next)

Definition at line 362 of file helpdlg.cpp.

Referenced by item_changed().

◆ update_fonts()

void help_dialog::update_fonts ( )

Update fonts for help_wdg.

Definition at line 157 of file helpdlg.cpp.

Referenced by update_help_fonts().

Member Data Documentation

◆ help_wdg

help_widget* help_dialog::help_wdg
private

Definition at line 43 of file helpdlg.h.

Referenced by help_dialog(), item_changed(), set_topic(), and update_fonts().

◆ history_pos

int help_dialog::history_pos
private

Definition at line 47 of file helpdlg.h.

Referenced by help_dialog(), history_back(), history_forward(), item_changed(), and update_buttons().

◆ item_history

QList<QTreeWidgetItem *> help_dialog::item_history
private

Definition at line 45 of file helpdlg.h.

Referenced by history_back(), history_forward(), item_changed(), and update_buttons().

◆ next_butt

QPushButton* help_dialog::next_butt
private

Definition at line 41 of file helpdlg.h.

Referenced by help_dialog(), and update_buttons().

◆ prev_butt

QPushButton* help_dialog::prev_butt
private

Definition at line 40 of file helpdlg.h.

Referenced by help_dialog(), and update_buttons().

◆ splitter

QSplitter* help_dialog::splitter
private

Definition at line 44 of file helpdlg.h.

Referenced by closeEvent(), help_dialog(), hideEvent(), and showEvent().

◆ topics_map

QHash<QTreeWidgetItem *, const help_item *> help_dialog::topics_map
private

Definition at line 46 of file helpdlg.h.

Referenced by item_changed(), make_tree(), and set_topic().

◆ tree_wdg

QTreeWidget* help_dialog::tree_wdg
private

Definition at line 42 of file helpdlg.h.

Referenced by help_dialog(), history_back(), history_forward(), item_changed(), make_tree(), and set_topic().

◆ update_history

bool help_dialog::update_history

Definition at line 53 of file helpdlg.h.

Referenced by help_dialog(), history_back(), history_forward(), and item_changed().