/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2017 Olaf Wintermann. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef UI_TREE_H
#define UI_TREE_H
#include "toolkit.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef struct UiModel UiModel;
typedef struct UiListCallbacks UiListCallbacks;
typedef struct UiListDnd UiListDnd;
typedef struct UiListArgs UiListArgs;
typedef struct UiSourceListArgs UiSourceListArgs;
typedef struct UiSubList UiSubList;
typedef struct UiSubListItem UiSubListItem;
typedef enum UiModelType {
UI_STRING = 0,
UI_STRING_FREE,
UI_INTEGER,
UI_ICON,
UI_ICON_TEXT,
UI_ICON_TEXT_FREE
} UiModelType;
struct UiModel {
/*
* number of columns
*/
int columns;
/*
* array of column types
* array length is the number of columns
*/
UiModelType *types;
/*
* array of column titles
* array length is the number of columns
*/
char **titles;
/*
* array of column size hints
*/
int *columnsize;
/*
* function for translating model data to view data
* first argument is the pointer returned by UiList->get or UiTree->get
* second argument is the column index
* TODO: return
*/
void*(*getvalue)(void*, int);
};
struct UiListCallbacks {
/*
* selection callback
*/
ui_callback activate;
/*
* cursor callback
*/
ui_callback selection;
/*
* userdata for all callbacks
*/
void *userdata;
};
struct UiListArgs {
UiTri fill;
UiBool hexpand;
UiBool vexpand;
UiBool hfill;
UiBool vfill;
int colspan;
int rowspan;
const char *name;
const char *style_class;
UiList* list;
const char* varname;
UiModel* model;
ui_getvaluefunc getvalue;
ui_callback onactivate;
void* onactivatedata;
ui_callback onselection;
void* onselectiondata;
ui_callback ondragstart;
void* ondragstartdata;
ui_callback ondragcomplete;
void* ondragcompletedata;
ui_callback ondrop;
void* ondropsdata;
UiBool multiselection;
UiMenuBuilder *contextmenu;
const int *groups;
};
typedef void (*ui_sublist_getvalue_func)(void *sublist_userdata, void *rowdata, int index, UiSubListItem *item);
struct UiSubList {
UiList *value;
const char *varname;
const char *header;
UiBool separator;
void *userdata;
};
/*
* list item members must be filled by the sublist getvalue func
* all members must be allocated (by malloc, strdup, ...) the pointer
* will be passed to free
*/
struct UiSubListItem {
char *icon;
char *label;
char *button_icon;
char *button_label;
char *badge;
void *eventdata;
};
struct UiSourceListArgs {
UiTri fill;
UiBool hexpand;
UiBool vexpand;
UiBool hfill;
UiBool vfill;
int colspan;
int rowspan;
const char *name;
const char *style_class;
const int *groups;
/*
* list of sublists
* a sublist must have a varname or a value
*
* the last entry in the list must contain all NULL values or numsublists
* must contain the number of sublists
*/
UiSubList *sublists;
/*
* optional number of sublists
* if the value is 0, it is assumed, that sublists is null-terminated
* (last item contains only NULL values)
*/
size_t numsublists;
/*
* callback for each list item, that should fill all necessary
* UiSubListItem fields
*/
ui_sublist_getvalue_func getvalue;
/*
* activated when a list item is selected
*/
ui_callback onactivate;
void *onactivatedata;
/*
* activated, when the additional list item button is clicked
*/
ui_callback onbuttonclick;
void *onbuttonclickdata;
};
#define UI_SUBLIST(...) (UiSubList){ __VA_ARGS__ }
#define UI_SUBLISTS(...) (UiSubList[]){ __VA_ARGS__, (UiSubList){NULL,NULL,NULL,0} }
UIEXPORT UiModel* ui_model(UiContext *ctx, ...);
UIEXPORT UiModel* ui_model_copy(UiContext *ctx, UiModel* model);
UIEXPORT void ui_model_free(UiContext *ctx, UiModel *mi);
#define ui_listview(obj, ...) ui_listview_create(obj, (UiListArgs) { __VA_ARGS__ } )
#define ui_table(obj, ...) ui_table_create(obj, (UiListArgs) { __VA_ARGS__ } )
#define ui_combobox(obj, ...) ui_combobox_create(obj, (UiListArgs) { __VA_ARGS__ } )
#define ui_breadcrumbbar(obj, ...) ui_breadcrumbbar_create(obj, (UiListArgs) { __VA_ARGS__ } )
#define ui_sourcelist(obj, ...) ui_sourcelist_create(obj, (UiSourceListArgs) { __VA_ARGS__ } )
UIEXPORT UIWIDGET ui_listview_create(UiObject* obj, UiListArgs args);
UIEXPORT UIWIDGET ui_table_create(UiObject* obj, UiListArgs args);
UIEXPORT UIWIDGET ui_combobox_create(UiObject* obj, UiListArgs args);
UIEXPORT UIWIDGET ui_breadcrumbbar_create(UiObject* obj, UiListArgs args);
UIEXPORT UIWIDGET ui_sourcelist_create(UiObject *obj, UiSourceListArgs args);
#ifdef __cplusplus
}
#endif
#endif /* UI_TREE_H */