KDevelop::ConfigPage Class Reference

#include <configpage.h>

Inherits ConfigPage.

Public Types
enum	ConfigPageType {   DefaultConfigPage, LanguageConfigPage, AnalyzerConfigPage, DocumentationConfigPage,   RuntimeConfigPage }

Public Slots
void	apply () override
void	defaults () override
void	reset () override

Public Member Functions
	ConfigPage (IPlugin *plugin, KCoreConfigSkeleton *config=nullptr, QWidget *parent=nullptr)
	~ConfigPage () override
virtual ConfigPage *	childPage (int number)
virtual int	childPages () const
virtual ConfigPageType	configPageType () const
KCoreConfigSkeleton *	configSkeleton () const
void	initConfigManager ()
IPlugin *	plugin () const
void	setConfigSkeleton (KCoreConfigSkeleton *skel)

Detailed Description

Definition at line 35 of file configpage.h.

Member Enumeration Documentation

ConfigPageType

enum KDevelop::ConfigPage::ConfigPageType

Enumerator
DefaultConfigPage
LanguageConfigPage	A config page that contains language specific settings. This page is appended as a child page to the "Language support" config page.
AnalyzerConfigPage	A config page that contains settings for some analyzer. This page is appended as a child page to the "Analyzers" config page.
DocumentationConfigPage	A config page that contains settings for some documentation plugin. This page is appended as a child page to the "Documentation" config page.
RuntimeConfigPage	A config page that contains settings for some runtime plugin. This page is appended as a child page to the "Runtimes" config page.

Definition at line 64 of file configpage.h.

Constructor & Destructor Documentation

ConfigPage()

KDevelop::ConfigPage::ConfigPage ( IPlugin *  plugin, KCoreConfigSkeleton *  config = nullptr, QWidget *  parent = nullptr  )

explicit

Create a new config page.

Parameters

plugin	the plugin that created this config page
config	the config skeleton that is used to store the preferences. If you don't use a K(Core)ConfigSkeleton to save the settings you can also pass null here. However this means that you will have to manually implement the apply(), defaults() and reset() slots
parent	parent widget

Definition at line 39 of file configpage.cpp.

~ConfigPage()

KDevelop::ConfigPage::~ConfigPage ( )

override

Definition at line 46 of file configpage.cpp.

Member Function Documentation

apply

void KDevelop::ConfigPage::apply ( )

overrideslot

Definition at line 50 of file configpage.cpp.

childPage()

ConfigPage * KDevelop::ConfigPage::childPage ( int  number )

virtual

Returns

the child config page for index number or nullptr if there is none. The default implementation returns nullptr.

Definition at line 127 of file configpage.cpp.

childPages()

int KDevelop::ConfigPage::childPages ( ) const

virtual

Get the number of subpages of this page.

Returns

The number of child pages or an integer < 1 if there are none. The default implementation returns zero.

Definition at line 122 of file configpage.cpp.

configPageType()

ConfigPage::ConfigPageType KDevelop::ConfigPage::configPageType ( ) const

virtual

Returns

The type of this config page. Default implementaion returns DefaultConfigPageType

Definition at line 140 of file configpage.cpp.

configSkeleton()

KCoreConfigSkeleton * KDevelop::ConfigPage::configSkeleton

(

)

const

Returns

the KCoreConfigSkeleton used to store the settings for this page or nullptr if settings are managed differently

Definition at line 93 of file configpage.cpp.

defaults

void KDevelop::ConfigPage::defaults ( )

overrideslot

Definition at line 64 of file configpage.cpp.

initConfigManager()

void KDevelop::ConfigPage::initConfigManager

(

)

Initializes the KConfigDialogManager.

Must be called explicitly since not all child widgets are available at the end of the constructor. This is handled automatically by KDevelop::ConfigDialog, subclasses don't need to call this.

Definition at line 84 of file configpage.cpp.

plugin()

IPlugin * KDevelop::ConfigPage::plugin

(

)

const

Returns

the plugin that this config page was created by or nullptr if it was not created by a plugin.

Definition at line 133 of file configpage.cpp.

reset

void KDevelop::ConfigPage::reset ( )

overrideslot

Definition at line 74 of file configpage.cpp.

setConfigSkeleton()

void KDevelop::ConfigPage::setConfigSkeleton

(

KCoreConfigSkeleton *

skel

)

Sets the config skeleton to skel and will create a KConfigDialogManager if needed.

This can be used if the KCoreConfigSkeleton* doesn't exist yet when calling the base class constructor.

Definition at line 100 of file configpage.cpp.

---

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

• configpage.h
• configpage.cpp