lib/gui/elistbox.cpp

   1 #include <lib/gui/elistbox.h>
   2 #include <lib/gui/elistboxcontent.h>
   3 #include <lib/gui/eslider.h>
   4 #include <lib/actions/action.h>
   5
   6 eListbox::eListbox(eWidget *parent) :
   7         eWidget(parent), m_scrollbar_mode(showNever), m_prev_scrollbar_page(-1),
   8         m_content_changed(false), m_enabled_wrap_around(false), m_top(0), m_selected(0), m_itemheight(25),
   9         m_items_per_page(0), m_selection_enabled(1), m_scrollbar(NULL)
  10 {
  11 //      setContent(new eListboxStringContent());
  12
  13         ePtr<eActionMap> ptr;
  14         eActionMap::getInstance(ptr);
  15         ptr->bindAction("ListboxActions", 0, 0, this);
  16 }
  17
  18 eListbox::~eListbox()
  19 {
  20         if (m_scrollbar)
  21                 delete m_scrollbar;
  22
  23         ePtr<eActionMap> ptr;
  24         eActionMap::getInstance(ptr);
  25         ptr->unbindAction(this, 0);
  26 }
  27
  28 void eListbox::setScrollbarMode(int mode)
  29 {
  30         m_scrollbar_mode = mode;
  31         if (m_scrollbar)
  32         {
  33                 if (m_scrollbar_mode == showNever)
  34                 {
  35                         delete m_scrollbar;
  36                         m_scrollbar=0;
  37                 }
  38         }
  39         else
  40         {
  41                 m_scrollbar = new eSlider(this);
  42                 m_scrollbar->hide();
  43                 m_scrollbar->setBorderWidth(1);
  44                 m_scrollbar->setOrientation(eSlider::orVertical);
  45                 m_scrollbar->setRange(0,100);
  46         }
  47 }
  48
  49 void eListbox::setWrapAround(bool state)
  50 {
  51         m_enabled_wrap_around = state;
  52 }
  53
  54 void eListbox::setContent(iListboxContent *content)
  55 {
  56         int oldsel = m_selected;
  57         m_content = content;
  58         if (content)
  59                 m_content->setListbox(this);
  60         entryReset();
  61         if (oldsel == m_selected)
  62                 /* emit */ selectionChanged();
  63 }
  64
  65 bool eListbox::atBegin()
  66 {
  67         if (m_content && !m_selected)
  68                 return true;
  69         return false;
  70 }
  71
  72 bool eListbox::atEnd()
  73 {
  74         if (m_content && m_content->size() == m_selected+1)
  75                 return true;
  76         return false;
  77 }
  78
  79 void eListbox::moveToEnd()
  80 {
  81         /* move to last existing one ("end" is already invalid) */
  82         m_content->cursorEnd(); m_content->cursorMove(-1);
  83         /* current selection invisible? */
  84         if (m_top + m_items_per_page <= m_content->cursorGet())
  85         {
  86                 int rest = m_content->size() % m_items_per_page;
  87                 if (rest)
  88                         m_top = m_content->cursorGet() - rest + 1;
  89                 else
  90                         m_top = m_content->cursorGet() - m_items_per_page + 1;
  91                 if (m_top < 0)
  92                         m_top = 0;
  93         }
  94 }
  95
  96 void eListbox::moveSelection(int dir)
  97 {
  98                 /* refuse to do anything without a valid list. */
  99         if (!m_content)
 100                 return;
 101                 /* if our list does not have one entry, don't do anything. */
 102         if (!m_items_per_page)
 103                 return;
 104                 /* we need the old top/sel to see what we have to redraw */
 105         int oldtop = m_top;
 106         int oldsel = m_selected;
 107                 /* first, move cursor */
 108         switch (dir)
 109         {
 110         case moveUp:
 111         {
 112                 m_content->cursorMove(-1);
 113                 if (m_enabled_wrap_around && oldsel == m_content->cursorGet())  // must wrap around ?
 114                         moveToEnd();
 115                 break;
 116         }
 117         case moveDown:
 118                 m_content->cursorMove(1);
 119                         /* ok - we could have reached the end. So we do wrap around. */
 120                 if (!m_content->cursorValid())
 121                 {
 122                         if (m_enabled_wrap_around)
 123                         {
 124                                 m_top = 0;
 125                                 m_content->cursorHome();
 126                         }
 127                         else
 128                                 m_content->cursorMove(-1);
 129                 }
 130                 break;
 131         case pageUp:
 132                 if (m_content->cursorGet() >= m_items_per_page)
 133                 {
 134                         m_content->cursorMove(-m_items_per_page);
 135                         m_top -= m_items_per_page;
 136                         if (m_top < 0)
 137                                 m_top = 0;
 138                 } else
 139                 {
 140                         m_top = 0;
 141                         m_content->cursorHome();
 142                 }
 143                 break;
 144         case moveTop:
 145                 m_content->cursorHome();
 146                 m_top = 0; /* align with top, speeds up process */
 147                 break;
 148         case pageDown:
 149                 m_content->cursorMove(m_items_per_page);
 150                 if (m_content->cursorValid())
 151                         break;
 152                                 /* fall through */
 153         case moveEnd:
 154                 moveToEnd();
 155                 break;
 156         case justCheck:
 157                 break;
 158         }
 159
 160         if (m_content->cursorValid() && !m_content->currentCursorSelectable())
 161         {
 162                         /* ok, our cursor position is valid (i.e. in list), but not selectable. */
 163
 164                         /* when moving up, continue until we found a valid position. */
 165                 if ((dir == moveUp) || (dir == pageDown))
 166                 {
 167                         while (m_content->cursorGet())
 168                         {
 169                                 m_content->cursorMove(-1);
 170                                 if (m_content->currentCursorSelectable())
 171                                 {
 172                                         break;
 173                                 }
 174                         }
 175                 } else
 176                 {
 177                                 /* else move down */
 178                         while (m_content->cursorValid())
 179                         {
 180                                 m_content->cursorMove(+1);
 181                                 if (m_content->currentCursorSelectable())
 182                                 {
 183                                         break;
 184                                 }
 185                         }
 186
 187                         if (!m_content->cursorValid())
 188                                 m_content->cursorMove(-1);
 189                 }
 190
 191                 if (!m_content->currentCursorSelectable())
 192                         m_content->cursorSet(oldsel);
 193         }
 194
 195                 /* note that we could be on an invalid cursor position, but we don't
 196                    care. this only happens on empty lists, and should have almost no
 197                    side effects. */
 198
 199                 /* now, look wether the current selection is out of screen */
 200         m_selected = m_content->cursorGet();
 201         while (m_selected < m_top)
 202         {
 203                 m_top -= m_items_per_page;
 204                 if (m_top < 0)
 205                         m_top = 0;
 206         }
 207         while (m_selected >= m_top + m_items_per_page)
 208                 /* m_top should be always valid here as it's selected */
 209                 m_top += m_items_per_page;
 210
 211         if (oldsel != m_selected)
 212                 /* emit */ selectionChanged();
 213
 214         updateScrollBar();
 215
 216         if (m_top != oldtop)
 217                 invalidate();
 218         else if (m_selected != oldsel)
 219         {
 220    /* redraw the old and newly selected */
 221                 gRegion inv = eRect(0, m_itemheight * (m_selected-m_top), size().width(), m_itemheight);
 222                 inv |= eRect(0, m_itemheight * (oldsel-m_top), size().width(), m_itemheight);
 223
 224                 invalidate(inv);
 225         }
 226 }
 227
 228 void eListbox::moveSelectionTo(int index)
 229 {
 230         if (m_content)
 231         {
 232                 m_content->cursorHome();
 233                 m_content->cursorMove(index);
 234                 moveSelection(justCheck);
 235         }
 236 }
 237
 238 int eListbox::getCurrentIndex()
 239 {
 240         if (m_content && m_content->cursorValid())
 241                 return m_content->cursorGet();
 242         return 0;
 243 }
 244
 245 void eListbox::updateScrollBar()
 246 {
 247         if (!m_content || m_scrollbar_mode == showNever )
 248                 return;
 249         int entries = m_content->size();
 250         if (m_content_changed)
 251         {
 252                 int width = size().width();
 253                 int height = size().height();
 254                 m_content_changed = false;
 255                 if (entries > m_items_per_page || m_scrollbar_mode == showAlways)
 256                 {
 257                         int sbarwidth=width/16;
 258                         if (sbarwidth < 18)
 259                                 sbarwidth = 18;
 260                         if (sbarwidth > 22)
 261                                 sbarwidth = 22;
 262                         m_scrollbar->move(ePoint(width-sbarwidth, 0));
 263                         m_scrollbar->resize(eSize(sbarwidth, height));
 264                         m_content->setSize(eSize(width-sbarwidth-5, m_itemheight));
 265                         m_scrollbar->show();
 266                 }
 267                 else
 268                 {
 269                         m_content->setSize(eSize(width, m_itemheight));
 270                         m_scrollbar->hide();
 271                 }
 272         }
 273         if (m_items_per_page && entries)
 274         {
 275                 int curVisiblePage = m_top / m_items_per_page;
 276                 if (m_prev_scrollbar_page != curVisiblePage)
 277                 {
 278                         m_prev_scrollbar_page = curVisiblePage;
 279                         int pages = entries / m_items_per_page;
 280                         if ((pages*m_items_per_page) < entries)
 281                                 ++pages;
 282                         int start=(m_top*100)/(pages*m_items_per_page);
 283                         int vis=(m_items_per_page*100)/(pages*m_items_per_page);
 284                         if (vis < 3)
 285                                 vis=3;
 286                         m_scrollbar->setStartEnd(start,start+vis);
 287                 }
 288         }
 289 }
 290
 291 int eListbox::event(int event, void *data, void *data2)
 292 {
 293         switch (event)
 294         {
 295         case evtPaint:
 296         {
 297                 ePtr<eWindowStyle> style;
 298
 299                 if (!m_content)
 300                         return eWidget::event(event, data, data2);
 301                 assert(m_content);
 302
 303                 getStyle(style);
 304
 305                 if (!m_content)
 306                         return 0;
 307
 308                 gPainter &painter = *(gPainter*)data2;
 309
 310                 m_content->cursorSave();
 311                 m_content->cursorMove(m_top - m_selected);
 312
 313                 gRegion entryrect = eRect(0, 0, size().width(), m_itemheight);
 314                 const gRegion &paint_region = *(gRegion*)data;
 315
 316                 for (int y = 0, i = 0; i <= m_items_per_page; y += m_itemheight, ++i)
 317                 {
 318                         gRegion entry_clip_rect = paint_region & entryrect;
 319
 320                         if (!entry_clip_rect.empty())
 321                                 m_content->paint(painter, *style, ePoint(0, y), m_selected == m_content->cursorGet() && m_content->size() && m_selection_enabled);
 322
 323                                 /* (we could clip with entry_clip_rect, but
 324                                    this shouldn't change the behaviour of any
 325                                    well behaving content, so it would just
 326                                    degrade performance without any gain.) */
 327
 328                         m_content->cursorMove(+1);
 329                         entryrect.moveBy(ePoint(0, m_itemheight));
 330                 }
 331
 332                 // clear/repaint empty/unused space between scrollbar and listboxentrys
 333                 if (m_scrollbar && m_scrollbar->isVisible())
 334                 {
 335                         style->setStyle(painter, eWindowStyle::styleListboxNormal);
 336                         painter.clip(eRect(m_scrollbar->position() - ePoint(5,0), eSize(5,m_scrollbar->size().height())));
 337                         painter.clear();
 338                         painter.clippop();
 339                 }
 340
 341                 m_content->cursorRestore();
 342
 343                 return 0;
 344         }
 345
 346         case evtChangedSize:
 347                 recalcSize();
 348                 return eWidget::event(event, data, data2);
 349
 350         case evtAction:
 351                 if (isVisible())
 352                 {
 353                         moveSelection((int)data2);
 354                         return 1;
 355                 }
 356                 return 0;
 357         default:
 358                 return eWidget::event(event, data, data2);
 359         }
 360 }
 361
 362 void eListbox::recalcSize()
 363 {
 364         m_content_changed=true;
 365         m_prev_scrollbar_page=-1;
 366         m_content->setSize(eSize(size().width(), m_itemheight));
 367         m_items_per_page = size().height() / m_itemheight;
 368
 369         if (m_items_per_page < 0) /* TODO: whyever - our size could be invalid, or itemheigh could be wrongly specified. */
 370                 m_items_per_page = 0;
 371
 372         moveSelection(justCheck);
 373 }
 374
 375 void eListbox::setItemHeight(int h)
 376 {
 377         if (h)
 378                 m_itemheight = h;
 379         else
 380                 m_itemheight = 20;
 381         recalcSize();
 382 }
 383
 384 void eListbox::setSelectionEnable(int en)
 385 {
 386         if (m_selection_enabled == en)
 387                 return;
 388         m_selection_enabled = en;
 389         entryChanged(m_selected); /* redraw current entry */
 390 }
 391
 392 void eListbox::entryAdded(int index)
 393 {
 394                 /* manage our local pointers. when the entry was added before the current position, we have to advance. */
 395
 396                 /* we need to check <= - when the new entry has the (old) index of the cursor, the cursor was just moved down. */
 397         if (index <= m_selected)
 398                 ++m_selected;
 399         if (index <= m_top)
 400                 ++m_top;
 401
 402                 /* we have to check wether our current cursor is gone out of the screen. */
 403                 /* moveSelection will check for this case */
 404         moveSelection(justCheck);
 405
 406                 /* now, check if the new index is visible. */
 407         if ((m_top <= index) && (index < (m_top + m_items_per_page)))
 408         {
 409                         /* todo, calc exact invalidation... */
 410                 invalidate();
 411         }
 412 }
 413
 414 void eListbox::entryRemoved(int index)
 415 {
 416         if (index == m_selected)
 417                 m_selected = m_content->cursorGet();
 418
 419         moveSelection(justCheck);
 420
 421         if ((m_top <= index) && (index < (m_top + m_items_per_page)))
 422         {
 423                         /* todo, calc exact invalidation... */
 424                 invalidate();
 425         }
 426 }
 427
 428 void eListbox::entryChanged(int index)
 429 {
 430         if ((m_top <= index) && (index < (m_top + m_items_per_page)))
 431         {
 432                 gRegion inv = eRect(0, m_itemheight * (index-m_top), size().width(), m_itemheight);
 433                 invalidate(inv);
 434         }
 435 }
 436
 437 void eListbox::entryReset(bool selectionHome)
 438 {
 439         m_content_changed = true;
 440         m_prev_scrollbar_page = -1;
 441
 442         if (selectionHome)
 443         {
 444                 if (m_content)
 445                         m_content->cursorHome();
 446                 m_top = 0;
 447                 m_selected = 0;
 448         }
 449
 450         if (m_content && (m_selected >= m_content->size()))
 451         {
 452                 if (m_content->size())
 453                         m_selected = m_content->size() - 1;
 454                 else
 455                         m_selected = 0;
 456                 m_content->cursorSet(m_selected);
 457                 selectionChanged();
 458         }
 459
 460         moveSelection(justCheck);
 461         invalidate();
 462 }