/*
 * pawsquestwindow.h - Author: Keith Fulton
 *
 * 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_QUEST_WINDOW_HEADER
#define PAWS_QUEST_WINDOW_HEADER

#include "paws/pawswidget.h"
#include "paws/pawslistbox.h"
#include "paws/pawsbutton.h"
#include "paws/pawstabwindow.h"
#include "gui/pawscontrolwindow.h"

/// Enum of the columns for the listbox:
enum 
{
    QCOL_ICON = 0,
    QCOL_NAME = 1,
    QCOL_ID   = 2
};

struct QuestNote
{
    int id;
    unsigned int topLine;
    csString notes;
};

/** 
 * Window contains a list of the available loot items. 
 * with options to take them, roll for them or cancel the window.
 *
 * NOTE: the current expected columns for the listbox are
 *     as follows:
 *
 *  1) icon
 *  2) item name
 *  3) item id (hidden)
 */
class pawsQuestListWindow : public pawsControlledWindow, public psCmdBase
{
public:
    /// Constructor
    pawsQuestListWindow();

    /// Virtual destructor
    virtual ~pawsQuestListWindow();

    /// Handles petition server messages
    void HandleMessage( MsgEntry* message );

    /// Handles commands
    const char* HandleCommand(const char* cmd);

    /// Setup the widget with command/message handling capabilities
    bool PostSetup();

    /// Handle button clicks
    bool OnButtonPressed(int mouseButton, int keyModifier, pawsWidget* reporter);

    void OnListAction( pawsListBox* selected, int status );

    /// Save quest notes
    void SaveNotes(const char * fileName);

    /// Load quest notes
    void LoadNotes(const char * fileName);
    
    /// Show quest notes
    void ShowNotes();

protected:

    /// Ask server for data about given quest
    void RequestQuestData(int id);

    /// Ask server to discard a given quest
    void DiscardQuest(int id);

    /// The selected tab of quests
    pawsTabWindow* questTab;

    /// The list of quests
    pawsListBox* questList;

    /// The list of completed quests
    pawsListBox* completedQuestList;

    /// The list of uncompleted quests (discarded quests are hidden; deleted after expiration)
    pawsListBox* uncompletedQuestList;

    pawsMessageTextBox* description;

    pawsEditTextBox* notes;

    int questID;        // ID of selected quest (-1 = no quest selected)
    int questIDBuffer;  // ID of pending discard (in case selection changes during prompt)

    csArray<QuestNote*> quest_notes;
    
    csRef<iVFS> vfs;
    csRef<iDocumentSystem> xml;
    psString filename;
};

/** The pawsLootWindow factory
 */
CREATE_PAWS_FACTORY( pawsQuestListWindow );

#endif