ListBox Class Reference

#include <list_box.h>

Inheritance diagram for ListBox:

[legend]Collaboration diagram for ListBox:

[legend]List of all members.

Public Member Functions
	ListBox (const Rectanglei &rect, bool always_one_selected_b=true)
	~ListBox ()
void	Draw (const Point2i &mousePosition, Surface &surf) const
Widget *	Clic (const Point2i &mousePosition, uint button)
void	SetSizePosition (const Rectanglei &rect)
void	AddItem (bool selected, const std::string &label, const std::string &value, bool enabled=true)
void	Sort ()
int	MouseIsOnWhichItem (const Point2i &mousePosition) const
void	Select (uint index)
void	Select (const std::string &val)
int	GetSelectedItem () const
void	Deselect ()
void	RemoveSelected ()
const std::string &	ReadLabel () const
const std::string &	ReadValue () const
const std::string &	ReadValue (int index) const
uint	Size () const
Protected Attributes
uint	nb_visible_items
uint	nb_visible_items_max
uint	height_item
uint	first_visible_item
int	selected_item
std::vector< ListBoxItem * >	m_items
Button *	m_up
Button *	m_down
Private Attributes
bool	always_one_selected

---

Detailed Description

Definition at line 47 of file list_box.h.

---

Constructor & Destructor Documentation

ListBox::ListBox	(	const Rectanglei &	rect,
		bool	always_one_selected_b = true
	)

Definition at line 65 of file list_box.cpp.

                                                                    : Widget(rect)
{
  Rectanglei buttonRect;
  Profile *res = resource_manager.LoadXMLProfile( "graphism.xml", false);

  buttonRect.SetPosition(GetPositionX() + GetSizeX() - 12, GetPositionY() + 2);
  buttonRect.SetSize(10, 5);
  m_up = new Button(buttonRect, res, "menu/up");
  buttonRect.SetPosition(GetPositionX() + GetSizeX() - 12, GetPositionY() + GetSizeY() - 7);
  m_down = new Button(buttonRect, res, "menu/down");

  resource_manager.UnLoadXMLProfile( res);

  height_item = (*Font::GetInstance(Font::FONT_SMALL)).GetHeight();
  first_visible_item = 0;
  nb_visible_items_max = GetSizeY()/height_item;
  nb_visible_items = 0;

  selected_item = -1;
  always_one_selected = always_one_selected_b;
}

Here is the call graph for this function:

ListBox::~ListBox

(

)

Definition at line 87 of file list_box.cpp.

{
   delete m_up;
   delete m_down;

   m_items.clear();
}

---

Member Function Documentation

void ListBox::AddItem	(	bool	selected,
		const std::string &	label,
		const std::string &	value,
		bool	enabled = true
	)

Definition at line 210 of file list_box.cpp.

