pawslistbox.h

Go to the documentation of this file.

/*
 * pawslistbox.h - Author: Andrew Craig
 *
 * Copyright (C) 2003 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation (version 2 of the License)
 * This program 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 General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

#ifndef PAWS_LIST_BOX_HEADER
#define PAWS_LIST_BOX_HEADER

#include "pawswidget.h"
#include "pawsmanager.h"
#include "pawstextbox.h"
#include "util/log.h"

class pawsScrollBar;

typedef int (*listBoxSortingFunc)(pawsWidget* a, pawsWidget* b);

int textBoxSortFunc(pawsWidget* widgetA, pawsWidget* widgetB);

int textBoxSortFunc_number(pawsWidget * widgetA, pawsWidget * widgetB);

//-----------------------------------------------------------------------------
//                            struct ColumnInfo
//-----------------------------------------------------------------------------

struct ColumnDef
{
    ColumnDef()
    {
        widgetNode  =  NULL;
        sortFunc    =  NULL;
        sortable = true;
        width = 0;
        height = 0;
    }

    int width;
    int height;
    csRef<iDocumentNode> widgetNode;    
    csString xmlbinding;
    bool sortable;

    listBoxSortingFunc sortFunc;        
};


#define LISTBOX_HIGHLIGHTED  0x01  
#define LISTBOX_SELECTED     0x02

//-----------------------------------------------------------------------------
//                            class pawsListBoxRow
//-----------------------------------------------------------------------------


class pawsListBoxRow : public pawsWidget
{
public:
    pawsListBoxRow();
    pawsListBoxRow(const pawsListBoxRow &origin);
    pawsWidget* GetColumn(size_t column);

    size_t GetTotalColumns()
    {
        return columns.GetSize();
    }

    void AddColumn(int column, ColumnDef* def);

    void AddTitleColumn(int column, ColumnDef* def);

    bool OnKeyDown(utf32_char keyCode, utf32_char keyChar, int modifiers);

    bool OnMouseDown(int button, int modifiers, int x, int y);

    bool OnDoubleClick(int button, int modifiers, int x, int y);

    void SetHeading(bool flag);

    void SetTitleRow(bool flag);

    int GetLastIndex()const
    {
        return lastIndex;
    }

    void SetLastIndex(int index)
    {
        lastIndex = index;
    }

    void Hide();

    bool IsHeading()
    {
        return isHeading;
    }

private:

    bool isHeading;  
    bool isTitleRow; 

    int lastIndex; 

    csArray<pawsWidget*> columns;

};


//-----------------------------------------------------------------------------
//                            class pawsListBox
//-----------------------------------------------------------------------------


#define LISTBOX_MOUSE_SCROLL_AMOUNT 3

class pawsListBox : public pawsWidget
{
public:
    pawsListBox();
    pawsListBox(const pawsListBox &origin);
    bool Setup(iDocumentNode* node);
    bool PostSetup();

    virtual ~pawsListBox();

    int GetSelection()
    {
        return selected;
    }

    pawsListBoxRow* GetSelectedRow();

    const char* GetSelectedText(size_t columnId);

    int GetSelectedRowNum();

    pawsListBoxRow* RemoveSelected();

    void Remove(int id);

    void Remove(pawsListBoxRow* rowToRemove);

    void AddRow(pawsListBoxRow* row);

    size_t GetRowCount();

    pawsListBoxRow* GetRow(size_t x);

    pawsListBoxRow* NewRow(size_t position = (size_t)-1);
    pawsListBoxRow* NewTextBoxRow(csList<csString> &rowEntry,size_t position = (size_t)-1);

    void Clear();

    void SendOnListAction(int status);

    bool Select(pawsListBoxRow* row, bool notify = true);

    bool SelectByIndex(int index, bool notify = true);

    void CreateTitleRow();

    virtual bool OnScroll(int direction, pawsScrollBar* widget);

    bool OnMouseDown(int button, int modifiers, int x, int y);

    int GetTotalColumns()
    {
        return totalColumns;
    }

    void SetTotalColumns(int numCols);

    void SetColumnDef(int col, int width, int height, const char* widgetDesc);

    void UseTitleRow(bool yes);

    virtual bool SelfPopulate(iDocumentNode* node);

    bool IsSelectable()
    {
        return selectable;
    }

    bool IsAutoID()
    {
        return autoID;
    }

    bool ConvertFromAutoID(int id, int &row, int &col);

    void MoveSelectBar(bool direction);

    void CalculateDrawPositions();

    bool OnKeyDown(utf32_char keyCode, utf32_char keyChar, int modifiers);

    void Resize();

    void SetNotify(pawsWidget* target)
    {
        notifyTarget = target;
    };

    int  GetSortedColumn();
    void SetSortedColumn(int colNum);

    bool GetSortOrder();
    void SetSortOrder(bool ascOrder);

    void SetSortingFunc(int colNum, listBoxSortingFunc sortFunc);

    void SortRows();


    pawsTextBox* GetTextCell(int rowNum, int colNum);

    csString GetTextCellValue(int rowNum, int colNum);

    void SetTextCellValue(int rowNum, int colNum, const csString &value);

    void AutoScrollUpdate(bool v)
    {
        autoUpdateScroll = v;
    }

    void SetScrollBarMaxValue();
    void MoveRow(int rownr,int dest);

protected:

    static const int BORDER_SIZE = 5;

    void CreateSortingArrow(int colNum);
    void SetSortingArrow(int colNum, bool ascOrder);
    void CheckSortingArrow(int colNum, bool ascOrder);
    void DeleteSortingArrow(int colNum);

    pawsWidget* GetColumnTitle(int colNum);

    int GetUnborderedHeight();

    bool usingTitleRow;

    pawsScrollBar* scrollBar;
    pawsScrollBar* horzscrollBar;

    int totalColumns;
    int totalRows;
    int columnHeight;
    int rowWidth;
    int topRow;
    int selected;
    int xMod;
    bool autoID;
    bool autoResize;
    bool autoUpdateScroll;

    ColumnDef* columnDef;

    pawsWidget* notifyTarget;

    csArray<pawsListBoxRow*> rows;
    pawsListBoxRow* titleRow;
    csString xmlbinding_row;

    int sortColNum;    // number of sorted column (or -1)
    bool ascOrder;

    static int sort_cmp(const void* rowA, const void* rowB);
    static listBoxSortingFunc sort_sortFunc;
    static int sort_sortColNum;
    static bool sort_ascOrder;

    csString highlightImage;
    unsigned int highlightAlpha;

    int         arrowSize;
    int         scrollbarWidth;
    int         scrollbarHeightMod;
    bool        useBorder;
    bool        selectable;     // can the user select listbox rows ?
    csString    arrowUp;
    csString    arrowDown;
};

CREATE_PAWS_FACTORY(pawsListBox);


#endif