QtPass 2.0.0
Developer documentation
Loading...
Searching...
No Matches
AppSettings Struct Reference
Settings and profiles

Plain value-object holding all flat QtPass configuration. More...

#include <appsettings.h>

Collaboration diagram for AppSettings:

Static Public Member Functions

static auto defaultSecretFieldNames () -> QStringList
 The secret field names a new or emptied setting starts with: what an entry commonly holds besides its password.

Public Attributes

QString version
 Last-run application version.
QByteArray geometry
 Main-window saved geometry.
QByteArray savestate
 Main-window saved dock/toolbar state.
QString activeProfile
 Name of the active profile.
bool usePass {false}
 Use the pass CLI (true) or native git/gpg.
QString passStore
 Password-store root path.
QString passSigningKey
 GPG key used to sign .gpg-id files.
QString passExecutable
 Path to the pass executable.
QString gitExecutable
 Path to the git executable.
QString gpgExecutable
 Path to the gpg/gpg2 executable.
QString pwgenExecutable
 Path to the pwgen executable.
QString qrencodeExecutable
 Path to the qrencode executable.
QString gpgHome
 GPG home directory (read-only externally).
QString sshAuthSockOverride
 Manual SSH_AUTH_SOCK override path.
Enums::ClipBoardType clipBoardType
 Clipboard copy behaviour.
bool useSelection {false}
 Use the X11 primary selection.
bool useAutoclear {false}
bool restoreClipboard {true}
int autoclearSeconds {0}
 Clipboard autoclear delay (seconds).
bool useAutoclearPanel {false}
 Clear the content panel after a delay.
int autoclearPanelSeconds {0}
 Panel autoclear delay (seconds).
bool hidePassword {false}
bool hideSecretFields {true}
QStringList secretFieldNames {defaultSecretFieldNames()}
bool hideAllFields {false}
bool hideContent {false}
 Hide the entire content panel.
bool useMonospace {false}
 Render content in a monospace font.
bool displayAsIs {false}
 Show file content unmodified.
bool noLineWrapping {false}
 Disable line wrapping in the panel.
bool addGPGId {true}
 Auto-add .gpg-id files to git.
bool useGit {false}
 Enable git integration.
bool useGrepSearch {false}
 Enable content (grep) search.
bool useOtp {true}
 Enable native TOTP (OTP) support.
bool useQrencode {false}
 Enable qrencode support.
bool usePwgen {false}
 Use pwgen for password generation.
bool autoPull {false}
 Automatically git pull on open.
bool autoPush {false}
bool gitUseParentRepository {false}
bool showProcessOutput {false}
 Show external process output.
bool showMenuBar {false}
 Show the menu bar (Ctrl+M toggles it).
QString passTemplate
 Newline-separated template field names.
bool useTemplate {false}
 Use the password template.
bool templateAllFields {false}
 Treat every key: line as a field.
PasswordConfiguration passwordConfiguration
 Length/charset/custom chars.
bool avoidCapitals {false}
 Exclude uppercase letters.
bool avoidNumbers {false}
 Exclude digits.
bool lessRandom {false}
 Generate memorable (less random) passwords.
bool useSymbols {false}
 Include special symbols.
bool useTrayIcon {false}
 Show a system tray icon.
bool hideOnClose {false}
 Hide to tray instead of quitting on close.
bool startMinimized {false}
 Start the window minimised.
bool alwaysOnTop {false}
 Keep the main window always on top.

Detailed Description

Plain value-object holding all flat QtPass configuration.

One field per persisted setting, with the same defaults the legacy QtPassSettings getters apply. This is a pure data carrier: it has no QSettings dependency and performs none of the side effects that the old getters did (directory creation for the pass store, screen-centring of the window position, .git auto-detection). Those remain application logic in the consumers; SettingsSerializer maps this struct straight to and from QSettings.

Nested/keyed settings — profiles (a dedicated Profile type is tracked separately), per-dialog geometry, and splitter positions — are intentionally out of scope here and still go through QtPassSettings directly.

Definition at line 36 of file appsettings.h.

Member Function Documentation

◆ defaultSecretFieldNames()

auto AppSettings::defaultSecretFieldNames ( ) -> QStringList
inlinestatic

