FXHeader.h

/********************************************************************************
*                                                                               *
*                          H e a d e r   W i d g e t                            *
*                                                                               *
*********************************************************************************
* Copyright (C) 1997,2024 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* This library is free software; you can redistribute it and/or modify          *
* it under the terms of the GNU Lesser General Public License as published by   *
* the Free Software Foundation; either version 3 of the License, or             *
* (at your option) any later version.                                           *
*                                                                               *
* This library 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 Lesser General Public License for more details.                           *
*                                                                               *
* You should have received a copy of the GNU Lesser General Public License      *
* along with this program.  If not, see <http://www.gnu.org/licenses/>          *
********************************************************************************/
#ifndef FXHEADER_H
#define FXHEADER_H

#ifndef FXFRAME_H
#include "FXFrame.h"
#endif

namespace FX {

class FXIcon;
class FXFont;
class FXHeader;


enum {
  HEADER_BUTTON     = 0x00008000,     
  HEADER_HORIZONTAL = 0,              
  HEADER_VERTICAL   = 0x00010000,     
  HEADER_TRACKING   = 0x00020000,     
  HEADER_RESIZE     = 0x00040000,     
  HEADER_NORMAL     = HEADER_HORIZONTAL|FRAME_NORMAL
  };


class FXAPI FXHeaderItem : public FXObject {
  FXDECLARE(FXHeaderItem)
  friend class FXHeader;
protected:
  FXString  label;      // Text of item
  FXString  tip;        // Tooltip of item
  FXIcon   *icon;       // Icon of item
  void     *data;       // User data pointer
  FXint     size;       // Item size
  FXint     pos;        // Item position
  FXuint    state;      // State flags
private:
  FXHeaderItem(const FXHeaderItem&);
  FXHeaderItem& operator=(const FXHeaderItem&);
protected:
  FXHeaderItem(){}
  virtual void draw(const FXHeader* header,FXDC& dc,FXint x,FXint y,FXint w,FXint h) const;
public:
  enum{
    ARROW_NONE = 0,             
    ARROW_UP   = 0x00000001,    
    ARROW_DOWN = 0x00000002,    
    PRESSED    = 0x00000004,    
    ICONOWNED  = 0x00000008,    
    RIGHT      = 0x00000010,    
    LEFT       = 0x00000020,    
    CENTER_X   = 0,             
    TOP        = 0x00000040,    
    BOTTOM     = 0x00000080,    
    CENTER_Y   = 0,             
    BEFORE     = 0x00000100,    
    AFTER      = 0x00000200,    
    ABOVE      = 0x00000400,    
    BELOW      = 0x00000800     
    };
public:

  FXHeaderItem(const FXString& text,FXIcon* ic=nullptr,FXint s=0,void* ptr=nullptr);

  virtual void setText(const FXString& txt);

  const FXString& getText() const { return label; }

  void setTipText(const FXString& text){ tip=text; }

  const FXString& getTipText() const { return tip; }

  virtual void setIcon(FXIcon* icn,FXbool owned=false);

  FXIcon* getIcon() const { return icon; }

  void setData(void* ptr){ data=ptr; }

  void* getData() const { return data; }

  void setSize(FXint s){ size=s; }

  FXint getSize() const { return size; }

  void setPos(FXint p){ pos=p; }

  FXint getPos() const { return pos; }

  void setArrowDir(FXuint dir=ARROW_NONE);

  FXuint getArrowDir() const;

  void setJustify(FXuint justify=LEFT|CENTER_Y);

  FXuint getJustify() const;

  void setIconPosition(FXuint mode=BEFORE);

  FXuint getIconPosition() const;

  void setPressed(FXbool pressed);

  FXbool isPressed() const;

  virtual FXint getWidth(const FXHeader* header) const;

  virtual FXint getHeight(const FXHeader* header) const;

  virtual void create();

  virtual void detach();

  virtual void destroy();

  virtual void save(FXStream& store) const;
  virtual void load(FXStream& store);

  virtual ~FXHeaderItem();
  };


typedef FXString (*FXNumberingFunc)(FXint);


typedef FXObjectListOf<FXHeaderItem> FXHeaderItemList;


class FXAPI FXHeader : public FXFrame {
  FXDECLARE(FXHeader)
protected:
  FXHeaderItemList items; // Item list
  FXFont          *font;  // Text font
  FXNumberingFunc  numbering;   // Automatic caption renumbering method
  FXString         help;  // Help text
  FXColor          textColor; // Text color
  FXint            pos;   // Scroll position
  FXint            active;  // Active button
  FXint            activepos; // Position of active item
  FXint            activesize;  // Size of active item
  FXint            offset;  // Offset where split grabbed
protected:
  FXHeader();
  void drawSplit(FXint pos);
  virtual FXHeaderItem *createItem(const FXString& text,FXIcon* icon,FXint size,void* ptr);
private:
  FXHeader(const FXHeader&);
  FXHeader &operator=(const FXHeader&);
public:
  long onPaint(FXObject*,FXSelector,void*);
  long onLeftBtnPress(FXObject*,FXSelector,void*);
  long onLeftBtnRelease(FXObject*,FXSelector,void*);
  long onUngrabbed(FXObject*,FXSelector,void*);
  long onMotion(FXObject*,FXSelector,void*);
  long onTipTimer(FXObject*,FXSelector,void*);
  long onQueryTip(FXObject*,FXSelector,void*);
  long onQueryHelp(FXObject*,FXSelector,void*);
public:

