AGW Logo

agw_title ImageInfo

This class holds all the information (caption, image, etc...) belonging to a single tab in LabelBook.

hierarchy Inheritance Diagram

Inheritance diagram for: ImageInfo

Inheritance diagram of ImageInfo


method_summary Methods Summary

__init__Default class constructor.
EnableTabSets the tab enabled or disabled.
GetCaptionReturns the tab caption.
GetEnabledReturns whether the tab is enabled or not.
GetImageIndexReturns the tab image index.
GetPositionReturns the tab position.
GetSizeReturns the tab size.
GetTextRectReturns the client rectangle available for the tab text.
SetCaptionSets the tab caption.
SetImageIndexSets the tab image index.
SetPositionSets the tab position.
SetSizeSets the tab size.
SetTextRectSets the client rectangle available for the tab text.

API Class API

class ImageInfo(object)[source]

This class holds all the information (caption, image, etc...) belonging to a single tab in LabelBook.



__init__(strCaption='', imageIndex=-1, enabled=True)[source]

Default class constructor.

Parameters:
  • strCaption – the tab caption;
  • imageIndex – the tab image index based on the assigned (set) wx.ImageList (if any);
  • enabled – sets the tab as enabled or disabled.


EnableTab(enabled)[source]

Sets the tab enabled or disabled.

Parameters:enabledTrue to enable a tab, False to disable it.


GetCaption()[source]

Returns the tab caption.



GetEnabled()[source]

Returns whether the tab is enabled or not.



GetImageIndex()[source]

Returns the tab image index.



GetPosition()[source]

Returns the tab position.



GetSize()[source]

Returns the tab size.



GetTextRect()[source]

Returns the client rectangle available for the tab text.



SetCaption(value)[source]

Sets the tab caption.

Parameters:value – the new tab caption.


SetImageIndex(value)[source]

Sets the tab image index.

Parameters:value – an index into the image list..


SetPosition(value)[source]

Sets the tab position.

Parameters:value – the new tab position, an instance of wx.Point.


SetSize(value)[source]

Sets the tab size.

Parameters:value – the new tab size, an instance of wx.Size.


SetTextRect(rect)[source]

Sets the client rectangle available for the tab text.

Parameters:rect – the tab text client rectangle, an instance of wx.Rect.
Tree

Table Of Contents

Previous topic

ImageContainerBase

Next topic

ImageNotebookEvent