The secret field names a new or emptied setting starts with: what an entry commonly holds besides its password.

Returns
The names, lower case.

Definition at line 42 of file appsettings.h.

Here is the caller graph for this function:

Member Data Documentation

◆ activeProfile

QString AppSettings::activeProfile

Name of the active profile.

Definition at line 56 of file appsettings.h.

◆ addGPGId

bool AppSettings::addGPGId {true}

Auto-add .gpg-id files to git.

Definition at line 101 of file appsettings.h.

◆ alwaysOnTop

bool AppSettings::alwaysOnTop {false}

Keep the main window always on top.

Definition at line 131 of file appsettings.h.

◆ autoclearPanelSeconds

int AppSettings::autoclearPanelSeconds {0}

Panel autoclear delay (seconds).

Definition at line 82 of file appsettings.h.

◆ autoclearSeconds

int AppSettings::autoclearSeconds {0}

Clipboard autoclear delay (seconds).

Definition at line 80 of file appsettings.h.

◆ autoPull

bool AppSettings::autoPull {false}

Automatically git pull on open.

Definition at line 107 of file appsettings.h.

◆ autoPush

bool AppSettings::autoPush {false}

Automatically git push after changes.

Definition at line 108 of file appsettings.h.

◆ avoidCapitals

bool AppSettings::avoidCapitals {false}

Exclude uppercase letters.

Definition at line 122 of file appsettings.h.

◆ avoidNumbers

bool AppSettings::avoidNumbers {false}

Exclude digits.

Definition at line 123 of file appsettings.h.

◆ clipBoardType

Enums::ClipBoardType AppSettings::clipBoardType
Initial value:
{
Enums::CLIPBOARD_NEVER}
Enums::CLIPBOARD_NEVER
@ CLIPBOARD_NEVER
Definition enums.h:25

Clipboard copy behaviour.

Definition at line 73 of file appsettings.h.

◆ displayAsIs

bool AppSettings::displayAsIs {false}

Show file content unmodified.

Definition at line 97 of file appsettings.h.

◆ geometry

QByteArray AppSettings::geometry

Main-window saved geometry.

Definition at line 54 of file appsettings.h.

◆ gitExecutable

QString AppSettings::gitExecutable

Path to the git executable.

Definition at line 65 of file appsettings.h.

◆ gitUseParentRepository

bool AppSettings::gitUseParentRepository {false}

Let git use a repository in a folder above the store when the store has none of its own; off, git stops at the store's parent, as in pass.

Definition at line 111 of file appsettings.h.

◆ gpgExecutable

QString AppSettings::gpgExecutable

Path to the gpg/gpg2 executable.

Definition at line 66 of file appsettings.h.

◆ gpgHome

QString AppSettings::gpgHome

GPG home directory (read-only externally).

Definition at line 69 of file appsettings.h.

◆ hideAllFields

bool AppSettings::hideAllFields {false}

With hidePassword: hide every field, not only the secrets (shared screens, presenting). The notes and the OTP code stay visible.

Definition at line 94 of file appsettings.h.

◆ hideContent

bool AppSettings::hideContent {false}

Hide the entire content panel.

Definition at line 95 of file appsettings.h.

◆ hideOnClose

bool AppSettings::hideOnClose {false}

Hide to tray instead of quitting on close.

Definition at line 129 of file appsettings.h.

◆ hidePassword

bool AppSettings::hidePassword {false}

Hide the password line in the panel.

Definition at line 85 of file appsettings.h.

◆ hideSecretFields

bool AppSettings::hideSecretFields {true}

With hidePassword: hide the fields named in secretFieldNames too. Off, only the password is hidden, as in 1.8.

Definition at line 88 of file appsettings.h.

◆ lessRandom

bool AppSettings::lessRandom {false}

Generate memorable (less random) passwords.

Definition at line 124 of file appsettings.h.

◆ noLineWrapping

bool AppSettings::noLineWrapping {false}

Disable line wrapping in the panel.

Definition at line 98 of file appsettings.h.

◆ passExecutable

QString AppSettings::passExecutable

Path to the pass executable.

Definition at line 64 of file appsettings.h.

◆ passSigningKey

QString AppSettings::passSigningKey