  static FXString decimalNumbering(FXint index);

  static FXString alphaNumbering(FXint index);
public:

  FXHeader(FXComposite* p,FXObject* tgt=nullptr,FXSelector sel=0,FXuint opts=HEADER_NORMAL,FXint x=0,FXint y=0,FXint w=0,FXint h=0,FXint pl=DEFAULT_PAD,FXint pr=DEFAULT_PAD,FXint pt=DEFAULT_PAD,FXint pb=DEFAULT_PAD);

  virtual void create();

  virtual void detach();

  virtual void layout();

  FXint getNumItems() const { return (FXint)items.no(); }

  FXint getTotalSize() const;

  virtual FXint getDefaultWidth();

  virtual FXint getDefaultHeight();

  void setPosition(FXint pos);

  FXint getPosition() const { return pos; }

  FXint getItemAt(FXint coord) const;

  FXHeaderItem *getItem(FXint index) const;

  FXint setItem(FXint index,FXHeaderItem* item,FXbool notify=false);

  FXint setItem(FXint index,const FXString& text,FXIcon *icon=nullptr,FXint size=0,void* ptr=nullptr,FXbool notify=false);

  FXint fillItems(const FXchar *const *strings,FXIcon *icon=nullptr,FXint size=0,void* ptr=nullptr,FXbool notify=false);

  FXint fillItems(const FXString* strings,FXIcon *icon=nullptr,FXint size=0,void* ptr=nullptr,FXbool notify=false);

  FXint fillItems(const FXString& strings,FXIcon *icon=nullptr,FXint size=0,void* ptr=nullptr,FXbool notify=false);

  FXint insertItem(FXint index,FXHeaderItem* item,FXbool notify=false);

  FXint insertItem(FXint index,const FXString& text,FXIcon *icon=nullptr,FXint size=0,void* ptr=nullptr,FXbool notify=false);

  FXint appendItem(FXHeaderItem* item,FXbool notify=false);

  FXint appendItem(const FXString& text,FXIcon *icon=nullptr,FXint size=0,void* ptr=nullptr,FXbool notify=false);

  FXint prependItem(FXHeaderItem* item,FXbool notify=false);

  FXint prependItem(const FXString& text,FXIcon *icon=nullptr,FXint size=0,void* ptr=nullptr,FXbool notify=false);

  FXHeaderItem* extractItem(FXint index,FXbool notify=false);

  void removeItem(FXint index,FXbool notify=false);

  void clearItems(FXbool notify=false);

  void setItemText(FXint index,const FXString& text);

  FXString getItemText(FXint index) const;

  void setItemTipText(FXint index,const FXString& text);

  FXString getItemTipText(FXint index) const;

  void setItemIcon(FXint index,FXIcon* icon,FXbool owned=false);

  FXIcon* getItemIcon(FXint index) const;

  void setItemSize(FXint index,FXint size);

  FXint getItemSize(FXint index) const;

  FXint getItemOffset(FXint index) const;

  void setItemData(FXint index,void* ptr);

  void* getItemData(FXint index) const;

  void setArrowDir(FXint index,FXuint dir=FXHeaderItem::ARROW_NONE);

  FXuint getArrowDir(FXint index) const;

  void setItemJustify(FXint index,FXuint justify);

  FXuint getItemJustify(FXint index) const;

  void setItemIconPosition(FXint index,FXuint mode);

  FXuint getItemIconPosition(FXint index) const;

  void setItemPressed(FXint index,FXbool pressed=true);

  FXbool isItemPressed(FXint index) const;

  void makeItemVisible(FXint index);

  void updateItem(FXint index) const;

  void setFont(FXFont* fnt);

  FXFont* getFont() const { return font; }

  void renumberCaptions(FXNumberingFunc func,FXint fm=0,FXint to=2147483647);

  void setAutoNumbering(FXNumberingFunc func);

  FXNumberingFunc getAutoNumbering() const { return numbering; }

  void setTextColor(FXColor clr);

  FXColor getTextColor() const { return textColor; }

  void setHeaderStyle(FXuint style);

  FXuint getHeaderStyle() const;

  void setHelpText(const FXString& text){ help=text; }

  const FXString& getHelpText() const { return help; }

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXHeader();
  };

}

#endif