FXTreeListBox.h

Go to the documentation of this file.

/********************************************************************************
*                                                                               *
*                      T r e e   L i s t   B o x   W i d g e t                  *
*                                                                               *
*********************************************************************************
* Copyright (C) 1999,2006 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 2.1 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 library; if not, write to the Free Software           *
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.    *
*********************************************************************************
* $Id: FXTreeListBox.h,v 1.41 2006/01/22 17:58:11 fox Exp $                     *
********************************************************************************/
#ifndef FXTREELISTBOX_H
#define FXTREELISTBOX_H

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

namespace FX {


enum {
  TREELISTBOX_NORMAL         = 0          
  };


class FXButton;
class FXMenuButton;
class FXTreeList;
class FXPopup;


class FXAPI FXTreeListBox : public FXPacker {
  FXDECLARE(FXTreeListBox)
protected:
  FXButton      *field;
  FXMenuButton  *button;
  FXTreeList    *tree;
  FXPopup       *pane;
protected:
  FXTreeListBox(){}
private:
  FXTreeListBox(const FXTreeListBox&);
  FXTreeListBox& operator=(const FXTreeListBox&);
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 onTreeUpdate(FXObject*,FXSelector,void*);
  long onTreeChanged(FXObject*,FXSelector,void*);
  long onTreeClicked(FXObject*,FXSelector,void*);
public:
  enum{
    ID_TREE=FXPacker::ID_LAST,
    ID_FIELD,
    ID_LAST
    };
public:

  FXTreeListBox(FXComposite *p,FXObject* tgt=NULL,FXSelector sel=0,FXuint opts=FRAME_SUNKEN|FRAME_THICK|TREELISTBOX_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);

  FXTreeItem* getFirstItem() const;

  FXTreeItem* getLastItem() const;

  FXint fillItems(FXTreeItem* father,const FXchar** strings,FXIcon* oi=NULL,FXIcon* ci=NULL,void* ptr=NULL);

  FXint fillItems(FXTreeItem* father,const FXString& strings,FXIcon* oi=NULL,FXIcon* ci=NULL,void* ptr=NULL);

  FXTreeItem* insertItem(FXTreeItem* other,FXTreeItem* father,FXTreeItem* item);

  FXTreeItem* insertItem(FXTreeItem* other,FXTreeItem* father,const FXString& text,FXIcon* oi=NULL,FXIcon* ci=NULL,void* ptr=NULL);

  FXTreeItem* appendItem(FXTreeItem* father,FXTreeItem* item);

  FXTreeItem* appendItem(FXTreeItem* father,const FXString& text,FXIcon* oi=NULL,FXIcon* ci=NULL,void* ptr=NULL);

  FXTreeItem* prependItem(FXTreeItem* father,FXTreeItem* item);

  FXTreeItem* prependItem(FXTreeItem* father,const FXString& text,FXIcon* oi=NULL,FXIcon* ci=NULL,void* ptr=NULL);

  FXTreeItem *moveItem(FXTreeItem* other,FXTreeItem* father,FXTreeItem* item);

  FXTreeItem* extractItem(FXTreeItem* item);

  void removeItem(FXTreeItem* item);

  void removeItems(FXTreeItem* fm,FXTreeItem* to);

  void clearItems();

  FXTreeItem* findItem(const FXString& text,FXTreeItem* start=NULL,FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const;

  FXTreeItem* findItemByData(const void *ptr,FXTreeItem* start=NULL,FXuint flags=SEARCH_FORWARD|SEARCH_WRAP) const;

  FXbool isItemCurrent(const FXTreeItem* item) const;

  FXbool isItemLeaf(const FXTreeItem* item) const;

  void sortRootItems();

  void sortItems();

  void sortChildItems(FXTreeItem* item);

  virtual void setCurrentItem(FXTreeItem* item,FXbool notify=FALSE);

  FXTreeItem* getCurrentItem() const;

  void setItemText(FXTreeItem* item,const FXString& text);

  FXString getItemText(const FXTreeItem* item) const;

  void setItemOpenIcon(FXTreeItem* item,FXIcon* icon,FXbool owned=FALSE);

  FXIcon* getItemOpenIcon(const FXTreeItem* item) const;

  void setItemClosedIcon(FXTreeItem* item,FXIcon* icon,FXbool owned=FALSE);

  FXIcon* getItemClosedIcon(const FXTreeItem* item) const;

  void setItemData(FXTreeItem* item,void* ptr) const;

  void* getItemData(const FXTreeItem* item) const;

  FXTreeListSortFunc getSortFunc() const;

  void setSortFunc(FXTreeListSortFunc func);

  FXbool isPaneShown() const;

  void setFont(FXFont* fnt);

  FXFont* getFont() const;

  FXuint getListStyle() const;

  void setListStyle(FXuint style);

  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 ~FXTreeListBox();
  };

}

#endif

---

(C) 2002-2009 Niall Douglas. Some parts (C) to assorted authors.