listview.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
**    Harry Storbacka
*/


#pragma once

// (Note, enum moved here because of problems with gcc not allowing "enum CL_ListViewDisplayMode;")
enum CL_ListViewDisplayMode
{
        listview_mode_thumbnails,
        listview_mode_tiles,
        listview_mode_icons,
        listview_mode_list,
        listview_mode_details
};

#include "../api_gui.h"
#include "../gui_component.h"
#include "listview_item.h"
#include "listview_selected_item.h"
#include "listview_column_header.h"
#include "listview_icon_list.h"

class CL_ListViewHeader;
class CL_ListView_Impl;
class CL_ListViewIconList;
class CL_InputEvent;

class CL_API_GUI CL_ListView : public CL_GUIComponent
{

public:

        CL_ListView(CL_GUIComponent *parent);

        virtual ~CL_ListView();


public:

        CL_ListViewHeader *get_header() const;

        CL_ListViewItem get_document_item() const;

        bool get_select_whole_row() const;

        CL_ListViewIconList get_icon_list() const;

        CL_ListViewSelection get_selected_items() const;

        CL_ListViewItem get_selected_item();

        CL_Size get_preferred_size() const;

        CL_ListViewDisplayMode get_display_mode() const;


public:

        CL_ListViewItem create_item();

        void on_process_message(CL_GUIMessage &msg);

        void set_select_whole_row(bool value);

        void set_multi_select(bool value);

        void set_display_mode(CL_ListViewDisplayMode mode);

        void clear();

        void clear_selection();

        void set_selected(CL_ListViewItem &item, bool selected=true);

        CL_ListViewItem find(const CL_StringRef &col_id, const CL_StringRef &str, bool recursive=true);

        CL_ListViewItem find(int id, bool recursive=true);

        CL_ListViewItem find(CL_UnknownSharedPtr userdata, bool recursive=true);


public:
        CL_Callback_v1<CL_ListViewSelection> &func_selection_changed();

        CL_Callback_2<bool, CL_ListViewItem, CL_String &> &func_item_edited();

        CL_Callback_v1<CL_InputEvent> &func_key_pressed();

        CL_Callback_v1<CL_InputEvent> &func_key_released();

        CL_Callback_v1<CL_Point> &func_mouse_right_up();


private:
        CL_SharedPtr<CL_ListView_Impl> impl;

        friend class CL_ListViewRenderer;
};

---