• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

Konsole

Konsole::ProfileGroup

Konsole::ProfileGroup Class Reference

#include <Profile.h>

Inheritance diagram for Konsole::ProfileGroup:

Inheritance graph
[legend]

List of all members.


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 461 of file Profile.h.


Public Types

typedef KSharedPtr< ProfileGroup > Ptr

Public Member Functions

void addProfile (Profile::Ptr profile)
 ProfileGroup (Profile::Ptr parent=Profile::Ptr())
QList< Profile::Ptr > profiles () const
void removeProfile (Profile::Ptr profile)
void setProperty (Property property, const QVariant &value)
void updateValues ()

Member Typedef Documentation

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

Reimplemented from Konsole::Profile.

Definition at line 464 of file Profile.h.


Constructor & Destructor Documentation

Konsole::ProfileGroup::ProfileGroup ( Profile::Ptr  parent = Profile::Ptr()  )  [inline]

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

Definition at line 503 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 472 of file Profile.h.

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

Returns the profiles in this group .

Definition at line 481 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 477 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 527 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 494 of file Profile.cpp.


The documentation for this class was generated from the following files:
  • Profile.h
  • Profile.cpp

Konsole

Skip menu "Konsole"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • Konsole
  • Libraries
  •   libkonq
Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal