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

KDEUI

Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
KToggleFullScreenAction Class Reference

#include <ktogglefullscreenaction.h>

Inheritance diagram for KToggleFullScreenAction:
Inheritance graph
[legend]

Public Member Functions

 KToggleFullScreenAction (QObject *parent)
 
 KToggleFullScreenAction (QWidget *window, QObject *parent)
 
virtual ~KToggleFullScreenAction ()
 
void setWindow (QWidget *window)
 
- Public Member Functions inherited from KToggleAction
 KToggleAction (QObject *parent)
 
 KToggleAction (const QString &text, QObject *parent)
 
 KToggleAction (const KIcon &icon, const QString &text, QObject *parent)
 
virtual ~KToggleAction ()
 
void setCheckedState (const KGuiItem &checkedItem)
 
- Public Member Functions inherited from KAction
 KAction (QObject *parent)
 
 KAction (const QString &text, QObject *parent)
 
 KAction (const KIcon &icon, const QString &text, QObject *parent)
 
virtual ~KAction ()
 
KAuth::Action * authAction () const
 
bool event (QEvent *)
 
void forgetGlobalShortcut ()
 
const KShortcut & globalShortcut (ShortcutTypes type=ActiveShortcut) const
 
bool globalShortcutAllowed () const
 
bool isGlobalShortcutEnabled () const
 
bool isShortcutConfigurable () const
 
KRockerGesture rockerGesture (ShortcutTypes type=ActiveShortcut) const
 
void setAuthAction (KAuth::Action *action)
 
void setAuthAction (const QString &actionName)
 
void setGlobalShortcut (const KShortcut &shortcut, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut), GlobalShortcutLoading loading=Autoloading)
 
void setGlobalShortcutAllowed (bool allowed, GlobalShortcutLoading loading=Autoloading)
 
void setHelpText (const QString &text)
 
void setRockerGesture (const KRockerGesture &gest, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
 
void setShapeGesture (const KShapeGesture &gest, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
 
void setShortcut (const KShortcut &shortcut, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
 
void setShortcut (const QKeySequence &shortcut, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
 
void setShortcutConfigurable (bool configurable)
 
void setShortcuts (const QList< QKeySequence > &shortcuts, ShortcutTypes type=ShortcutTypes(ActiveShortcut|DefaultShortcut))
 
KShapeGesture shapeGesture (ShortcutTypes type=ActiveShortcut) const
 
KShortcut shortcut (ShortcutTypes types=ActiveShortcut) const
 

Static Public Member Functions

static void setFullScreen (QWidget *window, bool set)
 

Protected Member Functions

bool eventFilter (QObject *object, QEvent *event)
 

Additional Inherited Members

- Public Types inherited from KAction
enum  GlobalShortcutLoading { Autoloading = 0x0, NoAutoloading = 0x4 }
 
enum  ShortcutType { ActiveShortcut = 0x1, DefaultShortcut = 0x2 }
 
- Signals inherited from KAction
void authorized (KAuth::Action *action)
 
void globalShortcutChanged (const QKeySequence &)
 
void triggered (Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers)
 
- Protected Slots inherited from KToggleAction
virtual void slotToggled (bool checked)
 
- Properties inherited from KAction
KShortcut globalShortcut
 
bool globalShortcutAllowed
 
bool globalShortcutEnabled
 
KShortcut shortcut
 
bool shortcutConfigurable
 

Detailed Description

An action for switching between to/from full screen mode.

Note that QWidget::isFullScreen() may reflect the new or the old state depending on how the action was triggered (by the application or from the window manager). Also don't try to track the window state yourself. Rely on this action's state (isChecked()) instead.

Important: If you need to set/change the fullscreen state manually, use KToggleFullScreenAction::setFullScreen() or a similar function, do not call directly the slot connected to the toggled() signal. The slot still needs to explicitly set the window state though.

Note: Do NOT use QWidget::showFullScreen() or QWidget::showNormal(). They have several side-effects besides just switching the fullscreen state (for example, showNormal() resets all window states, not just fullscreen). Use the KToggleFullScreenAction::setFullScreen() helper function.

Definition at line 49 of file ktogglefullscreenaction.h.

Constructor & Destructor Documentation

KToggleFullScreenAction::KToggleFullScreenAction ( QObject *  parent)
explicit

Create a KToggleFullScreenAction.

Call setWindow() to associate this action with a window.

Parameters
parentThis action's parent object.

Definition at line 64 of file ktogglefullscreenaction.cpp.

KToggleFullScreenAction::KToggleFullScreenAction ( QWidget *  window,
QObject *  parent 
)

Create a KToggleFullScreenAction.

Parameters
windowthe window that will switch to/from full screen mode
parentThis action's parent object.

Definition at line 71 of file ktogglefullscreenaction.cpp.

KToggleFullScreenAction::~KToggleFullScreenAction ( )
virtual

Destroys the toggle fullscreen action.

Definition at line 79 of file ktogglefullscreenaction.cpp.

Member Function Documentation

bool KToggleFullScreenAction::eventFilter ( QObject *  object,
QEvent *  event 
)
protected

Definition at line 101 of file ktogglefullscreenaction.cpp.

void KToggleFullScreenAction::setFullScreen ( QWidget *  window,
bool  set 
)
static

Helper function to set or reset the fullscreen state of a window.

Use this function rather than showFullScreen()/showNormal() QWidget functions.

Since
4.0.3

Definition at line 112 of file ktogglefullscreenaction.cpp.

void KToggleFullScreenAction::setWindow ( QWidget *  window)

Sets the window that will be related to this action.

Definition at line 84 of file ktogglefullscreenaction.cpp.


The documentation for this class was generated from the following files:
  • ktogglefullscreenaction.h
  • ktogglefullscreenaction.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:49:18 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDEUI

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

kdelibs API Reference

Skip menu "kdelibs 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
  • kjsembed
  •   WTF
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Nepomuk-Core
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



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