GPG key used to sign .gpg-id files.

Definition at line 61 of file appsettings.h.

◆ passStore

QString AppSettings::passStore

Password-store root path.

Definition at line 60 of file appsettings.h.

◆ passTemplate

QString AppSettings::passTemplate

Newline-separated template field names.

Definition at line 116 of file appsettings.h.

◆ passwordConfiguration

PasswordConfiguration AppSettings::passwordConfiguration

Length/charset/custom chars.

Definition at line 121 of file appsettings.h.

◆ pwgenExecutable

QString AppSettings::pwgenExecutable

Path to the pwgen executable.

Definition at line 67 of file appsettings.h.

◆ qrencodeExecutable

QString AppSettings::qrencodeExecutable

Path to the qrencode executable.

Definition at line 68 of file appsettings.h.

◆ restoreClipboard

bool AppSettings::restoreClipboard {true}

When autoclear runs: put back what was on the clipboard before, as pass -c does, unless something else was copied meanwhile.

Definition at line 79 of file appsettings.h.

◆ savestate

QByteArray AppSettings::savestate

Main-window saved dock/toolbar state.

Definition at line 55 of file appsettings.h.

◆ secretFieldNames

QStringList AppSettings::secretFieldNames {defaultSecretFieldNames()}

The field names hideSecretFields hides, as whole words in any case ("key" hides "API key", not "keyboard"). May be empty.

Definition at line 91 of file appsettings.h.

◆ showMenuBar

bool AppSettings::showMenuBar {false}

Show the menu bar (Ctrl+M toggles it).

Definition at line 113 of file appsettings.h.

◆ showProcessOutput

bool AppSettings::showProcessOutput {false}

Show external process output.

Definition at line 112 of file appsettings.h.

◆ sshAuthSockOverride

QString AppSettings::sshAuthSockOverride

Manual SSH_AUTH_SOCK override path.

Definition at line 70 of file appsettings.h.

◆ startMinimized

bool AppSettings::startMinimized {false}

Start the window minimised.

Definition at line 130 of file appsettings.h.

◆ templateAllFields

bool AppSettings::templateAllFields {false}

Treat every key: line as a field.

Definition at line 118 of file appsettings.h.

◆ useAutoclear

bool AppSettings::useAutoclear {false}

Clear the clipboard after a delay.

Definition at line 76 of file appsettings.h.

◆ useAutoclearPanel

bool AppSettings::useAutoclearPanel {false}

Clear the content panel after a delay.

Definition at line 81 of file appsettings.h.

◆ useGit

bool AppSettings::useGit {false}

Enable git integration.

Definition at line 102 of file appsettings.h.

◆ useGrepSearch

bool AppSettings::useGrepSearch {false}

Enable content (grep) search.

Definition at line 103 of file appsettings.h.

◆ useMonospace

bool AppSettings::useMonospace {false}

Render content in a monospace font.

Definition at line 96 of file appsettings.h.

◆ useOtp

bool AppSettings::useOtp {true}

Enable native TOTP (OTP) support.

Definition at line 104 of file appsettings.h.

◆ usePass

bool AppSettings::usePass {false}

Use the pass CLI (true) or native git/gpg.

Definition at line 59 of file appsettings.h.

◆ usePwgen

bool AppSettings::usePwgen {false}

Use pwgen for password generation.

Definition at line 106 of file appsettings.h.

◆ useQrencode

bool AppSettings::useQrencode {false}

Enable qrencode support.

Definition at line 105 of file appsettings.h.

◆ useSelection

bool AppSettings::useSelection {false}

Use the X11 primary selection.

Definition at line 75 of file appsettings.h.

◆ useSymbols

bool AppSettings::useSymbols {false}

Include special symbols.

Definition at line 125 of file appsettings.h.

◆ useTemplate

bool AppSettings::useTemplate {false}

Use the password template.

Definition at line 117 of file appsettings.h.

◆ useTrayIcon

bool AppSettings::useTrayIcon {false}

Show a system tray icon.

Definition at line 128 of file appsettings.h.

◆ version

QString AppSettings::version

Last-run application version.

Definition at line 53 of file appsettings.h.

The documentation for this struct was generated from the following file: