查看源代码 wxImageList (wx v2.4.3)

wxImageList 包含一个图像列表,这些图像以未指定的形式存储。

图像可以有用于透明绘制的蒙版,并且可以从各种来源创建,包括位图和图标。

wxImageList 主要与 wxTreeCtrlwxListCtrl 类一起使用。

参见

wxWidgets 文档: wxImageList

概要

函数

使用图标添加新图像。

使用位图和蒙版颜色添加一个或多个新图像。

初始化列表。

销毁对象

将指定的图像绘制到设备上下文中。

返回与给定索引对应的位图。

返回与给定索引对应的图标。

返回列表中的图像数量。

检索列表中图像的大小。

默认构造函数。

构造函数,指定图像大小、是否应创建图像蒙版以及列表的初始大小。

删除给定位置的图像。

删除列表中的所有图像。

用新图像替换现有图像。

用新图像替换现有图像。

类型

-type wxImageList() :: wx:wx_object().

函数

-spec add(This, Icon) -> integer()
             when This :: wxImageList(), Icon :: wxIcon:wxIcon() | wxBitmap:wxBitmap().

使用图标添加新图像。

返回:新的从零开始的图像索引。

备注:原始位图或图标不受 add/3 操作的影响,之后可以删除。如果位图比列表中的图像宽,则位图会自动分割成较小的图像,每个图像都与图像列表的尺寸相匹配。这不适用于添加图标。

仅适用于:wxmsw,wxosx

-spec add(This, Bitmap, Mask) -> integer()
             when This :: wxImageList(), Bitmap :: wxBitmap:wxBitmap(), Mask :: wxBitmap:wxBitmap();
         (This, Bitmap, MaskColour) -> integer()
             when This :: wxImageList(), Bitmap :: wxBitmap:wxBitmap(), MaskColour :: wx:wx_colour().

使用位图和蒙版颜色添加一个或多个新图像。

返回:新的从零开始的图像索引。

备注:原始位图或图标不受 add/3 操作的影响,之后可以删除。如果位图比列表中的图像宽,则位图会自动分割成较小的图像,每个图像都与图像列表的尺寸相匹配。这不适用于添加图标。

链接到此函数

create(This, Width, Height)

查看源代码
-spec create(This, Width, Height) -> boolean()
                when This :: wxImageList(), Width :: integer(), Height :: integer().

等效于 create(This, Width, Height, [])

-spec create(This, Width, Height, [Option]) -> boolean()
                when
                    This :: wxImageList(),
                    Width :: integer(),
                    Height :: integer(),
                    Option :: {mask, boolean()} | {initialCount, integer()}.

初始化列表。

有关详细信息,请参见 new/3

-spec destroy(This :: wxImageList()) -> ok.

销毁对象

链接到此函数

draw(This, Index, Dc, X, Y)

查看源代码
-spec draw(This, Index, Dc, X, Y) -> boolean()
              when
                  This :: wxImageList(),
                  Index :: integer(),
                  Dc :: wxDC:wxDC(),
                  X :: integer(),
                  Y :: integer().

等效于 draw(This, Index, Dc, X, Y, [])

-spec draw(This, Index, Dc, X, Y, [Option]) -> boolean()
              when
                  This :: wxImageList(),
                  Index :: integer(),
                  Dc :: wxDC:wxDC(),
                  X :: integer(),
                  Y :: integer(),
                  Option :: {flags, integer()} | {solidBackground, boolean()}.

将指定的图像绘制到设备上下文中。

链接到此函数

getBitmap(This, Index)

查看源代码
-spec getBitmap(This, Index) -> wxBitmap:wxBitmap() when This :: wxImageList(), Index :: integer().

返回与给定索引对应的位图。

-spec getIcon(This, Index) -> wxIcon:wxIcon() when This :: wxImageList(), Index :: integer().

返回与给定索引对应的图标。

-spec getImageCount(This) -> integer() when This :: wxImageList().

返回列表中的图像数量。

-spec getSize(This, Index) -> Result
                 when
                     Result :: {Res :: boolean(), Width :: integer(), Height :: integer()},
                     This :: wxImageList(),
                     Index :: integer().

检索列表中图像的大小。

目前,index 参数被忽略,因为列表中所有图像的大小都相同。

返回:如果函数成功则返回 true,如果失败则返回 false(例如,如果图像列表尚未初始化)。

-spec new() -> wxImageList().

默认构造函数。

-spec new(Width, Height) -> wxImageList() when Width :: integer(), Height :: integer().

等效于 new(Width, Height, [])

链接到此函数

new(Width, Height, Options)

查看源代码
-spec new(Width, Height, [Option]) -> wxImageList()
             when
                 Width :: integer(),
                 Height :: integer(),
                 Option :: {mask, boolean()} | {initialCount, integer()}.

构造函数,指定图像大小、是否应创建图像蒙版以及列表的初始大小。

参见:create/4

-spec remove(This, Index) -> boolean() when This :: wxImageList(), Index :: integer().

删除给定位置的图像。

-spec removeAll(This) -> boolean() when This :: wxImageList().

删除列表中的所有图像。

链接到此函数

replace(This, Index, Icon)

查看源代码
-spec replace(This, Index, Icon) -> boolean()
                 when
                     This :: wxImageList(),
                     Index :: integer(),
                     Icon :: wxIcon:wxIcon() | wxBitmap:wxBitmap().

用新图像替换现有图像。

返回:如果替换成功则返回 true,否则返回 false。

备注:原始位图或图标不受 replace/4 操作的影响,之后可以删除。

仅适用于:wxmsw,wxosx

链接到此函数

replace(This, Index, Bitmap, Mask)

查看源代码
-spec replace(This, Index, Bitmap, Mask) -> boolean()
                 when
                     This :: wxImageList(),
                     Index :: integer(),
                     Bitmap :: wxBitmap:wxBitmap(),
                     Mask :: wxBitmap:wxBitmap().

用新图像替换现有图像。

仅限 Windows。

返回:如果替换成功则返回 true,否则返回 false。

备注:原始位图或图标不受 replace/4 操作的影响,之后可以删除。