drc_re_overlay_types.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2024 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 DRC_RE_OVERLAY_TYPES_H
#define DRC_RE_OVERLAY_TYPES_H
 
#include <wx/string.h>
 
// GTK renders native controls with slightly different baseline/padding than macOS Cocoa.
// These offsets shift all overlay field positions to compensate.
#ifdef __WXGTK__
constexpr int DRC_RE_OVERLAY_XO = -3;
constexpr int DRC_RE_OVERLAY_YO = -5;
#else
constexpr int DRC_RE_OVERLAY_XO = 0;
constexpr int DRC_RE_OVERLAY_YO = 0;
#endif
 
// Windows text controls have more internal border padding than GTK/macOS, so numeric
// fields need extra width to display 4-decimal values without clipping.
#ifdef __WXMSW__
constexpr int DRC_RE_OVERLAY_WE = 15;
#else
constexpr int DRC_RE_OVERLAY_WE = 0;
#endif
 

enum class LABEL_POSITION
{
    NONE,       
    LEFT,       
    RIGHT,      
    TOP,        
    BOTTOM      
};
 

struct DRC_RE_FIELD_POSITION
{
    int xStart;     
    int xEnd;       
    int yTop;       
    int tabOrder;   
 
    wxString       labelText;      
    LABEL_POSITION labelPosition;  
 
    DRC_RE_FIELD_POSITION() :
            xStart( 0 ),
            xEnd( 0 ),
            yTop( 0 ),
            tabOrder( 0 ),
            labelText(),
            labelPosition( LABEL_POSITION::NONE )
    {
    }
 
    DRC_RE_FIELD_POSITION( int aXStart, int aXEnd, int aYTop, int aTabOrder,
                           const wxString& aLabelText = wxEmptyString,
                           LABEL_POSITION aLabelPos = LABEL_POSITION::NONE ) :
            xStart( aXStart ),
            xEnd( aXEnd ),
            yTop( aYTop ),
            tabOrder( aTabOrder ),
            labelText( aLabelText ),
            labelPosition( aLabelPos )
    {
    }
};
 
#endif // DRC_RE_OVERLAY_TYPES_H