Pages
API Documentation
On this page

KCoreConfigSkeleton::ItemEnum::Choice Struct

Provides strongly typed enum options for use with KConfigXT. More...

  • Header: #include <Choice>
  • CMake: find_package(KF6 REQUIRED COMPONENTS Config)
    target_link_libraries(mytarget PRIVATE KF6::ConfigCore)

List of all members, including inherited members

Detailed Description

Enums specified with KConfigXT should be mapped to enums in the C++ codebase, as the generated getter for the ItemEnum will return an int.

See also Using KConfig XT, ItemEnum

Member Variable Documentation

QString Choice::label

The short description for the entry.

This tag will be ignored unless you set SetUserTexts=true.

QString Choice::name

The choice name. This should match the key name in the C++ codebase.

This will be used as the value of the enum key if Choice::value is not specified.

QString Choice::toolTip

A more verbose description for the entry.

This tag will be ignored unless you set SetUserTexts=true.

QString Choice::value

The value for the entry key as displayed in the configuration file.

QString Choice::whatsThis

The WhatsThis description for this entry.

We use cookies to personalize content and to analyze our traffic. Please decide if you are willing to accept cookies from our website.