ZXWidgetList.h

Go to the documentation of this file.

 
/* **************************************************************************/
#ifndef ZXWIDGET_LIST
#define ZXWIDGET_LIST
 
#include <memory>
#include "zxecosystem/gui/widgets/ZXWidgetsSimple.h"
#include "zxecosystem/gui/widgets/ZXWidgetSlide.h"
 
 
namespace zxeco
{
 
namespace gui
{
 
/*******************************************************************************
*
*   Class: ListWidget
*
*******************************************************************************/
 
 
class ListWidget: public ContainerWidget
{
 public:
 
    ListWidget(ID id, const std::string & name,
               const LabelList & initllist, const CharArea & minsize, 
               uint8_t flexdims = AreaFitting::FLEX_HOR | AreaFitting::FLEX_VER,
               const std::string & tooltiptext = "",
               HorAlign hal = HorAlign::LEFT, 
               VertAlign val = VertAlign::TOP);
 
    LabelList & list(void) noexcept { return(*pllist_); }
 
    void append(const Label::Vector & v);
 
    size_t howManyLinesCanBeShown(void) const;
 
    size_t listSizeOfVisible(void) const;
 
    size_t indexOfTopLine(void) const;
 
    LabelList::Iterator lastLineInteracted(void) const noexcept 
 
         { return(lastlinepointed_); }
 
    LabelList::Iterator cursoredLine(void) const;
 
    void moveCursoredLine(bool upordown, size_t howmany);
 
    void moveCursoredLineToExtreme(bool beginningorend);
 
    void moveCursoredLine(size_t where);
 
    bool eventProcessedByList(const CallbackParms & cbp) const noexcept 
 
        { return((cbp.isAfterWithData()) && 
                 (cbp.whoprocessed != nullptr) &&
                 (cbp.whoprocessed == pnudelist_)); }
 
    char eventProcessedWentBeyond(const CallbackParms & cbp) const noexcept;
 
    bool eventLeftClickedOrEnter(const CallbackParms & cbp) const noexcept
        { return(eventProcessedByList(cbp) && 
                 (cbp.hasBeenLeftClicked() || cbp.hasPressedEnter())); }
 
    bool eventHasChangedCursored(const CallbackParms & cbp) const noexcept
        { return(eventProcessedByList(cbp) &&
                 (cbp.pevd->isMouseWheel() ||
                  cbp.hasBeenLeftClicked() ||
                  cbp.hasPressedKey(DesktopInterface::KeyID::K_ENTER) ||
                  cbp.hasPressedKey(DesktopInterface::KeyID::K_DOWN) ||
                  cbp.hasPressedKey(DesktopInterface::KeyID::K_UP) ||
                  cbp.hasPressedKey(DesktopInterface::KeyID::K_PGDOWN) ||
                  cbp.hasPressedKey(DesktopInterface::KeyID::K_PGUP) )); }
 
 
    CharRect zoneForLineContent(const LabelList::Iterator & itl) const;
 
    void setUDGs(const uint8_t * udgs) 
    
        { if (istree_) RUNTIMEEXCEP("Cannot set UDGs with a tree list"); 
          Widget::setUDGs(udgs); }      
 
    const char * className(void) const noexcept { return("ListWidget"); }
    std::pair<bool,const CharRect *> hasFocusZone(void) const noexcept override;
    const AreaFitting & calcFittingNeeds(const CharArea & area); 
    Widget * setDrawingZone(const CharRect & zone) override;
    void setTooltip(const std::string & ttt) override;
 
 
 private:
 
    enum Subwidgs {
                    NUDELIST = 0,
                    VERTSCROLL,
                    HORIZSCROLL,
                    NUMSUBWIDGETS
                  };
 
    static const uint8_t kTreeUDGs_[5 * 8];
    static const std::string kTreeChars_;
    static const ID kIDsSubs[NUMSUBWIDGETS];
 
 
    const CharArea nudeminsize_;
    const uint8_t flexdims_;
 
    std::unique_ptr<LabelList> pllist_;
    bool istree_;
    Widget * pnudelist_;
    SlideWidget * pvertscroll_;
    SlideWidget * phorizscroll_;
    double oldvalh_,oldvalv_;
    LabelList::Iterator lastlinepointed_;
 
    bool needExpandedCursor(void) const;
    LabelList::Iterator cursoredLabel(int & relposfirst, 
                                      int & relposlast) const;
    std::string scrollStatesInfo(void) const;
    std::string nudelistStateInfo(void) const;
    void setViewportFromSlide(char who);
    void setSlideFromViewport(char who);
    void setBothViewportAndSlide(char who, int val);
    void syncViewportAfterSlides(bool respectcursored, char cause);
    void listChanged(bool respectcursored, char cause);
    void drawRaw(void);
    int processEvent(const EventData & evdata, Widget * who) override;
};
 
 
 
} // end namespace gui
} // end namespace zxeco
 
#endif
 // ZXWidgetList