Konsole::ProfileGroup Class Reference

#include <Profile.h>

Inheritance diagram for Konsole::ProfileGroup:

Public Types
typedef KSharedPtr< ProfileGroup >	Ptr
Public Types inherited from Konsole::Profile
typedef KSharedPtr< ProfileGroup >	GroupPtr
enum	Property {   Path, Name, UntranslatedName, Icon,   Command, Arguments, Environment, Directory,   LocalTabTitleFormat, RemoteTabTitleFormat, ShowTerminalSizeHint, Font,   ColorScheme, KeyBindings, HistoryMode, HistorySize,   ScrollBarPosition, ScrollFullPage, BidiRenderingEnabled, BlinkingTextEnabled,   FlowControlEnabled, LineSpacing, BlinkingCursorEnabled, UseCustomCursorColor,   CursorShape, CustomCursorColor, WordCharacters, TripleClickMode,   UnderlineLinksEnabled, OpenLinksByDirectClickEnabled, CtrlRequiredForDrag, AutoCopySelectedText,   TrimTrailingSpacesInSelectedText, PasteFromSelectionEnabled, PasteFromClipboardEnabled, MiddleClickPasteMode,   DefaultEncoding, AntiAliasFonts, BoldIntense, StartInCurrentSessionDir,   SilenceSeconds, BellMode, TerminalColumns, TerminalRows,   MenuIndex, MouseWheelZoomEnabled }
typedef KSharedPtr< Profile >	Ptr

Public Member Functions
	ProfileGroup (Profile::Ptr parent=Profile::Ptr())
void	addProfile (Profile::Ptr profile)
QList< Profile::Ptr >	profiles () const
void	removeProfile (Profile::Ptr profile)
void	setProperty (Property property, const QVariant &value)
void	updateValues ()
Public Member Functions inherited from Konsole::Profile
	Profile (Ptr parent=Ptr())
virtual	~Profile ()
bool	antiAliasFonts () const
QStringList	arguments () const
const GroupPtr	asGroup () const
GroupPtr	asGroup ()
bool	autoCopySelectedText () const
bool	bidiRenderingEnabled () const
bool	blinkingCursorEnabled () const
bool	blinkingTextEnabled () const
bool	boldIntense () const
void	clone (Ptr profile, bool differentOnly=true)
QString	colorScheme () const
QString	command () const
QColor	customCursorColor () const
QString	defaultEncoding () const
QString	defaultWorkingDirectory () const
QStringList	environment () const
bool	flowControlEnabled () const
QFont	font () const
int	historySize () const
QString	icon () const
bool	isEmpty () const
bool	isHidden () const
virtual bool	isPropertySet (Property property) const
QString	keyBindings () const
int	lineSpacing () const
QString	localTabTitleFormat () const
QString	menuIndex () const
int	menuIndexAsInt () const
bool	mouseWheelZoomEnabled () const
QString	name () const
const Ptr	parent () const
QString	path () const
const QStringList	propertiesInfoList () const
template<class T >
T	property (Property property) const
template<>
QVariant	property (Property aProperty) const
QString	remoteTabTitleFormat () const
void	setHidden (bool hidden)
void	setParent (Ptr parent)
virtual QHash< Property, QVariant >	setProperties () const
bool	showTerminalSizeHint () const
int	silenceSeconds () const
bool	startInCurrentSessionDir () const
int	terminalColumns () const
int	terminalRows () const
bool	underlineLinksEnabled () const
QString	untranslatedName () const
bool	useCustomCursorColor () const
QString	wordCharacters () const
Public Member Functions inherited from QSharedData
	QSharedData ()
	QSharedData (const QSharedData &other)

Additional Inherited Members
Static Public Member Functions inherited from Konsole::Profile
static Property	lookupByName (const QString &name)

Detailed Description

A composite profile which allows a group of profiles to be treated as one.

When setting a property, the new value is applied to all profiles in the group. When reading a property, if all profiles in the group have the same value then that value is returned, otherwise the result is null.

Profiles can be added to the group using addProfile(). When all profiles have been added updateValues() must be called to sync the group's property values with those of the group's profiles.

The Profile::Name and Profile::Path properties are unique to individual profiles, setting these properties on a ProfileGroup has no effect.

Definition at line 599 of file Profile.h.

Member Typedef Documentation

typedef KSharedPtr<ProfileGroup> Konsole::ProfileGroup::Ptr

Definition at line 602 of file Profile.h.

Constructor & Destructor Documentation

Konsole::ProfileGroup::ProfileGroup ( Profile::Ptr  parent = Profile::Ptr() )

inlineexplicit

Construct a new profile group, which is hidden by default.

Definition at line 648 of file Profile.h.

Member Function Documentation

void Konsole::ProfileGroup::addProfile ( Profile::Ptr  profile )

inline

Add a profile to the group.

Calling setProperty() will update this profile. When creating a group, add the profiles to the group then call updateValues() to make the group's property values reflect the profiles currently in the group.

Definition at line 612 of file Profile.h.

QList<Profile::Ptr> Konsole::ProfileGroup::profiles ( ) const

inline

Returns the profiles in this group .

Definition at line 623 of file Profile.h.

void Konsole::ProfileGroup::removeProfile ( Profile::Ptr  profile )

inline

Remove a profile from the group.

Calling setProperty() will no longer affect this profile.

Definition at line 618 of file Profile.h.

void ProfileGroup::setProperty ( Property  property, const QVariant &  value  )

virtual

Sets the value of property in each of the group's profiles to value.

Reimplemented from Konsole::Profile.

Definition at line 364 of file Profile.cpp.

void ProfileGroup::updateValues

(

)

Updates the property values in this ProfileGroup to match those from the group's profiles()

For each available property, if each profile in the group has the same value then the ProfileGroup will use that value for the property. Otherwise the value for the property will be set to a null QVariant

Some properties such as the name and the path of the profile will always be set to null if the group has more than one profile.

Definition at line 335 of file Profile.cpp.

---

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

• Profile.h
• Profile.cpp