netwm_def.h

Go to the documentation of this file.

/*

  Copyright (c) 2000 Troll Tech AS
  Copyright (c) 2003 Lubos Lunak <l.lunak@kde.org>

  Permission is hereby granted, free of charge, to any person obtaining a
  copy of this software and associated documentation files (the "Software"),
  to deal in the Software without restriction, including without limitation
  the rights to use, copy, modify, merge, publish, distribute, sublicense,
  and/or sell copies of the Software, and to permit persons to whom the
  Software is furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  DEALINGS IN THE SOFTWARE.

*/

#ifndef   netwm_def_h
#define   netwm_def_h
#include <kdeui_export.h>

struct NETPoint {
    NETPoint() : x(0), y(0) { }

    /*
       Public data member.
    **/
    int x, 
      y;   
};


struct NETSize {
    NETSize() : width(0), height(0) { }

    /*
       Public data member.
    **/
    int width,  
      height;   
};

struct NETRect {
    NETPoint pos;

    NETSize size;
};


struct NETIcon {
    NETIcon() : data(0) { }

    NETSize size;

    unsigned char *data;
};


struct NETExtendedStrut {
    NETExtendedStrut() : left_width(0), left_start(0), left_end(0),
        right_width(0), right_start(0), right_end(0), top_width(0), top_start(0), top_end(0),
        bottom_width(0), bottom_start(0), bottom_end(0) {}

    int left_width, left_start, left_end;

    int right_width, right_start, right_end;

    int top_width, top_start, top_end;

    int bottom_width, bottom_start, bottom_end;
    
};


struct NETStrut {
    NETStrut() : left(0), right(0), top(0), bottom(0) { }

    int left;

    int right;

    int top;

    int bottom;
};


struct NETFullscreenMonitors {
    NETFullscreenMonitors() : top(-1), bottom(0), left(0), right(0) { }

    int top;

    int bottom;

    int left;

    int right;

    bool isSet() const { return (top != -1); };
};


class KDEUI_EXPORT NET {
public:
    enum Role {
    Client,
    WindowManager
    };

    enum WindowType {
    Unknown  = -1,
    Normal   = 0,
    Desktop  = 1,
    Dock     = 2,
    Toolbar  = 3,
    Menu     = 4,
    Dialog   = 5,
    Override = 6, // NON STANDARD
    TopMenu  = 7, // NON STANDARD
    Utility  = 8,
    Splash   = 9,
        DropdownMenu = 10,
        PopupMenu = 11,
        Tooltip = 12,
        Notification = 13,
        ComboBox = 14,
        DNDIcon = 15
    };
    
    enum WindowTypeMask {
    NormalMask   = 1<<0,   
    DesktopMask  = 1<<1,   
    DockMask     = 1<<2,   
    ToolbarMask  = 1<<3,   
    MenuMask     = 1<<4,   
    DialogMask   = 1<<5,   
    OverrideMask = 1<<6,   
    TopMenuMask  = 1<<7,   
    UtilityMask  = 1<<8,   
    SplashMask   = 1<<9,   
        DropdownMenuMask = 1<<10, 
        PopupMenuMask    = 1<<11, 
        TooltipMask      = 1<<12, 
        NotificationMask = 1<<13, 
        ComboBoxMask     = 1<<14, 
        DNDIconMask      = 1<<15, 
        AllTypesMask     = 0LU-1  
    };

    static bool typeMatchesMask( WindowType type, unsigned long mask );

    enum State {
    Modal        = 1<<0,
    Sticky       = 1<<1,
    MaxVert      = 1<<2,
    MaxHoriz     = 1<<3,
    Max = MaxVert | MaxHoriz,
    Shaded       = 1<<4,
    SkipTaskbar  = 1<<5,
    KeepAbove    = 1<<6,
    StaysOnTop   = KeepAbove,   // NOT STANDARD
    SkipPager    = 1<<7,
    Hidden       = 1<<8,
    FullScreen   = 1<<9,
    KeepBelow    = 1<<10,
        DemandsAttention = 1<<11
    };

