FXListBox.h

/********************************************************************************
*                                                                               *
*                        L i s t   B o x   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 FXLISTBOX_H
#define FXLISTBOX_H

#ifndef FXPACKER_H
#include "FXPacker.h"
#endif

namespace FX {


enum {
  LISTBOX_NORMAL         = 0          // Normal style
  };


class FXButton;
class FXMenuButton;
class FXList;
class FXPopup;


class FXAPI FXListBox : public FXPacker {
  FXDECLARE(FXListBox)
protected:
  FXButton      *field;
  FXMenuButton  *button;
  FXList        *list;
  FXPopup       *pane;
protected:
  FXListBox(){}
private:
  FXListBox(const FXListBox&);
  FXListBox &operator=(const FXListBox&);
public:
  long onFocusUp(FXObject*,FXSelector,void*);
  long onFocusDown(FXObject*,FXSelector,void*);
  long onFocusSelf(FXObject*,FXSelector,void*);
  long onMouseWheel(FXObject*,FXSelector,void*);
  long onFieldButton(FXObject*,FXSelector,void*);
  long onListUpdate(FXObject*,FXSelector,void*);
  long onListClicked(FXObject*,FXSelector,void*);
  long onListChanged(FXObject*,FXSelector,void*);
  long onListCommand(FXObject*,FXSelector,void*);
  long onListForward(FXObject*,FXSelector,void*);
  long onCmdSetValue(FXObject*,FXSelector,void*);
  long onCmdGetIntValue(FXObject*,FXSelector,void*);
  long onCmdSetIntValue(FXObject*,FXSelector,void*);
public:
  enum {
    ID_LIST=FXPacker::ID_LAST,
    ID_FIELD,
    ID_LAST
    };
public:

  FXListBox(FXComposite *p,FXObject* tgt=nullptr,FXSelector sel=0,FXuint opts=FRAME_SUNKEN|FRAME_THICK|LISTBOX_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 destroy();

  virtual void layout();

  virtual void enable();

  virtual void disable();

  virtual FXint getDefaultWidth();

  virtual FXint getDefaultHeight();

  FXint getNumItems() const;

  FXint getNumVisible() const;

  void setNumVisible(FXint nvis);

  FXbool isItemCurrent(FXint index) const;

  virtual void setCurrentItem(FXint index,FXbool notify=false);

  FXint getCurrentItem() const;

  FXString getItem(FXint index) const;

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

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

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

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

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

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

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

  FXint moveItem(FXint newindex,FXint oldindex,FXbool notify=false);

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

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

  void clearItems(FXbool notify=false);

  FXint findItem(const FXString& string,FXint start=-1,FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const;

  FXint findItemByData(FXptr ptr,FXint start=-1,FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const;

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

  FXString getItemText(FXint index) const;

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

  FXIcon* getItemIcon(FXint index) const;

  void setItemData(FXint index,FXptr ptr) const;

  FXptr getItemData(FXint index) const;

  FXbool isItemEnabled(FXint index) const;

  FXbool enableItem(FXint index);

  FXbool disableItem(FXint index);

  void showMenu(FXbool shw);

  FXbool isMenuShown() const;

  void sortItems();

  void setFont(FXFont* fnt);

  FXFont* getFont() const;

  void setShrinkWrap(FXbool flag);

  FXbool getShrinkWrap() const;

  virtual void setBackColor(FXColor clr);

  FXColor getBackColor() const;

  void setTextColor(FXColor clr);

  FXColor getTextColor() const;

  void setSelBackColor(FXColor clr);

  FXColor getSelBackColor() const;

  void setSelTextColor(FXColor clr);

  FXColor getSelTextColor() const;

  FXListSortFunc getSortFunc() const;

  void setSortFunc(FXListSortFunc func);

  void setHelpText(const FXString& txt);

  const FXString& getHelpText() const;

  void setTipText(const FXString& txt);

  const FXString& getTipText() const;

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXListBox();
  };

}

#endif