bd30752410
Deprecate the use of the old untyped constants but don't schedule them from removal in a future wx version by removing "#if WXWIN_COMPATIBILITY_3_0" tests around their definition and use. Provoking deprecation warnings in the code using these constants is worth it as they are unclear and it's easy to make mistakes when using them, but breaking this code compilation outright can't be justified -- even in the future. Also use more informational wxDEPRECATED_MSG() instead of a simple wxDEPRECATED() as it might not be obvious at all how should the code be updated exactly. Finally, avoid the use of deprecated constants inside the library itself. As a side effect, this closes #15814. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@75565 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
159 lines
4.6 KiB
C++
159 lines
4.6 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/pen.h
|
|
// Purpose: Base header for wxPen
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created:
|
|
// Copyright: (c) Julian Smart
|
|
// Licence: wxWindows Licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_PEN_H_BASE_
|
|
#define _WX_PEN_H_BASE_
|
|
|
|
#include "wx/gdiobj.h"
|
|
#include "wx/gdicmn.h"
|
|
|
|
enum wxPenStyle
|
|
{
|
|
wxPENSTYLE_INVALID = -1,
|
|
|
|
wxPENSTYLE_SOLID = wxSOLID,
|
|
wxPENSTYLE_DOT = wxDOT,
|
|
wxPENSTYLE_LONG_DASH = wxLONG_DASH,
|
|
wxPENSTYLE_SHORT_DASH = wxSHORT_DASH,
|
|
wxPENSTYLE_DOT_DASH = wxDOT_DASH,
|
|
wxPENSTYLE_USER_DASH = wxUSER_DASH,
|
|
|
|
wxPENSTYLE_TRANSPARENT = wxTRANSPARENT,
|
|
|
|
wxPENSTYLE_STIPPLE_MASK_OPAQUE = wxSTIPPLE_MASK_OPAQUE,
|
|
wxPENSTYLE_STIPPLE_MASK = wxSTIPPLE_MASK,
|
|
wxPENSTYLE_STIPPLE = wxSTIPPLE,
|
|
|
|
wxPENSTYLE_BDIAGONAL_HATCH = wxHATCHSTYLE_BDIAGONAL,
|
|
wxPENSTYLE_CROSSDIAG_HATCH = wxHATCHSTYLE_CROSSDIAG,
|
|
wxPENSTYLE_FDIAGONAL_HATCH = wxHATCHSTYLE_FDIAGONAL,
|
|
wxPENSTYLE_CROSS_HATCH = wxHATCHSTYLE_CROSS,
|
|
wxPENSTYLE_HORIZONTAL_HATCH = wxHATCHSTYLE_HORIZONTAL,
|
|
wxPENSTYLE_VERTICAL_HATCH = wxHATCHSTYLE_VERTICAL,
|
|
wxPENSTYLE_FIRST_HATCH = wxHATCHSTYLE_FIRST,
|
|
wxPENSTYLE_LAST_HATCH = wxHATCHSTYLE_LAST
|
|
};
|
|
|
|
enum wxPenJoin
|
|
{
|
|
wxJOIN_INVALID = -1,
|
|
|
|
wxJOIN_BEVEL = 120,
|
|
wxJOIN_MITER,
|
|
wxJOIN_ROUND
|
|
};
|
|
|
|
enum wxPenCap
|
|
{
|
|
wxCAP_INVALID = -1,
|
|
|
|
wxCAP_ROUND = 130,
|
|
wxCAP_PROJECTING,
|
|
wxCAP_BUTT
|
|
};
|
|
|
|
|
|
class WXDLLIMPEXP_CORE wxPenBase : public wxGDIObject
|
|
{
|
|
public:
|
|
virtual ~wxPenBase() { }
|
|
|
|
virtual void SetColour(const wxColour& col) = 0;
|
|
virtual void SetColour(unsigned char r, unsigned char g, unsigned char b) = 0;
|
|
|
|
virtual void SetWidth(int width) = 0;
|
|
virtual void SetStyle(wxPenStyle style) = 0;
|
|
virtual void SetStipple(const wxBitmap& stipple) = 0;
|
|
virtual void SetDashes(int nb_dashes, const wxDash *dash) = 0;
|
|
virtual void SetJoin(wxPenJoin join) = 0;
|
|
virtual void SetCap(wxPenCap cap) = 0;
|
|
|
|
virtual wxColour GetColour() const = 0;
|
|
virtual wxBitmap *GetStipple() const = 0;
|
|
virtual wxPenStyle GetStyle() const = 0;
|
|
virtual wxPenJoin GetJoin() const = 0;
|
|
virtual wxPenCap GetCap() const = 0;
|
|
virtual int GetWidth() const = 0;
|
|
virtual int GetDashes(wxDash **ptr) const = 0;
|
|
|
|
// Convenient helpers for testing whether the pen is a transparent one:
|
|
// unlike GetStyle() == wxPENSTYLE_TRANSPARENT, they work correctly even if
|
|
// the pen is invalid (they both return false in this case).
|
|
bool IsTransparent() const
|
|
{
|
|
return IsOk() && GetStyle() == wxPENSTYLE_TRANSPARENT;
|
|
}
|
|
|
|
bool IsNonTransparent() const
|
|
{
|
|
return IsOk() && GetStyle() != wxPENSTYLE_TRANSPARENT;
|
|
}
|
|
};
|
|
|
|
#if defined(__WXMSW__)
|
|
#include "wx/msw/pen.h"
|
|
#elif defined(__WXMOTIF__) || defined(__WXX11__)
|
|
#include "wx/x11/pen.h"
|
|
#elif defined(__WXGTK20__)
|
|
#include "wx/gtk/pen.h"
|
|
#elif defined(__WXGTK__)
|
|
#include "wx/gtk1/pen.h"
|
|
#elif defined(__WXDFB__)
|
|
#include "wx/dfb/pen.h"
|
|
#elif defined(__WXMAC__)
|
|
#include "wx/osx/pen.h"
|
|
#elif defined(__WXCOCOA__)
|
|
#include "wx/cocoa/pen.h"
|
|
#elif defined(__WXPM__)
|
|
#include "wx/os2/pen.h"
|
|
#endif
|
|
|
|
class WXDLLIMPEXP_CORE wxPenList: public wxGDIObjListBase
|
|
{
|
|
public:
|
|
wxPen *FindOrCreatePen(const wxColour& colour,
|
|
int width = 1,
|
|
wxPenStyle style = wxPENSTYLE_SOLID);
|
|
|
|
wxDEPRECATED_MSG("use wxPENSTYLE_XXX constants")
|
|
wxPen *FindOrCreatePen(const wxColour& colour, int width, int style)
|
|
{ return FindOrCreatePen(colour, width, (wxPenStyle)style); }
|
|
};
|
|
|
|
extern WXDLLIMPEXP_DATA_CORE(wxPenList*) wxThePenList;
|
|
|
|
// provide comparison operators to allow code such as
|
|
//
|
|
// if ( pen.GetStyle() == wxTRANSPARENT )
|
|
//
|
|
// to compile without warnings which it would otherwise provoke from some
|
|
// compilers as it compares elements of different enums
|
|
|
|
// Unfortunately some compilers have ambiguity issues when enum comparisons are
|
|
// overloaded so we have to disable the overloads in this case, see
|
|
// wxCOMPILER_NO_OVERLOAD_ON_ENUM definition in wx/platform.h for more details.
|
|
#ifndef wxCOMPILER_NO_OVERLOAD_ON_ENUM
|
|
|
|
wxDEPRECATED_MSG("use wxPENSTYLE_XXX constants")
|
|
inline bool operator==(wxPenStyle s, wxDeprecatedGUIConstants t)
|
|
{
|
|
return static_cast<int>(s) == static_cast<int>(t);
|
|
}
|
|
|
|
wxDEPRECATED_MSG("use wxPENSTYLE_XXX constants")
|
|
inline bool operator!=(wxPenStyle s, wxDeprecatedGUIConstants t)
|
|
{
|
|
return static_cast<int>(s) != static_cast<int>(t);
|
|
}
|
|
|
|
#endif // wxCOMPILER_NO_OVERLOAD_ON_ENUM
|
|
|
|
#endif // _WX_PEN_H_BASE_
|