TGUI Description for drawing properties

Issue #162 new
Patryk Kubiak created an issue

Prepare description in doxygen for TGUI functionality - drawing properties. It includes:

  • Description of the function oC_TGUI_DrawProperties
  • Description of the types:
typedef struct
{
    oC_TGUI_Position_t              StartPosition;
    oC_TGUI_Column_t                Width;
    oC_TGUI_Line_t                  Height;
    oC_TGUI_Column_t                DescriptionWidth;
    const oC_TGUI_Property_t *      Properties;
    oC_TGUI_EntryIndex_t            NumberOfProperties;
    const oC_TGUI_PropertyStyle_t * Style;
} oC_TGUI_DrawPropertyConfig_t;

typedef struct
{
    const char *        Description;
    const char *        Format;
    oC_TGUI_ValueType_t Type;
    union
    {
        oC_UInt_t           ValueUINT;
        uint32_t            ValueU32;
        uint64_t            ValueU64;
        int32_t             ValueI32;
        int64_t             ValueI64;
        float               ValueFloat;
        double              ValueDouble;
        char                ValueChar;
        const char *        ValueString;
    };
} oC_TGUI_Property_t;

typedef struct
{
    oC_TGUI_Style_t     DescriptionStyle;
    oC_TGUI_Style_t     ValueStyle;
} oC_TGUI_PropertyStyle_t;

typedef enum
{
    oC_TGUI_ValueType_UINT ,       //!< Value of type oC_UInt_t
    oC_TGUI_ValueType_U32 ,        //!< Value of type uint32_t
    oC_TGUI_ValueType_U64 ,        //!< Value of type uint64_t
    oC_TGUI_ValueType_I32 ,        //!< Value of type int32_t
    oC_TGUI_ValueType_I64 ,        //!< Value of type int64_t
    oC_TGUI_ValueType_ValueFloat , //!< Value of type float
    oC_TGUI_ValueType_ValueDouble ,//!< Value of type double
    oC_TGUI_ValueType_ValueChar ,  //!< Value of type char
    oC_TGUI_ValueType_ValueString ,//!< Value of type string
} oC_TGUI_ValueType_t;
  • Prepare example of usage
  • Description of the drawing property functionality in the TGUI module description

Comments (1)

  1. Log in to comment