Source: kwinmodule.h


Annotated List
Files
Globals
Hierarchy
Index
/* This file is part of the KDE libraries
    Copyright (C) 1999 Matthias Ettrich (ettrich@kde.org)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
*/
/*
 * kwinmodule.h. Part of the KDE project.
 */

#ifndef KWINMODULE_H
#define KWINMODULE_H

#include 
#include 

class KWinModulePrivate;

/**
 *
 * The class KWinModule provides information about the state of the
 * window manager as required by windowmanager modules. It informs a
 * module about all currently managed windows and changes to them (via
 * Qt signals).
 *
 * KWinModule uses NETRootInfo internally. Modules written with this
 * class will work fine under any window manager that implements the
 * NET_WM protocol.
 *
 * There are no methods to manipulate windows. Those are defined in
 * the classes KWin, NETWinInfo and NETRootInfo.
 *
 *
 * @short Base class for KDE Window Manager modules.
 * @author Matthias Ettrich (ettrich@kde.org)
 * @version $Id: kwinmodule_h.html 132191 2002-01-17 21:32:13Z dfaure $
 */
class KWinModule : public QObject
{
    Q_OBJECT

public:

    /**
     * Creates a KWinModule object and connects to the window
     * manager.
     **/
    KWinModule( QObject* parent = 0 );

    /**
     * Destructor. Internal cleanup, nothing fancy.
     **/
    ~KWinModule();

  /**
   * Retrurns the list of all toplevel windows currently managed by the
   * windowmanger in the order of creation. Please do not rely on
   * indexes of this list: Whenever you enter Qt's eventloop in your
   * application it may happen that entries are removed or added.
   * Your module should perhaps work on a copy of this list and verify a
   * window with @ref hasWindow() before any operations.
   *
   * Iteration over this list can be done easily with
   * 
   *  QValueList::ConstIterator it;
   *  for ( it = module->windows().begin();
   *        it != modules->windows().end(); ++it ) {
   *     ... do something here,  (*it) is the current WId.
   *       }
   * 
*/ const QValueList& windows() const; /** * Returns the list of all toplevel windows currently managed by the * windowmanger in the current stacking order (from lower to * higher). May be useful for pagers. **/ const QValueList& stackingOrder() const; /** * Test to see if @p WId still managed at present. **/ bool hasWId(WId) const; /** * Retrieves a list of the system tray windows. **/ const QValueList& systemTrayWindows() const; /** * Returns the current virtual desktop **/ int currentDesktop() const; /** * Returns the number of virtual desktops **/ int numberOfDesktops() const; /** * Returns the currently active window, or 0 if no window is active. **/ WId activeWindow() const; /** * Returns the workarea for the specified desktop, or the current * work area if no desktop has been specified. **/ QRect workArea( int desktop = - 1 ) const; /** * Returns the workarea for the specified desktop, or the current * work area if no desktop has been specified. Excludes struts of * clients in the exclude List. **/ QRect workArea( const QValueList&, int desktop = -1) const; /** * Returns the name of the specified desktop **/ QString desktopName( int desktop ) const; /** * Sets the name of the specified desktop **/ void setDesktopName( int desktop, const QString& name ); /** * Informs kwin via dcop to not manage a window with the * specified @p title. * * Useful for swallowing legacy applications, for example java * applets. * */ void doNotManage( const QString& title ); signals: /** * Switched to another virtual desktop */ void currentDesktopChanged( int ); /** * A window has been added */ void windowAdded(WId); /** * A window has been removed */ void windowRemoved(WId); /** * Hint that is active (= has focus) now. */ void activeWindowChanged(WId); /** * Desktops have been renamed */ void desktopNamesChanged(); /** * The number of desktops changed */ void numberOfDesktopsChanged(int); /** * Add a dock window */ void systemTrayWindowAdded(WId); /** * Remove a dock window */ void systemTrayWindowRemoved(WId); /** * The workarea has changed */ void workAreaChanged(); /* Something changed with the struts, may or may not have changed * the work area. */ void strutChanged(); /** * The stacking order of the window changed. The new order * can be obtained with @ref stackingOrder() */ void stackingOrderChanged(); /** * The window changed. * * The unsigned int parameter contains the NET properties that * were modified (see netem_def.h). */ void windowChanged(WId, unsigned int ); /** * The window changed somehow. */ void windowChanged(WId ); private: KWinModulePrivate* d; friend class KWinModulePrivate; }; #endif

Generated by: dfaure on kde.faure.org on Thu Jan 17 22:15:01 2002, using kdoc 2.0a53.