    enum Direction {
    TopLeft      = 0,
    Top          = 1,
    TopRight     = 2,
    Right        = 3,
    BottomRight  = 4,
    Bottom       = 5,
    BottomLeft   = 6,
    Left         = 7,
    Move         = 8,  // movement only
    KeyboardSize = 9,  // size via keyboard
    KeyboardMove = 10, // move via keyboard
    MoveResizeCancel = 11 // to ask the WM to stop moving a window
    };

    enum MappingState {
    Visible = 1, //NormalState,
    Withdrawn = 0, //WithdrawnState,
    Iconic = 3 // IconicState
    };

    enum Action {
        ActionMove           = 1<<0,
        ActionResize         = 1<<1,
        ActionMinimize       = 1<<2,
        ActionShade          = 1<<3,
        ActionStick          = 1<<4,
        ActionMaxVert        = 1<<5,
        ActionMaxHoriz       = 1<<6,
        ActionMax            = ActionMaxVert | ActionMaxHoriz,
        ActionFullScreen     = 1<<7,
        ActionChangeDesktop  = 1<<8,
        ActionClose          = 1<<9
    };
    
    enum Property {
    // root
    Supported             = 1<<0,
    ClientList            = 1<<1,
    ClientListStacking    = 1<<2,
    NumberOfDesktops      = 1<<3,
    DesktopGeometry       = 1<<4,
    DesktopViewport       = 1<<5,
    CurrentDesktop        = 1<<6,
    DesktopNames          = 1<<7,
    ActiveWindow          = 1<<8,
    WorkArea              = 1<<9,
    SupportingWMCheck     = 1<<10,
    VirtualRoots          = 1<<11,
        //
    CloseWindow           = 1<<13,
    WMMoveResize          = 1<<14,

    // window
    WMName                = 1<<15,
    WMVisibleName         = 1<<16,
    WMDesktop             = 1<<17,
    WMWindowType          = 1<<18,
    WMState               = 1<<19,
    WMStrut               = 1<<20,
    WMIconGeometry        = 1<<21,
    WMIcon                = 1<<22,
    WMPid                 = 1<<23,
    WMHandledIcons        = 1<<24,
    WMPing                = 1<<25,
    XAWMState             = 1<<27,
        WMFrameExtents        = 1<<28,

    // Need to be reordered
    WMIconName            = 1<<29,
    WMVisibleIconName     = 1<<30,
    WMGeometry        = 1<<31
    };
    
    enum Property2 {
        WM2UserTime            = 1<<0,
        WM2StartupId           = 1<<1,
        WM2TransientFor        = 1<<2,
        WM2GroupLeader         = 1<<3,
        WM2AllowedActions      = 1<<4,
        WM2RestackWindow       = 1<<5,
        WM2MoveResizeWindow    = 1<<6,
        WM2ExtendedStrut       = 1<<7,
        WM2TakeActivity        = 1<<8,
        WM2KDETemporaryRules   = 1<<9,  // NOT STANDARD
        WM2WindowClass         = 1<<10,
        WM2WindowRole          = 1<<11,
        WM2ClientMachine       = 1<<12,
        WM2ShowingDesktop      = 1<<13,
        WM2Opacity             = 1<<14,
        WM2DesktopLayout       = 1<<15,        
        WM2FullPlacement       = 1<<16,
        WM2FullscreenMonitors  = 1<<17,
        WM2FrameOverlap        = 1<<18,  // NOT STANDARD
        WM2Activities        = 1<<19  // NOT STANDARD @since 4.6
    };

    enum { OnAllDesktops = -1 };
    
    // must match the values for data.l[0] field in _NET_ACTIVE_WINDOW message
    enum RequestSource {
        FromUnknown = 0, // internal
        FromApplication = 1,
        FromTool = 2
    };
    
    enum Orientation {
        OrientationHorizontal = 0,
        OrientationVertical = 1
    };
    
    enum DesktopLayoutCorner {
        DesktopLayoutCornerTopLeft = 0,
        DesktopLayoutCornerTopRight = 1,
        DesktopLayoutCornerBottomLeft = 2,
        DesktopLayoutCornerBottomRight = 3
    };
    
    static int timestampCompare( unsigned long time1, unsigned long time2 );
    static int timestampDiff( unsigned long time1, unsigned long time2 );

};

#endif // netwm_def_h