Skip to main content
Skip to content

Configuration keys

List of all the configurations keys available for the scripting API

Here you find a list of commonly used configuration keys to use with the writeConfig() command. Where the documentation notes that a key is in a subgroup other than General, remember to first use currentConfigGroup.

org.kde.plasma.analogclock

General

  • showSecondHand: (Bool, default: false)
  • showTimezoneString: (Bool, default: false)

org.kde.plasma.appmenu

Appearance

  • compactView: (Bool, default: false) If true it only shows a button for the application menu.

org.kde.plasma.calendar

Agenda

  • startOfWorkingDay: (int, default: 9)
  • endOfWorkingDay: (int, default: 17)
  • showWeekNumbers: (Bool, default: false)
  • compactDisplay: (String, default: d)

org.kde.plasma.clipboard

General

  • barcodeType: (String, default: QRCode)

org.kde.plasma.icon

General

  • url: (String, default: empty string)
  • localPath: (String, default: empty string)

org.kde.plasma.panelspacer

General

  • expanding: (bool, default: true) If true, the spacer tries to take all the available space in the panel.
  • length: (Int, default: -1) length in pixels of the spacer. Configuration effective only if expanding is set to false. A negative value means an invalid value that should be completely ignored.

org.kde.plasma.systemtray

General

  • extraItems: (StringList, default: empty list) All plasmoid items that are explicitly enabled in the systray. It's a comma-separated string list of plasmoid plugin ids.
  • disabledStatusNotifiers: (StringList, default: empty list) All StatusNotifier items that shouldn't be visible at all. It's a comma-separated string list of StatusNotifier ids.
  • hiddenItems: (StringList, default: empty list) All items that are hidden, forced always in the popup. It's a comma-separated string list of unique identifiers that are either plasmoid plugin ids or StatusNotifier ids.
  • shownItems: (StringList, default: empty list) All items that are shown. It's a comma-separated string list of unique identifiers that are either plasmoid plugin ids or StatusNotifier ids.
  • showAllItems: (bool, default: false) If true, all systray entries will be always in the main area, outside the popup.
  • scaleIconsToFit: (bool, default: false) Whether to automatically scale System Tray icons to fix the available thickness of the panel. If false, tray icons will be capped at the smallMedium size (22px) and become a two-row/column layout when the panel is thick.
  • iconSpacing: (int, default: 2) spacing between icons, determined by this number multiplied by Kirigami.Units.smallSpacing
  • pin: (Bool, default: false) Whether the popup should remain open when another window is activated

org.kde.plasma.colorpicker

