Fcitx
Public Member Functions | List of all members
fcitx::GlobalConfig Class Reference

Public Member Functions

const KeyList & triggerKeys () const
 
bool enumerateWithTriggerKeys () const
 
const KeyList & altTriggerKeys () const
 
const KeyList & activateKeys () const
 
const KeyList & deactivateKeys () const
 
const KeyList & enumerateForwardKeys () const
 
const KeyList & enumerateBackwardKeys () const
 
bool enumerateSkipFirst () const
 
const KeyList & enumerateGroupForwardKeys () const
 
const KeyList & enumerateGroupBackwardKeys () const
 
const KeyList & togglePreeditKeys () const
 
bool activeByDefault () const
 
PropertyPropagatePolicy resetStateWhenFocusIn () const
 Reset active state to the value of activeByDefault on Focus In. More...
 
bool showInputMethodInformation () const
 
bool showInputMethodInformationWhenFocusIn () const
 
bool compactInputMethodInformation () const
 
bool showFirstInputMethodInformation () const
 
PropertyPropagatePolicy shareInputState () const
 
bool preeditEnabledByDefault () const
 
const KeyList & defaultPrevPage () const
 
const KeyList & defaultNextPage () const
 
const KeyList & defaultPrevCandidate () const
 
const KeyList & defaultNextCandidate () const
 
int defaultPageSize () const
 
bool overrideXkbOption () const
 Override the xkb option from display. More...
 
const std::string & customXkbOption () const
 The enforce the xkb option for custom xkb state. More...
 
bool allowInputMethodForPassword () const
 Allow use input method in password field. More...
 
bool showPreeditForPassword () const
 Show preedit when typing in password field. More...
 
int autoSavePeriod () const
 Number of minutes that fcitx will automatically save user data. More...
 
int modifierOnlyKeyTimeout () const
 Number of milliseconds that modifier only key can be triggered with key release. More...
 
bool checkModifierOnlyKeyTimeout (uint64_t lastPressedTime) const
 Helper function to check whether the modifier only key should be triggered. More...
 
const std::vector< std::string > & enabledAddons () const
 
const std::vector< std::string > & disabledAddons () const
 
void setEnabledAddons (const std::vector< std::string > &addons)
 
void setDisabledAddons (const std::vector< std::string > &addons)
 
bool preloadInputMethod () const
 
void load (const RawConfig &rawConfig, bool partial=false)
 
void save (RawConfig &rawConfig) const
 
bool safeSave (const std::string &path="config") const
 
const Configuration & config () const
 
Configuration & config ()
 

Detailed Description

Definition at line 25 of file globalconfig.h.

Member Function Documentation

◆ allowInputMethodForPassword()

bool fcitx::GlobalConfig::allowInputMethodForPassword ( ) const

Allow use input method in password field.

Returns
whether allow use input method in password field.
Since
5.1.2

Definition at line 430 of file globalconfig.cpp.

◆ autoSavePeriod()

int fcitx::GlobalConfig::autoSavePeriod ( ) const

Number of minutes that fcitx will automatically save user data.

Returns
the period of auto save
Since
5.1.2

Definition at line 440 of file globalconfig.cpp.

◆ checkModifierOnlyKeyTimeout()

bool fcitx::GlobalConfig::checkModifierOnlyKeyTimeout ( uint64_t  lastPressedTime) const

Helper function to check whether the modifier only key should be triggered.

The user may need to record the time when the corresponding modifier only key is pressed. The input time should use CLOCK_MONOTONIC.

If timeout < 0, always return true. Otherwise, check if it should be triggered based on current time.

Returns
should trigger modifier only key

Definition at line 450 of file globalconfig.cpp.

◆ customXkbOption()

const std::string & fcitx::GlobalConfig::customXkbOption ( ) const

The enforce the xkb option for custom xkb state.

This is only useful for custom xkb translation. Right now there is no way to read system xkb option from wayland. Instead, we can ask user for the fallback.

Returns
override xkb option
See also
GlobalConfig::overrideXkbOption
Since
5.0.14

Definition at line 400 of file globalconfig.cpp.

◆ modifierOnlyKeyTimeout()

int fcitx::GlobalConfig::modifierOnlyKeyTimeout ( ) const

Number of milliseconds that modifier only key can be triggered with key release.

Returns
timeout
Since
5.1.12

Definition at line 445 of file globalconfig.cpp.

◆ overrideXkbOption()

bool fcitx::GlobalConfig::overrideXkbOption ( ) const

Override the xkb option from display.

This is only useful for custom xkb translation. Right now there is no way to read system xkb option from wayland. Instead, we can ask user for the fallback.

Returns
override xkb option from system or not
Since
5.0.14

Definition at line 395 of file globalconfig.cpp.

◆ resetStateWhenFocusIn()

PropertyPropagatePolicy fcitx::GlobalConfig::resetStateWhenFocusIn ( ) const

Reset active state to the value of activeByDefault on Focus In.

See also
activeByDefault
Returns
the reset policy, no for disable, all for always reset, program for only reset on program changes.
Since
5.1.8

Definition at line 335 of file globalconfig.cpp.

◆ showPreeditForPassword()

bool fcitx::GlobalConfig::showPreeditForPassword ( ) const

Show preedit when typing in password field.

Returns
whether show preedit in password field.
Since
5.1.2

Definition at line 435 of file globalconfig.cpp.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13