diguyViewButtonPanel.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2019 VT MAK
 ** All rights reserved. 
 *********************************************************************/

/*********************************************************************
 **
 *t  diguyViewButtonPanel
 **
 *b    Link against: libdiguy
 */

#ifndef __diguyViewButtonPanel_H
#define __diguyViewButtonPanel_H

#ifdef SWIG
%module diguyViewButtonPanel
#else
#define CPLUSPLUS_ONLY
#endif

#ifdef CPLUSPLUS_ONLY
class bdiViewButtonPanel;
#include <declspec_diguy.h>
// for NULL
#include <stdlib.h>

typedef bdiViewButtonPanel* makeButtonPanelCallback(const char* name,
        int horizontal,
        int title);

#endif


/****************************************************************************/
class BDI_DECLSPEC_diguy diguyViewButtonPanel
{

public:

        /*l
         *b  Description:
         **
         **    Returns the named button panel or creates it.
         **
         *b  Arguments:
         **
         *a    name        - name of panel (must be unique)
         *a    horizontal  - if 1, make a horizontal panel
         *a    title       - if 1, show panel title
         **
         *b  Returns:
         **
         **    pointer to the button panel
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        static diguyViewButtonPanel* find_or_create_instance(const char* name,
                int horizontal = 0,
                int title = 1);

        /*l
         *b  Description:
         **
         **    Makes a button panel with the given name and attributes.
         **
         *b  Arguments:
         **
         *a    name        - name of panel (must be unique)
         *a    horizontal  - if 1, make a horizontal panel
         *a    title       - if 1, show panel title
         **
         *b  Returns:
         **
         **    pointer to the button panel
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        static diguyViewButtonPanel* make_instance(const char* name,
                int horizontal = 0,
                int title = 1);

        /*l
         *b  Description:
         **
         **    Returns a pointer to the named button panel, if it exists.
         *     Otherwise returns NULL.
         **
         *b  Arguments:
         **
         *a    name - name of panel
         **
         *b  Returns:
         **
         **    pointer to the button panel or NULL
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        static diguyViewButtonPanel* get_instance(const char* name);

        /*l
         *b  Description:
         **
         **    Destroys named button panel, if found.
         **
         *b  Arguments:
         **
         *a    name  - name of panel
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        static int destroy_instance(const char* name);

        /*l
         *b  Description:
         **
         **    Destroys all button panels.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        static int destroy_all();

        /*l
         *b  Description:
         **
         **    Returns the name of the object.  This pointer will never be NULL.
         **
         *b  Returns:
         **
         **    name of the object
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_name();

        /*l
         *b  Description:
         **
         **    Returns the x and y coordinate of the panel.
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int get_position(int* ret_x, int* ret_y);

        /*l
         *b  Description:
         **
         **    Returns the width of the panel
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int get_width();

        /*l
         *b  Description:
         **
         **    Returns the height of the panel
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int get_height();

        /*l
         *b  Description:
         **
         **    Makes button panel visible or invisible.
         **
         *b  Arguments:
         **
         *a    visible - pass 1 to make visible, 0 to make invisible
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_visible(int visible);

        /*l
         *b  Description:
         **
         **    Makes button panel minimized (or un-minimized).
         **
         *b  Arguments:
         **
         *a    visible - pass 1 to make minimized, 0 to make full size
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_minimized_state(int minimized);

        /*l
         *b  Description:
         **
         **    Sets the position of the panel in its parent window.  Coordinates
         **    work differently if panel is right/bottom justified on its x/y
         **    (see set_justification()).  In that case, the coordinate will
         **    imply the position of the panel's right/bottom edge relative to
         **    the right/bottom edge of the containing window.
         **
         *b  Arguments:
         **
         *a    x - x position, in pixels
         *a    y - y position, in pixels
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_position(int x, int y);

        /*l
         *b  Description:
         **
         **    Sets the desired dimensions of the panel.
         **
         *b  Arguments:
         **
         *a    w  - width, in pixels
         *a    h  - height, in pixels
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_dimensions(int w, int h);

        /*l
         *b  Description:
         **
         **    Sets the desired z depth of the panel.
         **
         *b  Arguments:
         **
         *a    z - depth
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_depth(int z);

        /*l
         *b  Description:
         **
         **    Sets the horizontal/vertical justifications of the panel (see
         **    description in set_position()).
         **
         *b  Arguments:
         **
         *a    h  - horizontal justification (> 0 for left, 0 for center, < 0 for right)
         *a    v  - vertical justification (> 0 for top, 0 for center, < 0 for bottom)
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_justifications(int h, int v);

        /*l
         *b  Description:
         **
         **    Sets the spacing between items in panel.
         **
         *b  Arguments:
         **
         *a    spacing  - spacing in pixels
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_spacing(int spacing);

        /*l
         *b  Description:
         **
         **    Sets the display title of the panel.
         **
         *b  Arguments:
         **
         *a    title  - text to show
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_title(const char* title);

        /*l
         *b  Description:
         **
         **    Adds a button to the panel and specifies the lua script that should
         **    be run upon press.
         **
         *b  Arguments:
         **
         *a    name              - text of button
         *a    lua_object_name   - name of lua table containing function to run
         *a    lua_function_name - name of lua function to run
         *a    style_sheet       - optional css to set on button
         **
         **    An example style sheet string:
         **    "QPushButton {background-color : rgba( 192, 210, 192, 192 );     }"
         **
         *b  Returns:
         **
         **    index of the new button (zero-indexed)
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int add_button(const char* name,
                const char* lua_object_name,
                const char* lua_function_name,
                const char* style_sheet = NULL);

        /*l
         *b  Description:
         **
         **    Adds a button to the panel and specifies the lua script that
         **    should be run upon press.
         **
         *b  Arguments:
         **
         *a    name         - text of button
         *a    script       - Lua script to run (the script itself)
         *a    style_sheet  - optional css to set on button
         **
         **    An example style sheet string:
         **    "QPushButton {background-color : rgba( 192, 210, 192, 192 );     }"
         **
         *b  Returns:
         **
         **    index of the new button (zero-indexed)
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int     add_button_with_script(const char* name, const char* script,
                const char* style_sheet = NULL);

        /*l
         *b  Description:
         **
         **    Sets the name (text) of button at index n (zero-indexed).
         **
         *b  Arguments:
         **
         *a    index  - index of button (starting from 0)
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_button_name(int index, const char* name);

        /*l
         *b  Description:
         **
         **    Sets whether or not the specified button will be a toggle button.
         **    A toggle button can be clicked back and forth between an on and
         **    off state, whereas a regular button provides only a once-off
         **    action.
         **
         *b  Arguments:
         **
         *a    index       - index of button (starting from 0)
         *a    can_toggle  - true if toggle button
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_allow_toggle(int index, int can_toggle);

        /*l
         *b  Description:
         **
         **    Sets the specified button to be the "selected" one within the
         **    panel.  The selected button may have a special appearance
         **    depending on style sheet.  See notes for set_style_sheet().
         **
         *b  Arguments:
         **
         *a    index   - index of button (starting from 0)
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_selected_button(int index);

        /*l
         *b  Description:
         **
         **    Similar to set_selected_button(), but using button name (text).
         **
         *b  Arguments:
         **
         *a    name  - name (text) of button
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_selected_button_by_name(const char* name);

        /*l
         *b  Description:
         **
         **    Adds an integer slider to the panel and specifies the lua script
         **    that should be run upon the slider changing value.  lua function
         **    should be:
         **
         *e    function lua_object_name:lua_function_name(value)
         **
         *b  Arguments:
         **
         *a    name              - text of label description
         *a    lua_object_name   - name of lua table containing function to run
         *a    lua_function_name - name of lua function to run
         **
         *b  Returns:
         **
         **    index of the new slider (zero-indexed)
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int add_int_slider(const char* name,
                const char* lua_object_name,
                const char* lua_function_name,
                int init_val,
                int min_val,
                int max_val,
                const char* style_sheet = NULL);

        /*l
         *b  Description:
         **
         **    Adds a continuous floating slider to the panel and specifies the
         **    lua script that should be run upon the slider changing value.  lua
         **    function should be:
         **
         *e    function lua_object_name:lua_function_name(value)
         **
         *b  Arguments:
         **
         *a    name              - text of label description
         *a    lua_object_name   - name of lua table containing function to run
         *a    lua_function_name - name of lua function to run
         **
         *b  Returns:
         **
         **    index of the new slider (zero-indexed)
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int add_float_slider(const char* name,
                const char* lua_object_name,
                const char* lua_function_name,
                float init_val,
                float min_val,
                float max_val,
                const char* style_sheet = NULL);

        /*l
         *b  Description:
         **
         **    Updates specified slider with the value specified.
         **
         *b  Arguments:
         **
         *a    name  - name of slider
         *a    value - value of slider
         */
        int set_slider_value(const char* name, float value);

