gal_display_options.h

Go to the documentation of this file.

/*
* This program source code file is part of KICAD, a free EDA CAD application.
*
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
*
* 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
* of the License, 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 General Public License
* along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/
 
#ifndef GAL_DISPLAY_OPTIONS_H__
#define GAL_DISPLAY_OPTIONS_H__
 
#include <gal/gal.h>
#include <dpi_scaling.h>
#include <core/observable.h>
 
class COMMON_SETTINGS;
struct WINDOW_SETTINGS;
class wxString;
class wxWindow;
 
#if defined( _MSC_VER )
#pragma warning( push )
#pragma warning( disable : 4275 )
#endif
 
namespace KIGFX
{
    enum class GRID_STYLE
    {
        DOTS,       
        LINES,      
        SMALL_CROSS 
    };
 
    enum class GAL_ANTIALIASING_MODE
    {
        AA_NONE,
        AA_FAST,
        AA_HIGHQUALITY,
    };
 
    enum class GRID_SNAPPING
    {
        ALWAYS,
        WITH_GRID,
        NEVER
    };
 
    enum class CROSS_HAIR_MODE : int
    {
        SMALL_CROSS,
        FULLSCREEN_CROSS,
        FULLSCREEN_DIAGONAL
    };
 
    class GAL_DISPLAY_OPTIONS;
 
    class GAL_API GAL_DISPLAY_OPTIONS_OBSERVER
    {
    public:
        virtual void OnGalDisplayOptionsChanged( const GAL_DISPLAY_OPTIONS& ) = 0;
 
    protected:
        // Observer lifetimes aren't handled by base class pointer
        virtual ~GAL_DISPLAY_OPTIONS_OBSERVER() {}
    };
 
    class GAL_API GAL_DISPLAY_OPTIONS : public UTIL::OBSERVABLE<GAL_DISPLAY_OPTIONS_OBSERVER>
    {
    public:
        GAL_DISPLAY_OPTIONS();
 
        virtual ~GAL_DISPLAY_OPTIONS()
        {}
 
        GAL_ANTIALIASING_MODE antialiasing_mode;

        KIGFX::GRID_STYLE m_gridStyle;

        GRID_SNAPPING m_gridSnapping;

        double m_gridLineWidth;

        double m_gridMinSpacing;

        bool m_axesEnabled;

        CROSS_HAIR_MODE m_crossHairMode;

        bool m_forceDisplayCursor;

        double m_scaleFactor;
 
        void SetCursorMode( CROSS_HAIR_MODE aMode ) { m_crossHairMode = aMode; }
 
        CROSS_HAIR_MODE GetCursorMode() const { return m_crossHairMode; }
 
        void NotifyChanged();
    };
 
} // namespace KIGFX
 
#if defined( _MSC_VER )
#pragma warning( pop )
#endif
 
#endif