FXComboBox.h

/********************************************************************************
*                                                                               *
*                       C o m b o   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 FXCOMBOBOX_H
#define FXCOMBOBOX_H

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

namespace FX {


enum {
  COMBOBOX_NO_REPLACE     = 0,                  
  COMBOBOX_REPLACE        = 0x00020000,         
  COMBOBOX_INSERT_BEFORE  = 0x00040000,         
  COMBOBOX_INSERT_AFTER   = 0x00060000,         
  COMBOBOX_INSERT_FIRST   = 0x00080000,         
  COMBOBOX_INSERT_LAST    = 0x000A0000,         
  COMBOBOX_STATIC         = 0x00100000,         
  COMBOBOX_NORMAL         = 0                   
  };


class FXTextField;
class FXMenuButton;
class FXList;
class FXPopup;


class FXAPI FXComboBox : public FXPacker {
  FXDECLARE(FXComboBox)
protected:
  FXTextField   *field;
  FXMenuButton  *button;
  FXList        *list;
  FXPopup       *pane;
protected:
  FXComboBox(){}
private:
  FXComboBox(const FXComboBox&);
  FXComboBox &operator=(const FXComboBox&);
public:
  long onFocusUp(FXObject*,FXSelector,void*);
  long onFocusDown(FXObject*,FXSelector,void*);
  long onFocusSelf(FXObject*,FXSelector,void*);
  long onMouseWheel(FXObject*,FXSelector,void*);
  long onTextButton(FXObject*,FXSelector,void*);
  long onTextChanged(FXObject*,FXSelector,void*);
  long onTextCommand(FXObject*,FXSelector,void*);
  long onListClicked(FXObject*,FXSelector,void*);
  long onListCommand(FXObject*,FXSelector,void*);
  long onFwdToText(FXObject*,FXSelector,void*);
  long onUpdFmText(FXObject*,FXSelector,void*);
public:
  enum {
    ID_LIST=FXPacker::ID_LAST,
    ID_TEXT,
    ID_LAST
    };
public:

  FXComboBox(FXComposite *p,FXint cols,FXObject* tgt=nullptr,FXSelector sel=0,FXuint opts=COMBOBOX_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 enable();

  virtual void disable();

  virtual FXint getDefaultWidth();

  virtual FXint getDefaultHeight();

  virtual void layout();

  FXbool isEditable() const;

  void setEditable(FXbool edit=true);

  void setText(const FXString& text,FXbool notify=false);

  FXString getText() const;

  void setNumColumns(FXint cols);

  FXint getNumColumns() const;

  void setJustify(FXuint mode);

  FXuint getJustify() const;

  FXint getNumItems() const;

  FXint getNumVisible() const;

  void setNumVisible(FXint nvis);

  FXbool isItemCurrent(FXint index) const;

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

  FXint getCurrentItem() const;

  FXString getItem(FXint index) const;

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

  FXint fillItems(const FXchar *const *strings,FXbool notify=false);

  FXint fillItems(const FXString* strings,FXbool notify=false);

  FXint fillItems(const FXString& strings,FXbool notify=false);

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

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

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

  FXint moveItem(FXint newindex,FXint oldindex,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 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 setComboStyle(FXuint mode);

  FXuint getComboStyle() 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 ~FXComboBox();
  };

}

#endif