include/wx/headercol.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/headercol.h
   3 // Purpose:     declaration of wxHeaderColumn class
   4 // Author:      Vadim Zeitlin
   5 // Created:     2008-12-02
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2008 Vadim Zeitlin <vadim@wxwidgets.org>
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_HEADERCOL_H_
  12 #define _WX_HEADERCOL_H_
  13
  14 #include "wx/bitmap.h"
  15
  16 // ----------------------------------------------------------------------------
  17 // constants
  18 // ----------------------------------------------------------------------------
  19
  20 enum
  21 {
  22     // special value for column width meaning unspecified/default
  23     wxCOL_WIDTH_DEFAULT = -1
  24 };
  25
  26 // bit masks for the various column attributes
  27 enum
  28 {
  29     // column can be resized (included in default flags)
  30     wxCOL_RESIZABLE   = 1,
  31
  32     // column can be clicked to toggle the sort order by its contents
  33     wxCOL_SORTABLE    = 2,
  34
  35     // column can be dragged to change its order (included in default)
  36     wxCOL_REORDERABLE = 4,
  37
  38     // column is not shown at all
  39     wxCOL_HIDDEN      = 8,
  40
  41     // default flags for wxHeaderColumn ctor
  42     wxCOL_DEFAULT_FLAGS = wxCOL_RESIZABLE | wxCOL_REORDERABLE
  43 };
  44
  45 // ----------------------------------------------------------------------------
  46 // wxHeaderColumnBase: interface for a column in a header of controls such as
  47 //                     wxListCtrl, wxDataViewCtrl or wxGrid
  48 // ----------------------------------------------------------------------------
  49
  50 class WXDLLIMPEXP_CORE wxHeaderColumnBase : public wxObject
  51 {
  52 public:
  53     // ctors and dtor
  54     // --------------
  55
  56     /*
  57        Derived classes must provide ctors with the following signatures
  58        (notice that they shouldn't be explicit to allow passing strings/bitmaps
  59        directly to methods such wxHeaderCtrl::AppendColumn()):
  60     wxHeaderColumn(const wxString& title,
  61                    int width = wxCOL_WIDTH_DEFAULT,
  62                    wxAlignment align = wxALIGN_NOT,
  63                    int flags = wxCOL_DEFAULT_FLAGS);
  64     wxHeaderColumn(const wxBitmap &bitmap,
  65                    int width = wxDVC_DEFAULT_WIDTH,
  66                    wxAlignment align = wxALIGN_CENTER,
  67                    int flags = wxCOL_DEFAULT_FLAGS);
  68     */
  69
  70
  71     // setters and getters for various attributes
  72     // ------------------------------------------
  73
  74     // title is the string shown for this column
  75     virtual void SetTitle(const wxString& title) = 0;
  76     virtual wxString GetTitle() const = 0;
  77
  78     // bitmap shown (instead of text) in the column header
  79     virtual void SetBitmap(const wxBitmap& bitmap) = 0;
  80     virtual wxBitmap GetBitmap() const = 0;                                   \
  81
  82     // width of the column in pixels, can be set to wxCOL_WIDTH_DEFAULT meaning
  83     // unspecified/default
  84     virtual void SetWidth(int width) = 0;
  85     virtual int GetWidth() const = 0;
  86
  87     // minimal width can be set for resizeable columns to forbid resizing them
  88     // below the specified size (set to 0 to remove)
  89     virtual void SetMinWidth(int minWidth) = 0;
  90     virtual int GetMinWidth() const = 0;
  91
  92     // alignment of the text: wxALIGN_CENTRE, wxALIGN_LEFT or wxALIGN_RIGHT
  93     virtual void SetAlignment(wxAlignment align) = 0;
  94     virtual wxAlignment GetAlignment() const = 0;
  95
  96     // arbitrary client data associated with the column (currently only
  97     // implemented in MSW because it is used in MSW wxDataViewCtrl
  98     // implementation)
  99     virtual void SetClientData(wxUIntPtr WXUNUSED(data))
 100         { wxFAIL_MSG("not implemented"); }
 101     virtual wxUIntPtr GetClientData() const
 102         { return 0; }
 103
 104
 105     // flags manipulations:
 106     // --------------------
 107
 108     // notice that while we make Set/GetFlags() pure virtual here and implement
 109     // the individual flags access in terms of them, for some derived classes
 110     // it is more natural to implement access to each flag individually, in
 111     // which case they can use SetIndividualFlags() and GetFromIndividualFlags()
 112     // below to implement Set/GetFlags()
 113
 114     // set or retrieve all column flags at once: combination of wxCOL_XXX
 115     // values above
 116     virtual void SetFlags(int flags) = 0;
 117     virtual int GetFlags() const = 0;
 118
 119     // change, set, clear, toggle or test for any individual flag
 120     void ChangeFlag(int flag, bool set);
 121     void SetFlag(int flag);
 122     void ClearFlag(int flag);
 123     void ToggleFlag(int flag);
 124
 125     bool HasFlag(int flag) const { return (GetFlags() & flag) != 0; }
 126
 127
 128     // wxCOL_RESIZABLE
 129     virtual void SetResizeable(bool resizeable)
 130         { ChangeFlag(wxCOL_RESIZABLE, resizeable); }
 131     virtual bool IsResizeable() const
 132         { return HasFlag(wxCOL_RESIZABLE); }
 133
 134     // wxCOL_SORTABLE
 135     virtual void SetSortable(bool sortable)
 136         { ChangeFlag(wxCOL_SORTABLE, sortable); }
 137     virtual bool IsSortable() const
 138         { return HasFlag(wxCOL_SORTABLE); }
 139
 140     // wxCOL_REORDERABLE
 141     virtual void SetReorderable(bool reorderable)
 142         { ChangeFlag(wxCOL_REORDERABLE, reorderable); }
 143     virtual bool IsReorderable() const
 144         { return HasFlag(wxCOL_REORDERABLE); }
 145
 146     // wxCOL_HIDDEN
 147     virtual void SetHidden(bool hidden)
 148         { ChangeFlag(wxCOL_HIDDEN, hidden); }
 149     virtual bool IsHidden() const
 150         { return HasFlag(wxCOL_HIDDEN); }
 151     bool IsShown() const
 152         { return !IsHidden(); }
 153
 154     // for sortable columns indicate whether we should sort in ascending or
 155     // descending order
 156     virtual void SetSortOrder(bool ascending) = 0;
 157     void ToggleSortOrder() { SetSortOrder(!IsSortOrderAscending()); }
 158     virtual bool IsSortOrderAscending() const = 0;
 159
 160 protected:
 161     // helpers for the class overriding Set/IsXXX()
 162     void SetIndividualFlags(int flags);
 163     int GetFromIndividualFlags() const;
 164 };
 165
 166 #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
 167     #include "wx/msw/headercol.h"
 168 #elif 0 // TODO
 169     #define wxHAS_GENERIC_HEADERCOL
 170     #include "wx/generic/headercolg.h"
 171 #endif
 172
 173 #endif // _WX_HEADERCOL_H_
 174