plasma.h

Go to the documentation of this file.

/*
 *   Copyright 2005 by Aaron Seigo <aseigo@kde.org>
 *
 *   This program 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, or
 *   (at your option) any later version.
 *
 *   This program 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 General Public License for more details
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef PLASMA_DEFS_H
#define PLASMA_DEFS_H

#include <QtGui/QGraphicsItem>
#include <QtGui/QPainterPath>

#include <plasma/plasma_export.h>

class QAction;
class QGraphicsView;

namespace Plasma
{

enum Constraint {
    NoConstraint = 0, 
    FormFactorConstraint = 1, 
    LocationConstraint = 2, 
    ScreenConstraint = 4, 
    SizeConstraint = 8, 
    ImmutableConstraint = 16, 
    StartupCompletedConstraint = 32, 
    ContextConstraint = 64, 
    PopupConstraint = 128, 
    AllConstraints = FormFactorConstraint | LocationConstraint | ScreenConstraint |
    SizeConstraint | ImmutableConstraint | ContextConstraint | PopupConstraint
};
Q_DECLARE_FLAGS(Constraints, Constraint)


enum FormFactor {
    Planar = 0,  
    MediaCenter, 
    Horizontal,  
    Vertical,     
    Application 
};

enum Direction {
    Down = 0, 
    Up,       
    Left,     
    Right     
};

enum ZoomDirection {
    ZoomIn = 0, 
    ZoomOut = 1 
};

enum Location {
    Floating = 0, 
    Desktop,      
    FullScreen,   
    TopEdge,      
    BottomEdge,   
    LeftEdge,     
    RightEdge     
};

enum Position {
    LeftPositioned,    
    RightPositioned,   
    TopPositioned,     
    BottomPositioned,  
    CenterPositioned   
};

enum PopupPlacement {
    FloatingPopup = 0,            
    TopPosedLeftAlignedPopup,     
    TopPosedRightAlignedPopup,    
    LeftPosedTopAlignedPopup,     
    LeftPosedBottomAlignedPopup,  
    BottomPosedLeftAlignedPopup,  
    BottomPosedRightAlignedPopup, 
    RightPosedTopAlignedPopup,    
    RightPosedBottomAlignedPopup  
};

enum FlipDirection {
    NoFlip = 0,          
    HorizontalFlip = 1,  
    VerticalFlip = 2     
};
Q_DECLARE_FLAGS(Flip, FlipDirection)


enum ZoomLevel {
    DesktopZoom = 0, 
    GroupZoom,       
    OverviewZoom     
};

enum IntervalAlignment {
    NoAlignment = 0, 
    AlignToMinute, 
    AlignToHour 
};

enum ItemTypes {
    AppletType = QGraphicsItem::UserType + 1,
    LineEditType = QGraphicsItem::UserType + 2
};

enum ImmutabilityType {
    Mutable = 1,        
    UserImmutable = 2,  
    SystemImmutable = 4 
};

enum AspectRatioMode {
    InvalidAspectRatioMode = -1, 
    IgnoreAspectRatio = 0,       
    KeepAspectRatio = 1,         
    Square = 2,                  
    ConstrainedSquare = 3,       
    FixedSize = 4                
};

enum ComponentType {
    AppletComponent = 1,      
    DataEngineComponent = 2,  
    RunnerComponent = 4,      
    AnimatorComponent = 8,    
    ContainmentComponent = 16,
    WallpaperComponent = 32,   
    GenericComponent = 64      
};
Q_DECLARE_FLAGS(ComponentTypes, ComponentType)

enum MarginEdge {
    TopMargin = 0, 
    BottomMargin, 
    LeftMargin, 
    RightMargin 
};

enum MessageButton {
    ButtonNone = 0, 
    ButtonOk = 1, 
    ButtonYes = 2, 
    ButtonNo = 4, 
    ButtonCancel = 8 
};
Q_DECLARE_FLAGS(MessageButtons, MessageButton)


enum ItemStatus {
    UnknownStatus = 0, 
    PassiveStatus = 1, 
    ActiveStatus = 2, 
    NeedsAttentionStatus = 3, 
    AcceptingInputStatus = 4 
};
Q_ENUMS(ItemStatus)

enum AnnouncementMethod {
    NoAnnouncement = 0, 
    ZeroconfAnnouncement = 1 
};
Q_DECLARE_FLAGS(AnnouncementMethods, AnnouncementMethod)

enum TrustLevel {
    InvalidCredentials = 0, 
    UnknownCredentials = 1, 
    ValidCredentials = 2, 
    TrustedCredentials = 3, 
    UltimateCredentials = 4 
};
Q_ENUMS(TrustLevel)


PLASMA_EXPORT qreal scalingFactor(ZoomLevel level);

PLASMA_EXPORT Direction locationToDirection(Location location);

PLASMA_EXPORT Direction locationToInverseDirection(Location location);

PLASMA_EXPORT QGraphicsView *viewFor(const QGraphicsItem *item);

PLASMA_EXPORT QList<QAction*> actionsFromMenu(QMenu *menu,
                                              const QString &prefix = QString(),
                                              QObject *parent = 0);

} // Plasma namespace

Q_DECLARE_OPERATORS_FOR_FLAGS(Plasma::Constraints)
Q_DECLARE_OPERATORS_FOR_FLAGS(Plasma::Flip)
Q_DECLARE_OPERATORS_FOR_FLAGS(Plasma::ComponentTypes)
Q_DECLARE_OPERATORS_FOR_FLAGS(Plasma::MessageButtons)


#endif // multiple inclusion guard