FOSSredder 0.5.0
Loading...
Searching...
No Matches
ui::Navigation Class Reference

Stores the active top-level shell section and settings sub-section. More...

#include <Navigation.h>

Inheritance diagram for ui::Navigation:
Inheritance graph
[legend]
Collaboration diagram for ui::Navigation:
Collaboration graph
[legend]

Public Types

enum class  Section {
  Actors , Properties , Contracts , Booking ,
  Import , Export , Settings , Analysis ,
  Annual
}
 Top-level shell sections shown by the desktop UI. More...
enum class  SettingsCategory { General , Import , Export , Miscellaneous }
 Settings page categories shown inside the settings section. More...

Signals

void sectionChanged ()
 Emitted when the active shell section changes.
void settingsCategoryChanged ()
 Emitted when the active settings category changes.

Public Member Functions

 Navigation (QObject *parent=nullptr)
 Creates the navigation state.
SettingsCategory settingsCategory () const noexcept
 Returns the active settings category.
int settingsCategoryValue () const noexcept
 Returns the active settings category as QML-friendly integer.
void setSettingsCategory (SettingsCategory c)
 Sets the active settings category.
Q_INVOKABLE void setSettingsCategoryValue (int value)
 Sets the active settings category from QML.
Section section () const noexcept
 Returns the active shell section.
int sectionValue () const noexcept
 Returns the active shell section as QML-friendly integer.
int activeSection () const noexcept
 Returns the active shell section value used by QML.
int actorSection () const noexcept
 Returns the actor section enum value for QML.
int propertySection () const noexcept
 Returns the property section enum value for QML.
int contractSection () const noexcept
 Returns the contract section enum value for QML.
int bookingSection () const noexcept
 Returns the booking section enum value for QML.
int importSection () const noexcept
 Returns the import section enum value for QML.
int exportSection () const noexcept
 Returns the export section enum value for QML.
int settingsSection () const noexcept
 Returns the settings section enum value for QML.
int analysisSection () const noexcept
 Returns the analysis section enum value for QML.
int annualSection () const noexcept
 Returns the annual section enum value for QML.
void setSection (Section s)
 Sets the active shell section.
Q_INVOKABLE void setSectionValue (int value)
 Sets the active shell section from QML.
Q_INVOKABLE void navigateToSection (int section)
 Navigates to a top-level shell section from QML.

Properties

Section section
int sectionValue
int activeSection
int actorSection
int propertySection
int contractSection
int bookingSection
int importSection
int exportSection
int settingsSection
int analysisSection
int annualSection
SettingsCategory settingsCategory
int settingsCategoryValue

Detailed Description

Stores the active top-level shell section and settings sub-section.

Definition at line 15 of file Navigation.h.

Member Enumeration Documentation

◆ Section

enum class ui::Navigation::Section
strong

Top-level shell sections shown by the desktop UI.

Enumerator
Actors 
Properties 
Contracts 
Booking 
Import 
Export 
Settings 
Analysis 
Annual 

Definition at line 35 of file Navigation.h.

◆ SettingsCategory

enum class ui::Navigation::SettingsCategory
strong

Settings page categories shown inside the settings section.

Enumerator
General 
Import 
Export 
Miscellaneous 

Definition at line 56 of file Navigation.h.

Constructor & Destructor Documentation

◆ Navigation()

ui::Navigation::Navigation ( QObject * parent = nullptr)
explicit

Creates the navigation state.

Parameters
parentOptional QObject parent.

Definition at line 12 of file Navigation.cpp.

Member Function Documentation

◆ activeSection()

int ui::Navigation::activeSection ( ) const
inlinenoexcept

Returns the active shell section value used by QML.

Returns
Integer value of the active shell section.

Definition at line 117 of file Navigation.h.

◆ actorSection()

int ui::Navigation::actorSection ( ) const
inlinenoexcept

Returns the actor section enum value for QML.

Definition at line 122 of file Navigation.h.

◆ analysisSection()

int ui::Navigation::analysisSection ( ) const
inlinenoexcept

Returns the analysis section enum value for QML.

Definition at line 157 of file Navigation.h.

◆ annualSection()

int ui::Navigation::annualSection ( ) const
inlinenoexcept

Returns the annual section enum value for QML.

Definition at line 162 of file Navigation.h.

◆ bookingSection()

int ui::Navigation::bookingSection ( ) const
inlinenoexcept

Returns the booking section enum value for QML.

Definition at line 137 of file Navigation.h.

◆ contractSection()

int ui::Navigation::contractSection ( ) const
inlinenoexcept

Returns the contract section enum value for QML.