General

  • history: (StringList, default: empty list)
  • autoClipboard: (Bool, default: true)
  • defaultFormat: (String, default: #RRGGBB)
  • pickOnActivate: (Bool, default: true)
  • compactPreviewCount: (Int, default: 1)

org.kde.plasma_applet_dict

General

  • dictionary: (String, default: all)

org.kde.plasma.fifteenpuzzle

Appearance

  • imagePath: (String, default: empty string)
  • useImage: (Bool, default: false)
  • showNumerals: (Bool, default: true)
  • boardColor: (Color, default: #333333)
  • numberColor: (Color, default: #ffffff)
  • boardSize: (Int, default: 4)

org.kde.plasma.fuzzyclock

Appearance

  • fuzzyness: (Int, default: 1)
  • boldText: (Bool, default: false)
  • italicText: (Bool, default: false)

org.kde.plasma.grouping

General

    org.kde.plasma.mediaframe

    General

    • interval: (Double, default: 10.0)
    • randomize: (Bool, default: true)
    • pauseOnMouseOver: (Bool, default: true)
    • leftClickOpenImage: (Bool, default: true)
    • showCountdown: (Bool, default: true)
    • fillMode: (int, default: 1)

    Paths

    • pathList: (StringList, default: empty list)

    org.kde.plasma.notes

    General

    • color: (String, default: yellow)
    • fontSize: (int, default: null)
    • noteId: (String, default: empty string)
    • scrollX: (Double, default: 0)
    • scrollY: (Double, default: 0)
    • cursorPosition: (Int, default: 0)
    • pinOpen: (Bool, default: false)

    org.kde.plasma.quicklaunch

    General

    • maxSectionCount: (Int, default: 1)
    • showLauncherNames: (Bool, default: false)
    • enablePopup: (Bool, default: false)
    • title: (String, default: empty string)
    • launcherUrls: (StringList, default: empty list)
    • popupUrls: (StringList, default: empty list)

    org.kde.plasma.timer

    General

    • predefinedTimers: (StringList, default: 30,60,120,300,450,600,900,1200,1500,1800,2700,3600)
    • running: (int, default: 0)
    • seconds: (int, default: 0)
    • savedAt: (DateTime, default: null)
    • showTitle: (Bool, default: false)
    • title: (String, default: Timer)
    • showRemainingTime: (Bool, default: true)
    • showSeconds: (Bool, default: true)
    • showTimerToggle: (Bool, default: true)
    • showProgressBar: (Bool, default: false)
    • showNotification: (Bool, default: true)
    • notificationText: (String, default: Timer finished)
    • runCommand: (Bool, default: false)
    • command: (String, default: empty string)

    org.kde.plasma.userswitcher

    General

    • showFace: (Bool, default: false)
    • showName: (Bool, default: true)
    • showFullName: (Bool, default: true)
    • showTechnicalInfo: (Bool, default: false)

    org.kde.plasma.webbrowser

    General

    • useDefaultUrl: (Bool, default: false)
    • defaultUrl: (String, default: https://www.kde.org/)
    • url: (String, default: https://www.kde.org/)
    • useMinViewWidth: (Bool, default: true)
    • minViewWidth: (Int, default: 600)
    • constantZoomFactor: (Int, default: 100)
    • icon: (String, default: empty string) The name of the icon used in the compact representation (e.g. on a small panel).
    • favIcon: (String, default: empty string) The url of the website's favicon that is saved in the last session.
    • useFavIcon: (Bool, default: true) Use the website's favicon instead of a system icon
    • enableNavigationBar: (Bool, default: true)
    • privateBrowsing: (Bool, default: true)

    org.kde.plasma.keyboardlayout

    General

    • displayStyle: (Enum, default: 0) Whether to show text, a flag, or both on the compact representation.

    org.kde.plasma.kimpanel

    Appearance

    • vertical_lookup_table: (Bool, default: false)
    • use_default_font: (Bool, default: true)
    • font: (Font, default: null)
    • hiddenList: (StringList, default: empty list)
    • scaleIconsToFit: (bool, default: false) Whether to automatically scale System Tray icons to fix the available thickness of the panel. If false, tray icons will be capped at the smallMedium size (22px) and become a two-row/column layout when the panel is thick.

    org.kde.plasma.marginsseparator

    General

    • icon: (String, default: user-desktop)

    org.kde.plasma.pager

    General

    • displayedText: (Enum, default: 2) The text to show inside the desktop rectangles.
    • showWindowOutlines: (Bool, default: true) Whether to show window outlines.
    • showWindowIcons: (Bool, default: false) Whether to show window icons inside the window rectangles.
    • showOnlyCurrentScreen: (Bool, default: false) Whether to limit the Pager to the set of windows and the geometry of the screen the widget resides on.
    • wrapPage: (Bool, default: false) Whether to wrap page when navigating with pager
    • currentDesktopSelected: (Enum, default: 0) What to do on left-mouse click on a desktop rectangle.
    • pagerLayout: (Enum, default: 0) The layout style used for the presentation.

    org.kde.plasma.showActivityManager

    General

    • showActivityName: (Bool, default: true) Show the current activity name
    • showActivityIcon: (Bool, default: true) Show the current activity icon instead of the applet icon

    org.kde.plasma.showdesktop

    General

    • icon: (String, default: user-desktop-symbolic)

    org.kde.plasma.taskmanager

    General

    • showOnlyCurrentScreen: (Bool, default: false) Whether to show only window tasks that are on the same screen as the widget.
    • showOnlyCurrentDesktop: (Bool, default: true) Whether to only show tasks that are on the current virtual desktop.
    • showOnlyCurrentActivity: (Bool, default: true) Whether to show only tasks that are on the current activity.
    • showOnlyMinimized: (Bool, default: false) Whether to show only window tasks that are minmized.
    • unhideOnAttention: (Bool, default: true) Whether to unhide if a window wants attention.
    • groupingStrategy: (Enum, default: 1) How tasks are grouped: 0 = Do Not Group, 1 = By Program Name
    • groupedTaskVisualization: (Enum, default: 0) What happens when clicking on a grouped task: 0 = cycle through grouped tasks, 1 = try to show tooltips, 2 = try to show present Windows effect, 3 = show textual list (AKA group dialog)
    • groupPopups: (Bool, default: true) Whether groups are to be reduced to a single task button and expand into a popup or task buttons are grouped on the widget itself.
    • onlyGroupWhenFull: (Bool, default: true) Whether to group always or only when the widget runs out of space to show additional task buttons comfortably.
    • groupingAppIdBlacklist: (StringList, default: empty list) The id's (usually .desktop file names) of applications that should not have their tasks grouped.
    • groupingLauncherUrlBlacklist: (StringList, default: empty list) The launcher URLs (usually .desktop file or executable URLs) of applications that should not have their tasks grouped.
    • sortingStrategy: (Int, default: 1) Values from TaskManager::TasksModel::SortMode
    • separateLaunchers: (Bool, default: true) Whether launcher tasks are sorted separately at the left side of the widget or can be mixed with other tasks.
    • hideLauncherOnStart: (Bool, default: true) Whether launcher tasks should be hidden when their application is launched.
    • maxStripes: (Int, default: 1) The maximum number of rows (in a horizontal-orientation containment, i.e. panel) or columns (in a vertical-orientation containment) to layout task buttons in.
    • forceStripes: (Bool, default: false) Whether to try and always layout task buttons in as many rows/columns as set via maxStripes.
    • showToolTips: (Bool, default: true) Whether to show tooltips when hovering task buttons.
    • taskMaxWidth: (Enum, default: 1) Tune the max width of task items.
    • wheelEnabled: (Enum, default: 0) Whether using the mouse wheel with the mouse pointer above the widget should switch between tasks.
    • wheelSkipMinimized: (Bool, default: true) Whether to skip minimized tasks when switching between them using the mouse wheel.
    • highlightWindows: (Bool, default: false) Whether to request the window manager highlight windows when hovering corresponding task tooltips.
    • launchers: (StringList, default: applications:systemsettings.desktop,applications:org.kde.discover.desktop,preferred://filemanager,preferred://browser) The list of launcher tasks on the widget. Usually .desktop file or executable URLs. Special URLs such as preferred://browser that expand to default applications are supported.
    • middleClickAction: (Enum, default: 2) What to do on middle-mouse click on a task button.
    • indicateAudioStreams: (Bool, default: true) Whether to indicate applications that are playing audio.
    • interactiveMute: (Bool, default: true) Whether to mute applications that are playing audio using audio indicators.
    • tooltipControls: (Bool, default: true) Whether to show media and volume controls in the tooltip.
    • fill: (Bool, default: true) Whether task manager should occupy all available space.
    • taskHoverEffect: (Bool, default: true) Whether task buttons should change in appearance when the mouse pointer is above them.
    • maxTextLines: (Int, default: 0) The maximum number of text lines to show in a task button. 0 means no limit.
    • minimizeActiveTaskOnClick: (Bool, default: true) Whether to minimize the currently-active task when clicked. If false, clicking on the currently-active task will do nothing.
    • reverseMode: (Bool, default: false) Whether to grow the tasks in according to system configuration or opposite to system configuration.
    • iconSpacing: (Int, default: 1) Spacing between icons in task manager. Margin is multiplied by this value.

    org.kde.plasma.windowlist

    General

    • showText: (Bool, default: true) Whether to show the window title when the applet is used on a horizontal panel