{
  uint pos = m_items.size();

  // Push item
  ListBoxItem * item = new ListBoxItem(label, *Font::GetInstance(Font::FONT_SMALL), value, enabled);
  m_items.push_back (item);

  // Select it if selected
  if( selected )
    Select (pos);

  nb_visible_items = m_items.size();
  if( nb_visible_items_max < nb_visible_items )
    nb_visible_items = nb_visible_items_max;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Widget * ListBox::Clic	(	const Point2i &	mousePosition,
		uint	button
	)			[virtual]

Reimplemented from Widget.

Definition at line 104 of file list_box.cpp.

{
  need_redrawing = true;

  // buttons for listbox with more items than visible
  if( m_items.size() > nb_visible_items_max ){
    if( (button == SDL_BUTTON_WHEELDOWN && Contains(mousePosition)) ||
        (button == SDL_BUTTON_LEFT && m_down->Contains(mousePosition)) ){

      // bottom button
      if( m_items.size() - first_visible_item > nb_visible_items_max )
        first_visible_item++ ;

      return this;
    }
    else if( (button == SDL_BUTTON_WHEELUP && Contains(mousePosition)) ||
             (button == SDL_BUTTON_LEFT && m_up->Contains(mousePosition)) ){

      // top button
      if( first_visible_item > 0 )
        first_visible_item-- ;

      return this;
    }
  }

  if( button == SDL_BUTTON_LEFT ){
    int item = MouseIsOnWhichItem(mousePosition);

    if( item == -1 )
      return NULL;

    if( item == selected_item ){
        //Deselect ();
    } else
      Select (item);
    return this;
  }
  else{
    return NULL;
  }
}

Here is the call graph for this function:

void ListBox::Deselect

(

)

Definition at line 270 of file list_box.cpp.

{
  assert (always_one_selected == false);
  selected_item = -1;
}

void ListBox::Draw	(	const Point2i &	mousePosition,
		Surface &	surf
	)			const [virtual]

Implements Widget.

Reimplemented in ListBoxWithLabel.

Definition at line 147 of file list_box.cpp.

{
  int item = MouseIsOnWhichItem(mousePosition);
  Rectanglei rect (*this);

  // Draw border and bg color
  surf.BoxColor(rect, defaultListColor1);
  surf.RectangleColor(rect, white_color);

  // Draw items
  for(uint i=0; i < nb_visible_items; i++){
    Rectanglei rect(GetPositionX() + 1, 
                    GetPositionY() + i * height_item + 1, 
                    GetSizeX() - 2, 
                    height_item - 2);
    
    // item is selected or mouse-overed
    if( int(i + first_visible_item) == selected_item) {
      surf.BoxColor(rect, defaultListColor2);
    } else if( i + first_visible_item == uint(item) ) {
      surf.BoxColor(rect, defaultListColor3);
    }

    // Really draw items
    Point2i pos = GetPosition() + Point2i(5, i*height_item);
    Rectanglei rect2(pos.x, pos.y, GetSizeX()-2, height_item-2);
    m_items[i + first_visible_item]->SetSizePosition(rect2);
    //    m_items[i + first_visible_item].Draw(GetPosition() + Point2i(5, i*height_item),
    //                           mousePosition, surf);
    m_items[i + first_visible_item]->Draw(mousePosition, surf);
    
    // item is disabled
    if(!m_items[i]->IsEnabled())
      surf.BoxColor(rect, defaultDisabledColorBox);
  }

  // buttons for listbox with more items than visible
  if (m_items.size() > nb_visible_items_max){
    m_up->Draw(mousePosition, surf);
    m_down->Draw(mousePosition, surf);
#ifdef SCROLLBAR
    uint tmp_y, tmp_h;
    tmp_y = y+10+ first_visible_item* (h-20) / m_items.size();
    tmp_h = nb_visible_items_max * (h-20) / m_items.size();
    if (tmp_h < 5) tmp_h =5;

    boxRGBA(surf,
            x+w-10, tmp_y,
            x+w-1,  tmp_y+tmp_h,
            white_color);
#endif
  }
}

Here is the call graph for this function:

int ListBox::GetSelectedItem

(

)

const

Definition at line 276 of file list_box.cpp.

{
  return selected_item;
}

Here is the caller graph for this function:

int ListBox::MouseIsOnWhichItem

(

const Point2i &

mousePosition

)

const

Definition at line 95 of file list_box.cpp.

{
  if( !Contains(mousePosition) )
    return -1;

  int index = (mousePosition.y - position.y) / height_item;
  return BorneLong(index + first_visible_item, 0, m_items.size() - 1);
}

Here is the call graph for this function:

Here is the caller graph for this function:

const std::string & ListBox::ReadLabel

(

)

const

Definition at line 281 of file list_box.cpp.

{
  assert (selected_item != -1);
  return m_items.at(selected_item)->GetLabel();
}

Here is the caller graph for this function:

const std::string & ListBox::ReadValue

(

int

index

)

const

Definition at line 293 of file list_box.cpp.

{
  assert (index != -1 && index < (int)m_items.size());
  return m_items.at(index)->GetValue();
}

const std::string & ListBox::ReadValue

(

)

const

Definition at line 287 of file list_box.cpp.

{
  assert (selected_item != -1);
  return m_items.at(selected_item)->GetValue();
}

Here is the caller graph for this function:

void ListBox::RemoveSelected

(

)

Definition at line 235 of file list_box.cpp.

{
  assert (always_one_selected == false);

  if( selected_item != -1 ){
    m_items.erase( m_items.begin() + selected_item );
    selected_item =- 1;
  }

  nb_visible_items = m_items.size();
  if( nb_visible_items_max < nb_visible_items )
    nb_visible_items = nb_visible_items_max;
}

Here is the caller graph for this function:

void ListBox::Select

(

const std::string &

val

)

Definition at line 255 of file list_box.cpp.

{
  uint index = 0;
  for(std::vector<ListBoxItem*>::iterator it=m_items.begin();
      it != m_items.end();
      it++,index++)
  {
    if((*it)->GetLabel() == val)
    {
      Select(index);
      return;
    }
  }
}

Here is the call graph for this function:

void ListBox::Select

(

uint

index

)

Definition at line 249 of file list_box.cpp.

{
  assert(index < m_items.size());
  selected_item = index;
}

Here is the caller graph for this function:

void ListBox::SetSizePosition

(

const Rectanglei &

rect

)

[virtual]

Implements Widget.

Reimplemented in ListBoxWithLabel.

Definition at line 201 of file list_box.cpp.

{
  StdSetSizePosition(rect);
  m_up->SetSizePosition( Rectanglei(GetPositionX() + GetSizeX() - 12, GetPositionY()+2, 10, 5) );
  m_down->SetSizePosition( Rectanglei(GetPositionX() + GetSizeX() - 12, GetPositionY() + GetSizeY() - 7, 10, 5) );

  nb_visible_items_max = GetSizeY()/height_item;
}

Here is the call graph for this function:

uint ListBox::Size

(

)

const

Definition at line 299 of file list_box.cpp.

{
  return m_items.size();
}

Here is the caller graph for this function:

void ListBox::Sort

(

)

Definition at line 230 of file list_box.cpp.

{
  //std::sort( m_items.begin(), m_items.end(), CompareItems() );
}

---

Member Data Documentation

bool ListBox::always_one_selected [private]

Definition at line 50 of file list_box.h.

uint ListBox::first_visible_item [protected]

Definition at line 58 of file list_box.h.

uint ListBox::height_item [protected]

Definition at line 55 of file list_box.h.

Button * ListBox::m_down [protected]

Definition at line 63 of file list_box.h.

std::vector<ListBoxItem*> ListBox::m_items [protected]

Definition at line 60 of file list_box.h.

Button* ListBox::m_up [protected]

Definition at line 63 of file list_box.h.

uint ListBox::nb_visible_items [protected]

Definition at line 54 of file list_box.h.

uint ListBox::nb_visible_items_max [protected]

Definition at line 54 of file list_box.h.

int ListBox::selected_item [protected]

Definition at line 59 of file list_box.h.

---

The documentation for this class was generated from the following files:

• src/gui/list_box.h
• src/gui/list_box.cpp

---