ui/ui/container.h

   1 /*
   2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   3  *
   4  * Copyright 2017 Olaf Wintermann. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are met:
   8  *
   9  *   1. Redistributions of source code must retain the above copyright
  10  *      notice, this list of conditions and the following disclaimer.
  11  *
  12  *   2. Redistributions in binary form must reproduce the above copyright
  13  *      notice, this list of conditions and the following disclaimer in the
  14  *      documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  * POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef UI_CONTAINER_H
  30 #define UI_CONTAINER_H
  31
  32 #include "toolkit.h"
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 #define UI_CTN(obj, ctn) for(ctn;ui_container_finish(obj);ui_container_begin_close(obj))
  39 #define UI_VBOX(obj) for(ui_vbox(obj);ui_container_finish(obj);ui_container_begin_close(obj))
  40 #define UI_HBOX(obj) for(ui_hbox(obj);ui_container_finish(obj);ui_container_begin_close(obj))
  41 #define UI_VBOX_SP(obj, margin, spacing) for(ui_vbox_sp(obj,margin,spacing);ui_container_finish(obj);ui_container_begin_close(obj))
  42 #define UI_HBOX_SP(obj, margin, spacing) for(ui_hbox_sp(obj,margin,spacing);ui_container_finish(obj);ui_container_begin_close(obj))
  43 #define UI_GRID(obj) for(ui_grid(obj);ui_container_finish(obj);ui_container_begin_close(obj))
  44 #define UI_GRID_SP(obj, margin, columnspacing, rowspacing) for(ui_grid_sp(obj,margin,columnspacing,rowspacing);ui_container_finish(obj);ui_container_begin_close(obj))
  45
  46 void ui_end(UiObject *obj);
  47
  48 UIWIDGET ui_vbox(UiObject *obj);
  49 UIWIDGET ui_hbox(UiObject *obj);
  50 UIWIDGET ui_vbox_sp(UiObject *obj, int margin, int spacing);
  51 UIWIDGET ui_hbox_sp(UiObject *obj, int margin, int spacing);
  52
  53 UIWIDGET ui_grid(UiObject *obj);
  54 UIWIDGET ui_grid_sp(UiObject *obj, int margin, int columnspacing, int rowspacing);
  55
  56 UIWIDGET ui_scrolledwindow(UiObject *obj);
  57
  58 UIWIDGET ui_sidebar(UiObject *obj);
  59
  60 UIWIDGET ui_hsplitpane(UiObject *obj, int max);
  61 UIWIDGET ui_vsplitpane(UiObject *obj, int max);
  62
  63 UIWIDGET ui_tabview(UiObject *obj);
  64 void ui_tab(UiObject *obj, char *title);
  65 void ui_select_tab(UIWIDGET tabview, int tab);
  66
  67 // box container layout functions
  68 void ui_layout_fill(UiObject *obj, UiBool fill);
  69 // grid container layout functions
  70 void ui_layout_hexpand(UiObject *obj, UiBool expand);
  71 void ui_layout_vexpand(UiObject *obj, UiBool expand);
  72 void ui_layout_width(UiObject *obj, int width);
  73 void ui_layout_gridwidth(UiObject *obj, int width);
  74 void ui_newline(UiObject *obj);
  75
  76
  77 UiTabbedPane* ui_tabbed_document_view(UiObject *obj);
  78
  79 UiObject* ui_document_tab(UiTabbedPane *view);
  80
  81
  82 /* used for macro */
  83 void ui_container_begin_close(UiObject *obj);
  84 int ui_container_finish(UiObject *obj);
  85
  86
  87 #ifdef __cplusplus
  88 }
  89 #endif
  90
  91 #endif /* UI_CONTAINER_H */
  92