• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

Plasma

  • plasma
windoweffects.h
Go to the documentation of this file.
1/*
2 * Copyright 2009 Marco Martin <notmart@gmail.com>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU Library General Public License as
6 * published by the Free Software Foundation; either version 2, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details
13 *
14 * You should have received a copy of the GNU Library General Public
15 * License along with this program; if not, write to the
16 * Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 */
19
20#ifndef PLASMA_WINDOWEFFECTS_H
21#define PLASMA_WINDOWEFFECTS_H
22
23#include <QtGui/QWidget>
24
25#include <plasma/plasma.h>
26
29namespace Plasma
30{
31
36namespace WindowEffects
37{
38 enum Effect {
39 Slide = 1,
40 WindowPreview = 2,
41 PresentWindows = 3,
42 PresentWindowsGroup = 4,
43 HighlightWindows = 5,
44 OverrideShadow = 6,
45 BlurBehind = 7,
46 Dashboard = 8
47 };
48
55 PLASMA_EXPORT bool isEffectAvailable(Effect effect);
56
66 PLASMA_EXPORT void slideWindow(WId id, Plasma::Location location, int offset);
67
77 PLASMA_EXPORT void slideWindow(QWidget *widget, Plasma::Location location);
78
85 PLASMA_EXPORT QList<QSize> windowSizes(const QList<WId> &ids);
86
98 PLASMA_EXPORT void showWindowThumbnails(WId parent, const QList<WId> &windows = QList<WId>(), const QList<QRect> &rects = QList<QRect>());
99
108 PLASMA_EXPORT void presentWindows(WId controller, const QList<WId> &ids);
109
118 PLASMA_EXPORT void presentWindows(WId controller, int desktop = -1);
119
128 PLASMA_EXPORT void highlightWindows(WId controller, const QList<WId> &ids);
129
137 PLASMA_EXPORT void overrideShadow(WId window, bool override);
138
153 PLASMA_EXPORT void enableBlurBehind(WId window, bool enable = true, const QRegion &region = QRegion());
154
163 PLASMA_EXPORT void markAsDashboard(WId window);
164}
165
166} // namespace Plasma
167
168#endif
169
QWidget
Plasma::WindowEffects::showWindowThumbnails
void showWindowThumbnails(WId parent, const QList< WId > &windows, const QList< QRect > &rects)
Paint inside the window parent the thumbnails of the windows list in the respective rectangles of the...
Definition: windoweffects.cpp:182
Plasma::WindowEffects::presentWindows
void presentWindows(WId controller, const QList< WId > &ids)
Activate the Present Windows effect for the given groups of windows.
Definition: windoweffects.cpp:224
Plasma::WindowEffects::enableBlurBehind
void enableBlurBehind(WId window, bool enable, const QRegion &region)
Instructs the window manager to blur the background in the specified region behind the given window.
Definition: windoweffects.cpp:310
Plasma::WindowEffects::slideWindow
void slideWindow(WId id, Plasma::Location location, int offset)
Mark a window as sliding from screen edge.
Definition: windoweffects.cpp:97
Plasma::WindowEffects::windowSizes
QList< QSize > windowSizes(const QList< WId > &ids)
Definition: windoweffects.cpp:164
Plasma::WindowEffects::markAsDashboard
void markAsDashboard(WId window)
Instructs the window manager to handle the given window as dashboard window as Dashboard windows shou...
Definition: windoweffects.cpp:331
Plasma::WindowEffects::highlightWindows
void highlightWindows(WId controller, const QList< WId > &ids)
Highlight the selected windows, making all the others translucent.
Definition: windoweffects.cpp:262
Plasma::WindowEffects::overrideShadow
void overrideShadow(WId window, bool override)
Forbid te windowmanager to automatically generate a shadow for this window.
Definition: windoweffects.cpp:294
Plasma::WindowEffects::isEffectAvailable
bool isEffectAvailable(Effect effect)
Definition: windoweffects.cpp:44
Plasma::WindowEffects::Effect
Effect
Definition: windoweffects.h:38
Plasma::WindowEffects::PresentWindows
@ PresentWindows
Definition: windoweffects.h:41
Plasma::WindowEffects::OverrideShadow
@ OverrideShadow
Definition: windoweffects.h:44
Plasma::WindowEffects::PresentWindowsGroup
@ PresentWindowsGroup
Definition: windoweffects.h:42
Plasma::WindowEffects::BlurBehind
@ BlurBehind
Definition: windoweffects.h:45
Plasma::WindowEffects::WindowPreview
@ WindowPreview
Definition: windoweffects.h:40
Plasma::WindowEffects::Slide
@ Slide
Definition: windoweffects.h:39
Plasma::WindowEffects::Dashboard
@ Dashboard
Definition: windoweffects.h:46
Plasma::WindowEffects::HighlightWindows
@ HighlightWindows
Definition: windoweffects.h:43
Plasma
Namespace for everything in libplasma.
Definition: abstractdialogmanager.cpp:25
Plasma::Location
Location
The Location enumeration describes where on screen an element, such as an Applet or its managing cont...
Definition: plasma.h:108
plasma.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Plasma

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

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal