ref: 2c23de27d5006e969106fad672399fafe6464845
dir: /DoConfig/fltk/FL/Fl_Tree_Prefs.H/
// // "$Id$" // #ifndef FL_TREE_PREFS_H #define FL_TREE_PREFS_H #include <FL/Fl.H> // needed for ABI version features (via Enumerations.H) ////////////////////// // FL/Fl_Tree_Prefs.H ////////////////////// // // Fl_Tree_Prefs -- This file is part of the Fl_Tree widget for FLTK // Copyright (C) 2009-2010 by Greg Ercolano. // // This library is free software. Distribution and use rights are outlined in // the file "COPYING" which should have been included with this file. If this // file is missing or damaged, see the license at: // // http://www.fltk.org/COPYING.php // // Please report all bugs and problems on the following page: // // http://www.fltk.org/str.php // /// /// \file /// \brief This file contains the definitions for Fl_Tree's preferences. /// /// \code /// Fl_Tree_Prefs /// : /// .....:....... /// : : /// Fl_Tree : /// |_____ Fl_Tree_Item /// /// \endcode /// /// \class Fl_Tree_Prefs /// \brief Tree widget's preferences. /// \enum Fl_Tree_Sort /// Sort order options for items added to the tree /// enum Fl_Tree_Sort { FL_TREE_SORT_NONE=0, ///< No sorting; items are added in the order defined (default). FL_TREE_SORT_ASCENDING=1, ///< Add items in ascending sort order. FL_TREE_SORT_DESCENDING=2 ///< Add items in descending sort order. }; /// \enum Fl_Tree_Connector /// Defines the style of connection lines between items. /// enum Fl_Tree_Connector { FL_TREE_CONNECTOR_NONE=0, ///< Use no lines connecting items FL_TREE_CONNECTOR_DOTTED=1, ///< Use dotted lines connecting items (default) FL_TREE_CONNECTOR_SOLID=2 ///< Use solid lines connecting items }; /// \enum Fl_Tree_Select /// Tree selection style. /// enum Fl_Tree_Select { FL_TREE_SELECT_NONE=0, ///< Nothing selected when items are clicked FL_TREE_SELECT_SINGLE=1, ///< Single item selected when item is clicked (default) FL_TREE_SELECT_MULTI=2, ///< Multiple items can be selected by clicking ///< with SHIFT, CTRL or mouse drags. FL_TREE_SELECT_SINGLE_DRAGGABLE=3 ///< Single items may be selected, and they may be ///< reordered by mouse drag. }; #if FLTK_ABI_VERSION >= 10301 /// \enum Fl_Tree_Item_Reselect_Mode /// Defines the ways an item can be (re) selected /// via item_reselect_mode(). /// enum Fl_Tree_Item_Reselect_Mode { FL_TREE_SELECTABLE_ONCE=0, ///< Item can only be selected once (default) FL_TREE_SELECTABLE_ALWAYS, ///< Enables FL_TREE_REASON_RESELECTED events for callbacks }; /// \enum Fl_Tree_Item_Draw_Mode /// Bit flags that control how item's labels and widget()s are drawn in the tree /// via item_draw_mode(). /// enum Fl_Tree_Item_Draw_Mode { FL_TREE_ITEM_DRAW_DEFAULT=0, ///< If widget() defined, draw in place of label, ///< and widget() tracks item height (default) FL_TREE_ITEM_DRAW_LABEL_AND_WIDGET=1, ///< If widget() defined, include label to the left of the widget FL_TREE_ITEM_HEIGHT_FROM_WIDGET=2 ///< If widget() defined, widget()'s height controls item's height }; #endif /*FLTK_ABI_VERSION*/ #if FLTK_ABI_VERSION >= 10303 class Fl_Tree_Item; typedef void (Fl_Tree_Item_Draw_Callback)(Fl_Tree_Item*, void*); #endif /// \class Fl_Tree_Prefs /// /// \brief Fl_Tree's Preferences class. /// /// This class manages the Fl_Tree's defaults. /// You should probably be using the methods in Fl_Tree /// instead of trying to accessing tree's preferences settings directly. /// class FL_EXPORT Fl_Tree_Prefs { Fl_Font _labelfont; // label's font face Fl_Fontsize _labelsize; // label's font size int _margintop; // -- int _marginleft; // |- tree's controllable margins #if FLTK_ABI_VERSION >= 10301 int _marginbottom; // -- #endif int _openchild_marginbottom; // extra space below an open child tree int _usericonmarginleft; // space to left of user icon (if any) int _labelmarginleft; // space to left of label #if FLTK_ABI_VERSION >= 10301 int _widgetmarginleft; // space to left of widget #endif int _connectorwidth; // connector width (right of open/close icon) int _linespacing; // vertical space between lines // Colors Fl_Color _labelfgcolor; // label's foreground color Fl_Color _labelbgcolor; // label's background color Fl_Color _connectorcolor; // connector dotted line color Fl_Tree_Connector _connectorstyle; // connector line style Fl_Image *_openimage; // the 'open' icon [+] Fl_Image *_closeimage; // the 'close' icon [-] Fl_Image *_userimage; // user's own icon #if FLTK_ABI_VERSION >= 10304 Fl_Image *_opendeimage; // deactivated 'open' icon Fl_Image *_closedeimage; // deactivated 'close' icon Fl_Image *_userdeimage; // deactivated user icon #endif char _showcollapse; // 1=show collapse icons, 0=don't char _showroot; // show the root item as part of the tree Fl_Tree_Sort _sortorder; // none, ascening, descending, etc. Fl_Boxtype _selectbox; // selection box type Fl_Tree_Select _selectmode; // selection mode #if FLTK_ABI_VERSION >= 10301 Fl_Tree_Item_Reselect_Mode _itemreselectmode; // controls item selection callback() behavior Fl_Tree_Item_Draw_Mode _itemdrawmode; // controls how items draw label + widget() #endif /*FLTK_ABI_VERSION*/ #if FLTK_ABI_VERSION >= 10303 Fl_Tree_Item_Draw_Callback *_itemdrawcallback; // callback to handle drawing items (0=none) void *_itemdrawuserdata; // data for drawing items (0=none) #endif public: Fl_Tree_Prefs(); #if FLTK_ABI_VERSION >= 10304 ~Fl_Tree_Prefs(); #endif //////////////////////////// // Labels //////////////////////////// /// Return the label's font. inline Fl_Font item_labelfont() const { return(_labelfont); } /// Set the label's font to \p val. inline void item_labelfont(Fl_Font val) { _labelfont = val; } /// Return the label's size in pixels. inline Fl_Fontsize item_labelsize() const { return(_labelsize); } /// Set the label's size in pixels to \p val. inline void item_labelsize(Fl_Fontsize val) { _labelsize = val; } /// Get the default label foreground color inline Fl_Color item_labelfgcolor() const { return(_labelfgcolor); } /// Set the default label foreground color inline void item_labelfgcolor(Fl_Color val) { _labelfgcolor = val; } #if FLTK_ABI_VERSION >= 10301 /// Get the default label background color. /// This returns the Fl_Tree::color() unless item_labelbgcolor() /// has been set explicitly. /// inline Fl_Color item_labelbgcolor() const { return _labelbgcolor; } /// Set the default label background color. /// Once set, overrides the default behavior of using Fl_Tree::color(). /// inline void item_labelbgcolor(Fl_Color val) { _labelbgcolor = val; } #else /*FLTK_ABI_VERSION*/ /// Get the default label background color inline Fl_Color item_labelbgcolor() const { return(_labelbgcolor); } /// Set the default label background color inline void item_labelbgcolor(Fl_Color val) { _labelbgcolor = val; } #endif /*FLTK_ABI_VERSION*/ ///////////////// // Obsolete names - for 1.3.0 backwards compat ///////////////// /// Obsolete: Return the label's font. Please use item_labelfont() instead. inline Fl_Font labelfont() const { return(_labelfont); } /// Obsolete: Set the label's font to \p val. Please use item_labelfont(Fl_Font) instead. inline void labelfont(Fl_Font val) { _labelfont = val; } /// Obsolete: Return the label's size in pixels. Please use item_labelsize() instead. inline Fl_Fontsize labelsize() const { return(_labelsize); } /// Obsolete: Set the label's size in pixels to \p val. Please use item_labelsize(Fl_Fontsize) instead. inline void labelsize(Fl_Fontsize val) { _labelsize = val; } /// Obsolete: Get the default label foreground color. Please use item_labelfgcolor() instead. inline Fl_Color labelfgcolor() const { return(_labelfgcolor); } /// Obsolete: Set the default label foreground color. Please use item_labelfgcolor(Fl_Color) instead. inline void labelfgcolor(Fl_Color val) { _labelfgcolor = val; } /// Obsolete: Get the default label background color. Please use item_labelbgcolor() instead. inline Fl_Color labelbgcolor() const { return(item_labelbgcolor()); } /// Obsolete: Set the default label background color. Please use item_labelbgcolor(Fl_Color) instead. inline void labelbgcolor(Fl_Color val) { item_labelbgcolor(val); } //////////////////////////// // Margins //////////////////////////// /// Get the left margin's value in pixels inline int marginleft() const { return(_marginleft); } /// Set the left margin's value in pixels inline void marginleft(int val) { _marginleft = val; } /// Get the top margin's value in pixels inline int margintop() const { return(_margintop); } /// Set the top margin's value in pixels inline void margintop(int val) { _margintop = val; } #if FLTK_ABI_VERSION >= 10301 /// Get the bottom margin's value in pixels. /// This is the extra distance the vertical scroller lets you travel. inline int marginbottom() const { return(_marginbottom); } /// Set the bottom margin's value in pixels /// This is the extra distance the vertical scroller lets you travel. inline void marginbottom(int val) { _marginbottom = val; } #endif /*FLTK_ABI_VERSION*/ /// Get the margin below an open child in pixels inline int openchild_marginbottom() const { return(_openchild_marginbottom); } /// Set the margin below an open child in pixels inline void openchild_marginbottom(int val) { _openchild_marginbottom = val; } /// Get the user icon's left margin value in pixels inline int usericonmarginleft() const { return(_usericonmarginleft); } /// Set the user icon's left margin value in pixels inline void usericonmarginleft(int val) { _usericonmarginleft = val; } /// Get the label's left margin value in pixels inline int labelmarginleft() const { return(_labelmarginleft); } /// Set the label's left margin value in pixels inline void labelmarginleft(int val) { _labelmarginleft = val; } #if FLTK_ABI_VERSION >= 10301 /// Get the widget()'s left margin value in pixels inline int widgetmarginleft() const { return(_widgetmarginleft); } /// Set the widget's left margin value in pixels inline void widgetmarginleft(int val) { _widgetmarginleft = val; } #endif /*FLTK_ABI_VERSION*/ /// Get the line spacing value in pixels inline int linespacing() const { return(_linespacing); } /// Set the line spacing value in pixels inline void linespacing(int val) { _linespacing = val; } //////////////////////////// // Colors and Styles //////////////////////////// /// Get the connector color used for tree connection lines. inline Fl_Color connectorcolor() const { return(_connectorcolor); } /// Set the connector color used for tree connection lines. inline void connectorcolor(Fl_Color val) { _connectorcolor = val; } /// Get the connector style. inline Fl_Tree_Connector connectorstyle() const { return(_connectorstyle); } /// Set the connector style. inline void connectorstyle(Fl_Tree_Connector val) { _connectorstyle = val; } /// Set the connector style [integer]. inline void connectorstyle(int val) { _connectorstyle = Fl_Tree_Connector(val); } /// Get the tree connection line's width. inline int connectorwidth() const { return(_connectorwidth); } /// Set the tree connection line's width. inline void connectorwidth(int val) { _connectorwidth = val; } //////////////////////////// // Icons //////////////////////////// /// Get the current default 'open' icon. /// Returns the Fl_Image* of the icon, or 0 if none. /// inline Fl_Image *openicon() const { return(_openimage); } void openicon(Fl_Image *val); /// Gets the default 'close' icon /// Returns the Fl_Image* of the icon, or 0 if none. /// inline Fl_Image *closeicon() const { return(_closeimage); } void closeicon(Fl_Image *val); /// Gets the default 'user icon' (default is 0) inline Fl_Image *usericon() const { return(_userimage); } /// Sets the default 'user icon' /// Returns the Fl_Image* of the icon, or 0 if none (default). /// inline void usericon(Fl_Image *val) { _userimage = val; #if FLTK_ABI_VERSION >= 10304 // Update deactivated version of icon.. if ( _userdeimage ) delete _userdeimage; if ( _userimage ) { _userdeimage = _userimage->copy(); _userdeimage->inactive(); } else { _userdeimage = 0; } #endif } #if FLTK_ABI_VERSION >= 10304 /// Return the deactivated version of the open icon, if any. /// Returns 0 if none. inline Fl_Image *opendeicon() const { return _opendeimage; } /// Return the deactivated version of the close icon, if any. /// Returns 0 if none. inline Fl_Image *closedeicon() const { return _closedeimage; } /// Return the deactivated version of the user icon, if any. /// Returns 0 if none. inline Fl_Image *userdeicon() const { return _userdeimage; } #endif //////////////////////////// // Options //////////////////////////// /// Returns 1 if the collapse icon is enabled, 0 if not. inline char showcollapse() const { return(_showcollapse); } /// Set if we should show the collapse icon or not. /// If collapse icons are disabled, the user will not be able /// to interactively collapse items in the tree, unless the application /// provides some other means via open() and close(). /// /// \param[in] val 1: shows collapse icons (default),\n /// 0: hides collapse icons. /// inline void showcollapse(int val) { _showcollapse = val; } /// Get the default sort order value inline Fl_Tree_Sort sortorder() const { return(_sortorder); } /// Set the default sort order value. /// Defines the order new items appear when add()ed to the tree. /// See Fl_Tree_Sort for possible values. /// inline void sortorder(Fl_Tree_Sort val) { _sortorder = val; } /// Get the default selection box's box drawing style as an Fl_Boxtype. inline Fl_Boxtype selectbox() const { return(_selectbox); } /// Set the default selection box's box drawing style to \p val. inline void selectbox(Fl_Boxtype val) { _selectbox = val; } /// Returns 1 if the root item is to be shown, or 0 if not. inline int showroot() const { return(int(_showroot)); } /// Set if the root item should be shown or not. /// \param[in] val 1 -- show the root item (default)\n /// 0 -- hide the root item. /// inline void showroot(int val) { _showroot = char(val); } /// Get the selection mode used for the tree inline Fl_Tree_Select selectmode() const { return(_selectmode); } /// Set the selection mode used for the tree to \p val. /// This affects how items in the tree are selected /// when clicked on and dragged over by the mouse. /// See Fl_Tree_Select for possible values. /// inline void selectmode(Fl_Tree_Select val) { _selectmode = val; } #if FLTK_ABI_VERSION >= 10301 /// Returns the current item re/selection mode Fl_Tree_Item_Reselect_Mode item_reselect_mode() const { return _itemreselectmode; } /// Sets the item re/selection mode void item_reselect_mode(Fl_Tree_Item_Reselect_Mode mode) { _itemreselectmode = mode; } /// Get the 'item draw mode' used for the tree inline Fl_Tree_Item_Draw_Mode item_draw_mode() const { return(_itemdrawmode); } /// Set the 'item draw mode' used for the tree to \p val. /// This affects how items in the tree are drawn, /// such as when a widget() is defined. /// See Fl_Tree_Item_Draw_Mode for possible values. /// inline void item_draw_mode(Fl_Tree_Item_Draw_Mode val) { _itemdrawmode = val; } #endif #if FLTK_ABI_VERSION >= 10303 void item_draw_callback(Fl_Tree_Item_Draw_Callback *cb, void *data=0) { _itemdrawcallback = cb; _itemdrawuserdata = data; } Fl_Tree_Item_Draw_Callback* item_draw_callback() const { return(_itemdrawcallback); } void* item_draw_user_data() const { return(_itemdrawuserdata); } void do_item_draw_callback(Fl_Tree_Item *o) const { _itemdrawcallback(o, _itemdrawuserdata); } #endif }; #endif /*FL_TREE_PREFS_H*/ // // End of "$Id$". //