        /*l
         *b  Description:
         **
         **    Adds a vertical or horizontal spacer element.
         **
         */
        int add_spacer(int pixels);

        /*l
         *b  Description:
         **
         **    Change visibility of item specified by index
         **
         */
        void set_item_visibility(int index, bool visible);

        /*l
         *b  Description:
         **
         **    Clears all items out of panel
         **
         */
        void remove_all_items();

        /*l
         *b  Description:
         **
         **    Sets a Lua script to be called when panel is opened (un-minimized).
         **
         *b  Arguments:
         **
         *a    lua_script  - the entire script
         */
        void set_open_script(const char* lua_script);

        /*l
         *b  Description:
         **
         **    Sets a Lua script to be called when panel is opened (un-minimized).
         **
         *b  Arguments:
         **
         *a    lua_script  - the entire script
         */
        void set_minimize_script(const char* lua_script);

        /*l
         *b  Description:
         **
         **    Passes a Qt style sheet to the panel.
         **
         **    Sample one (user must replace "MAIN_BG_COLOR" and other tags with
         **    meaningful values):
         **
         *b    Note:
         **
         **        "isSelected" used to set visual properties of selected button
         **
         **    ----------------
         *e          basic_style = [[
         *e            * {
         *e                          background-color : rgba( 192, 192, 192, 192 );
         *e                          color : white;
         *e            }
         *e        QFrame#m_button_frame {
         *e                    background-color : MAIN_BG_COLOR;
         *e            }
         *e            QLabel#m_title_label {
         *e                    color : white;
         *e            }
         *e            QPushButton {
         *e                    color : BUTTON_TEXT_COLOR;
         *e                          background-color : BUTTON_BG_COLOR;
         *e                  }
         *e                  QPushButton[isSelected="true"] {
         *e                    color : BUTTON_SELECTED_TEXT_COLOR;
         *e                    background-color : BUTTON_SELECTED_BG_COLOR;
         *e            }
         *e      ]];
         **
         **    Sample two (user must replace "MAIN_BG_COLOR" and other tags with
         **    meaningful values):
         **
         **    Note:
         **
         **       "isToggled" used to set visual properties on button that is
         **       toggled on
         **
         **    ----------------
         *e          basic_style = [[
         *e            * {
         *e                          background-color : rgba( 192, 192, 192, 192 );
         *e                          color : white;
         *e            }
         *e        QFrame#m_button_frame {
         *e                    background-color : MAIN_BG_COLOR;
         *e            }
         *e            QLabel#m_title_label {
         *e                    color : white;
         *e            }
         *e            QPushButton {
         *e                    color : BUTTON_TEXT_COLOR;
         *e                          background-color : BUTTON_BG_COLOR;
         *e                  }
         *e                  QPushButton[isToggled="true"] {
         *e                    color : BUTTON_TOGGLED_TEXT_COLOR;
         *e                    background-color : BUTTON_TOGGLED_BG_COLOR;
         *e            }
         *e      ]];
         **
         *b  Arguments:
         **
         *a    sheet  - the style sheet
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_style_sheet(const char* sheet);


/****************************************************************************/
/****************************************************************************/

#ifdef CPLUSPLUS_ONLY
        friend class bdiViewButtonPanel;

        bdiViewButtonPanel* get_scripted_object() {return m_panel;}

        static void set_create_callback(makeButtonPanelCallback* the_callback);

private:

        /*l
         **    A private constructor.
         */
        diguyViewButtonPanel(bdiViewButtonPanel* panel);

        /*l
         **    A private destructor.
         */
        ~diguyViewButtonPanel();

protected:

        /*l
         **    A pointer to internal data.
         */
        bdiViewButtonPanel* m_panel;

#endif

};

#endif //__diguyViewButtonPanel_H