BCGControlBar Pro for MFC
CBCGPWinUITile

Detailed Description

Represents an individual Win UI-style tile object

A CBCGPWinUITile object includes a various tile attributes such as name, badge (both numeric and iconic), header, multiline text and image. The tile can be created as "regular" (square shape) or "wide" (double width rectangle).

The following code demonstrates how to create a single tile object:

Copy
CBCGPWinUITile* pTile = new CBCGPWinUITile(_T("Name"),
TRUE /* Is wide */,
CBCGPColor::White, /* Text color */,
CBCGPBrush(color, colorLight, CBCGPBrush::BCGP_GRADIENT_VERTICAL) /* Fill brush */);
pTile->SetImage(CBCGPImage(IDB_TILE_ICON)); // Add icon
pTile->SetBorderColor(colorLight);
pMUI->Add(pTile, nGroup);
+ Inheritance diagram for CBCGPWinUITile:

Public Types

enum  BCGP_WINUI_BADGE_GLYPH
 
enum  BCGP_WINUI_IMAGE_ALIGNMENT
 
enum  BCGP_WINUI_IMAGE_EFFECT
 
enum  BCGP_WINUI_TILE_TYPE
 
- Public Types inherited from CBCGPAnimationManager
enum  BCGPAnimationType
 

Public Member Functions

 CBCGPWinUITileConstructs CBCGPWinUITile object
 
 CBCGPWinUITileConstructs CBCGPWinUITile object
 
 ClearBadgeClears the tile badge
 
 DoDrawCalled by the framework to draw the tile content
 
 GetBackgroundBrushReturns the tile background brush
 
 GetBadgeGlyphReturns tile badge glyph
 
 GetBadgeNumberReturns the tile badge numeric value
 
 GetBorderColorReturns the tile border color
 
 GetBorderWidthReturns the tile border width
 
 GetCustomBadgeIndexGets custom badge index.
 
 GetGroupIDReturns the tile group ID
 
 GetHeaderReturns the tile header
 
 GetImageReturns the tile image (icon)
 
 GetImageVertAlignRetrivies the image vertical alignment.
 
 GetTextReturns the tile text
 
 SetBackgroundBrushSpecifies the tile background brush
 
 SetBadgeGlyphSpecifies the tile badge glyph
 
 SetBadgeNumberSpecifies tile badge numeric value
 
 SetBorderColorSpecifies the tile border color
 
 SetBorderWidthSets a tile border width
 
 SetCustomBadgeIndexSets custom badge index.
 
 SetHeaderSpecifies the tile header
 
 SetImageSpecifies the tile image (icon)
 
 SetImageVertAlignSpecifies the image vertical alignment.
 
 SetTextSpecifies the tile text
 
- Public Member Functions inherited from CBCGPWinUIBaseObject
 CreateViewCalled by the framework to create a custom view associated with the tile.
 
 GetNameReturns the tile name
 
 GetRectReturns the tile bounding rectangle
 
 GetTextColorReturns the tile foreground color
 
 GetToolTipDescriptionReturns the tile tooltip description
 
 GetToolTipTextReturns the tile tooltip text
 
 GetUserDataReturns user data associated with the tile
 
 GetViewResIDGets view resource identifier (BCGP_VISUAL_XML resource type).
 
 GetViewRuntimeClassGets view runtime class.
 
 GetViewTitleGets view title.
 
 IsVisibleTells whether the tile is visible.
 
 RedrawRedraws the tile.
 
 SetNameChanges the tile name
 
 SetTextColorChanges the tile foreground color
 
 SetToolTipDescriptionChanges the tile tooltip description
 
 SetToolTipTextChanges the tile tooltip text
 
 SetUserDataAssociates user data with the tile
 
 SetViewAssociates a view with the tile.
 
 SetVisibleShows or hides the tile.
 
- Public Member Functions inherited from CBCGPAnimationManager
 CBCGPAnimationManagerDefault constructor.
 
 GetAnimatedValueGets current animated value.
 
 GetAnimationDurationGets animation duration.
 
 GetLastAnimationErrorGets the animation error returned by recent call to Windows Animation API.
 
 IsAnimatedChecks if animation is running.
 
 StartAnimationStarts an animation.
 
 StartFlashAnimationStarts "flash" animation.
 
 StopAnimationStops an animation.
 

Additional Inherited Members

- Static Public Member Functions inherited from CBCGPAnimationManager
 IsAnimationSupportedByOSChecks if animation is supported by OS.
 
- Protected Member Functions inherited from CBCGPAnimationManager
 OnAnimationFinishedCalled by the framework when an animation is finished.
 
 OnAnimationIdleCalled by the framework in an animation idle time.