digikam_globals.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-09-08
 * Description : global macros, variables and flags
 *
 * Copyright (C) 2009-2010 by Andi Clemens <andi dot clemens at gmail dot com>
 * Copyright (C) 2009-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU 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.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_GLOBALS_H
#define DIGIKAM_GLOBALS_H
 
// Qt includes
 
#include <QStringList>
#include <QDateTime>
#include <QIODevice>
#include <QProcessEnvironment>
 
// Local includes
 
#include "digikam_export.h"
 
class QWidget;
class QObject;
class QShortcut;
class QKeySequence;
class QApplication;
class QDate;
 
#define CLAMP0255(a)   qBound(0,a,255)
#define CLAMP065535(a) qBound(0,a,65535)
#define CLAMP(x,l,u)   qBound(l,x,u)
#define MAX3(a, b, c)  (qMax(qMax(a,b),c))
#define MIN3(a, b, c)  (qMin(qMin(a,b),c))
 
#define DEG2RAD 0.017453292519943
 
#define QT_ENDL Qt::endl
 
#define QT_KEEP_EMPTY_PARTS Qt::KeepEmptyParts
#define QT_SKIP_EMPTY_PARTS Qt::SkipEmptyParts
 
namespace Digikam
{
 
static const int RatingMin          = 0;
static const int RatingMax          = 5;
static const int NoRating           = -1;
 
// --------------------------------------------------------
 
static const int NUM_SEGMENTS_16BIT = 65536;
static const int NUM_SEGMENTS_8BIT  = 256;
static const int MAX_SEGMENT_16BIT  = NUM_SEGMENTS_16BIT - 1;
static const int MAX_SEGMENT_8BIT   = NUM_SEGMENTS_8BIT  - 1;
 
// --------------------------------------------------------
 
static const int AUTOEXPANDDELAY    = 800;
 
// --------------------------------------------------------
 
enum ColorLabel
{
    NoColorLabel        = 0,
    RedLabel,
    OrangeLabel,
    YellowLabel,
    GreenLabel,
    BlueLabel,
    MagentaLabel,
    GrayLabel,
    BlackLabel,
    WhiteLabel,
    FirstColorLabel     = NoColorLabel,
    LastColorLabel      = WhiteLabel,
    NumberOfColorLabels = LastColorLabel + 1
};
 
// --------------------------------------------------------
 
enum PickLabel
{
    NoPickLabel        = 0,
    RejectedLabel,
    PendingLabel,
    AcceptedLabel,
    FirstPickLabel     = NoPickLabel,
    LastPickLabel      = AcceptedLabel,
    NumberOfPickLabels = LastPickLabel + 1
};
 
// --------------------------------------------------------
 
enum HistogramBoxType
{
    RGB = 0,
    RGBA,
    LRGB,
    LRGBA,
    LRGBC,
    LRGBAC
};
 
enum HistogramScale
{
    LinScaleHistogram = 0,      
    LogScaleHistogram           
};
 
enum HistogramRenderingType
{
    FullImageHistogram = 0,     
    ImageSelectionHistogram     
};
 
// --------------------------------------------------------
 
enum ChannelType
{
    LuminosityChannel = 0,
    RedChannel,
    GreenChannel,
    BlueChannel,
    AlphaChannel,
    ColorChannels
};
 
// --------------------------------------------------------
 
DIGIKAM_EXPORT QShortcut* defineShortcut(QWidget* const w, const QKeySequence& key, const QObject* receiver, const char* slot);
 
DIGIKAM_EXPORT QStringList supportedImageMimeTypes(QIODevice::OpenModeFlag mode, QString& allTypes);
 
DIGIKAM_EXPORT bool isReadableImageFile(const QString& filePath);
 
DIGIKAM_EXPORT void showRawCameraList();
 
DIGIKAM_EXPORT QString toolButtonStyleSheet();
 
// --- Static functions for the bundles ---
 
DIGIKAM_EXPORT bool isRunningInAppImageBundle();
 
DIGIKAM_EXPORT QProcessEnvironment adjustedEnvironmentForAppImage();
 
DIGIKAM_EXPORT void tryInitDrMingw();
 
DIGIKAM_EXPORT QString macOSBundlePrefix();
 
DIGIKAM_EXPORT void unloadQtTranslationFiles(QApplication& app);
 
DIGIKAM_EXPORT void loadStdQtTranslationFiles(QApplication& app);
 
DIGIKAM_EXPORT void loadEcmQtTranslationFiles(QApplication& app);
 
DIGIKAM_EXPORT void installQtTranslationFiles(QApplication& app);
 
DIGIKAM_EXPORT QDateTime startOfDay(const QDate&);
 
} // namespace Digikam
 
#endif // DIGIKAM_GLOBALS_H