twin.h

/* 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., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
#ifndef KWIN_H
#define KWIN_H
 
#include <sys/types.h>
#include <tqwindowdefs.h>
#include <tqstring.h>
#include <tqpixmap.h>
#include "tdelibs_export.h"
 
#ifdef Q_OS_UNIX
 
#include <netwm_def.h>
class NETWinInfo;

class TDECORE_EXPORT KWin
{
public:

    static void activateWindow( WId win, long time = 0 );

    static void forceActiveWindow( WId win, long time = 0 );
    static void setActiveWindow( WId win ) TDE_DEPRECATED;

    static void demandAttention( WId win, bool set = true );

    static void setUserTime( WId win, long time );

    static void invokeContextHelp();
 

    static void setMainWindow( TQWidget* subwindow, WId mainwindow );

    static void setSystemTrayWindowFor( WId trayWin, WId forWin );
 
    class WindowInfo;
    class WindowInfoPrivate;
    static WindowInfo windowInfo( WId win, unsigned long properties = 0, unsigned long properties2 = 0 );

    static WId transientFor( WId window );

    static WId groupLeader( WId window );

    static TQPixmap icon( WId win, int width = -1, int height = -1, bool scale = false );

    enum IconSource { NETWM = 1, 
              WMHints = 2, 
              ClassHint = 4, 
              XApp = 8 
    };

    static TQPixmap icon( WId win, int width, int height, bool scale, int flags );

    static void  setIcons( WId win, const TQPixmap& icon, const TQPixmap& miniIcon );

    static void setType( WId win, NET::WindowType windowType );

    static void setState( WId win, unsigned long state );

    static void clearState( WId win, unsigned long  state );
    
    static void setOpacity( WId win, uint percent );
    
    static void setShadowSize( WId win, uint percent );

    static void setOnAllDesktops( WId win, bool b );

    static void setOnDesktop( WId win, int desktop);

    static void setExtendedStrut( WId win, int left_width, int left_start, int left_end,
        int right_width, int right_start, int right_end, int top_width, int top_start, int top_end,
        int bottom_width, int bottom_start, int bottom_end );

    static void setStrut( WId win, int left, int right, int top, int bottom );
    static int currentDesktop();

    static int numberOfDesktops();

    static void setCurrentDesktop( int desktop );

    static void setCurrentDesktopViewport( int desktop, TQPoint viewport );

    static void iconifyWindow( WId win, bool animation = true  );

    static void deIconifyWindow( WId win, bool animation = true );

    static void raiseWindow( WId win );

    static void lowerWindow( WId win );

    static bool icccmCompliantMappingState();

    static bool allowedActionsSupported();

    static TQString readNameProperty( WId window, unsigned long atom );

    static bool compositingActive();

    struct TDECORE_EXPORT Info
    {
    WId win;
    long unsigned int state;
    bool isMinimized() const;
    bool isIconified() const;
    NET::MappingState mappingState;
    NETStrut strut;
    NET::WindowType windowType;
    TQString visibleName;
    TQString name;
    int desktop;
    bool onAllDesktops;
    pid_t pid;
    TQRect geometry;
    TQRect frameGeometry;
 
    TQString visibleNameWithState() const;
    };

    static Info info( WId win ) TDE_DEPRECATED;
 
#ifdef KDE_NO_COMPAT
private:
#endif
    static void appStarted() TDE_DEPRECATED;
};
 

class TDECORE_EXPORT KWin::WindowInfo
{
public:
    WindowInfo( WId window, unsigned long properties, unsigned long properties2 );
    WindowInfo(); // to make TQValueList and others happy
    ~WindowInfo();
    bool valid( bool withdrawn_is_valid = false ) const;
    WId win() const;
    unsigned long state() const;
    bool hasState( unsigned long s ) const { return ( state() & s ) == s; }
    bool isMinimized() const;
    NET::MappingState mappingState() const;
    NETExtendedStrut extendedStrut() const;
    NETStrut strut() const;
    NET::WindowType windowType( int supported_types ) const;
    TQString visibleName() const;
    TQString visibleNameWithState() const;
    TQString name() const;
    TQString visibleIconName() const;
    TQString visibleIconNameWithState() const;
    TQString iconName() const;
    bool isOnCurrentDesktop() const;
    bool isOnDesktop( int desktop ) const;
    bool onAllDesktops() const;
    int desktop() const;
    TQRect geometry() const;
    TQRect frameGeometry() const;
    WId transientFor() const;
    WId groupLeader() const;

    TQCString windowClassClass() const;

    TQCString windowClassName() const;

    TQCString windowRole() const;

    TQCString clientMachine() const;

    bool actionSupported( NET::Action action ) const;
 
    WindowInfo( const WindowInfo& );
    WindowInfo& operator=( const WindowInfo& );
private:
    WindowInfoPrivate* d;
};
 
#endif //Q_OS_UNIX
 
#endif