Open Search
    IconData Struct Reference

    #include <operatingsystem.h>

    Detailed Description

    Represents a single icon in a large bitmap array.

    Public Attributes

    BaseBitmapbmp
     
    Int32 x
     
    Int32 y
     
    Int32 w
     
    Int32 h
     
    ICONDATAFLAGS flags
     

    Constructors

     IconData ()
     
     IconData (BaseBitmap *t_bmp, Int32 t_x, Int32 t_y, Int32 t_w, Int32 t_h)
     

    Part

    BaseBitmapGetClonePart () const
     
    BaseBitmapGetGuiScalePart () const
     

    GUI Scale

    Int32 GetGuiW () const
     
    Int32 GetGuiH () const
     

    Constructor & Destructor Documentation

    ◆ IconData() [1/2]

    IconData ( )

    Default constructor.

    ◆ IconData() [2/2]

    IconData ( BaseBitmap t_bmp,
    Int32  t_x,
    Int32  t_y,
    Int32  t_w,
    Int32  t_h 
    )

    Fills the icon data.

    Parameters
    [in]t_bmpThe bitmap. The caller owns the pointed base bitmap.
    [in]t_xThe X coordinate of the upper-left corner of the icon.
    [in]t_yThe Y coordinate of the upper-left corner of the icon.
    [in]t_wThe width of the icon.
    [in]t_hThe height of the icon.

    Member Function Documentation

    ◆ GetClonePart()

    BaseBitmap* GetClonePart ( ) const

    Gets a copy of the bitmap's part for the icon data.

    See also
    BaseBitmap::GetClonePart
    Returns
    The copy of the icon part.

    ◆ GetGuiScalePart()

    BaseBitmap* GetGuiScalePart ( ) const

    Gets a copy of the scaled bitmap's part for the icon data with the size /@ref GetGuiH().

    Returns
    The copy of the scaled icon part.

    ◆ GetGuiW()

    Int32 GetGuiW ( ) const

    Gets the GUI scaled width of the icon data.

    Returns
    The GUI scaled width.

    ◆ GetGuiH()

    Int32 GetGuiH ( ) const

    Gets the GUI scaled height of the icon data.

    Returns
    The GUI scaled height.

    Member Data Documentation

    ◆ bmp

    BaseBitmap* bmp

    The bitmap. Can be nullptr.

    ◆ x

    Int32 x

    The X coordinate of the upper-left corner of the icon.

    ◆ y

    Int32 y

    The Y coordinate of the upper-left corner of the icon.

    ◆ w

    Int32 w

    The width of the icon.

    ◆ h

    Int32 h

    The height of the icon.

    ◆ flags

    The flags: ICONDATAFLAGS.