Definition at line 132 of file Navigation.h.

◆ exportSection()

int ui::Navigation::exportSection ( ) const
inlinenoexcept

Returns the export section enum value for QML.

Definition at line 147 of file Navigation.h.

◆ importSection()

int ui::Navigation::importSection ( ) const
inlinenoexcept

Returns the import section enum value for QML.

Definition at line 142 of file Navigation.h.

◆ navigateToSection()

void ui::Navigation::navigateToSection ( int section)

Navigates to a top-level shell section from QML.

Parameters
sectionInteger section value.

Definition at line 34 of file Navigation.cpp.

Here is the call graph for this function:

◆ propertySection()

int ui::Navigation::propertySection ( ) const
inlinenoexcept

Returns the property section enum value for QML.

Definition at line 127 of file Navigation.h.

◆ section()

Section ui::Navigation::section ( ) const
inlinenoexcept

Returns the active shell section.

Returns
Active shell section.

Definition at line 101 of file Navigation.h.

◆ sectionChanged

void ui::Navigation::sectionChanged ( )
signal

Emitted when the active shell section changes.

Here is the caller graph for this function:

◆ sectionValue()

int ui::Navigation::sectionValue ( ) const
inlinenoexcept

Returns the active shell section as QML-friendly integer.

Returns
Integer value of the active shell section.

Definition at line 109 of file Navigation.h.

◆ setSection()

void ui::Navigation::setSection ( Section s)

Sets the active shell section.

Parameters
sSection to activate.

Definition at line 14 of file Navigation.cpp.

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

◆ setSectionValue()

void ui::Navigation::setSectionValue ( int value)

Sets the active shell section from QML.

Parameters
valueInteger section value.

Definition at line 30 of file Navigation.cpp.

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

◆ setSettingsCategory()

void ui::Navigation::setSettingsCategory ( SettingsCategory c)

Sets the active settings category.

Parameters
cSettings category to activate.

Definition at line 38 of file Navigation.cpp.

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

◆ setSettingsCategoryValue()

void ui::Navigation::setSettingsCategoryValue ( int value)

Sets the active settings category from QML.

Parameters
valueInteger settings category value.

Definition at line 54 of file Navigation.cpp.

Here is the call graph for this function:

◆ settingsCategory()

SettingsCategory ui::Navigation::settingsCategory ( ) const
inlinenoexcept

Returns the active settings category.

Returns
Active settings category.

Definition at line 73 of file Navigation.h.

◆ settingsCategoryChanged

void ui::Navigation::settingsCategoryChanged ( )
signal

Emitted when the active settings category changes.

Here is the caller graph for this function:

◆ settingsCategoryValue()

int ui::Navigation::settingsCategoryValue ( ) const
inlinenoexcept

Returns the active settings category as QML-friendly integer.

Returns
Integer value of the active settings category.

Definition at line 81 of file Navigation.h.

◆ settingsSection()

int ui::Navigation::settingsSection ( ) const
inlinenoexcept

Returns the settings section enum value for QML.

Definition at line 152 of file Navigation.h.

Property Documentation

◆ activeSection

int ui::Navigation::activeSection
read

Definition at line 20 of file Navigation.h.

◆ actorSection

int ui::Navigation::actorSection
read

Definition at line 21 of file Navigation.h.

◆ analysisSection

int ui::Navigation::analysisSection
read

Definition at line 28 of file Navigation.h.

◆ annualSection

int ui::Navigation::annualSection
read

Definition at line 29 of file Navigation.h.

◆ bookingSection

int ui::Navigation::bookingSection
read

Definition at line 24 of file Navigation.h.

◆ contractSection

int ui::Navigation::contractSection
read

Definition at line 23 of file Navigation.h.

◆ exportSection

int ui::Navigation::exportSection
read

Definition at line 26 of file Navigation.h.

◆ importSection

int ui::Navigation::importSection
read

Definition at line 25 of file Navigation.h.

◆ propertySection

int ui::Navigation::propertySection
read

Definition at line 22 of file Navigation.h.

◆ section

Section ui::Navigation::section
readwrite

Definition at line 17 of file Navigation.h.

◆ sectionValue

int ui::Navigation::sectionValue
read

Definition at line 19 of file Navigation.h.

◆ settingsCategory

SettingsCategory ui::Navigation::settingsCategory
read

Definition at line 48 of file Navigation.h.

◆ settingsCategoryValue

int ui::Navigation::settingsCategoryValue
read

Definition at line 50 of file Navigation.h.

◆ settingsSection

int ui::Navigation::settingsSection
read

Definition at line 27 of file Navigation.h.

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