CEikCbaButton Class Reference
Link against: mpxupnpplaybackdialog.lib
| class CEikCbaButton : public CAknControl |
Nested Classes and Structures
| Inherited Functions |
|---|
| | CAknControl::CAknControl() |
| | CAknControl::~CAknControl() |
| | CBase::CBase() |
| | CBase::Delete(CBase *) |
| | CBase::Extension_(TUint,TAny *&,TAny *) |
| | CBase::operator new(TUint) |
| | CBase::operator new(TUint,TAny *) |
| | CBase::operator new(TUint,TLeave) |
| | CBase::operator new(TUint,TLeave,TUint) |
| | CBase::operator new(TUint,TUint) |
| | CBase::~CBase() |
| | CCoeControl::AccumulatedZoom()const |
| | CCoeControl::ActivateGc()const |
| | CCoeControl::ActivateL() |
| | CCoeControl::BackedUpWindow()const |
| | CCoeControl::Background()const |
| | CCoeControl::CCoeControl() |
| | CCoeControl::CCoeControl(CCoeEnv *) |
| | CCoeControl::CCoeControl(const CCoeControl &) |
| | CCoeControl::CCoeControlArray |
| | CCoeControl::CapturesPointer()const |
| | CCoeControl::ClaimPointerGrab(TBool) |
| | CCoeControl::ClaimPointerGrab(TInt,TBool) |
| | CCoeControl::CloseWindow() |
| | CCoeControl::ComponentArrayExists()const |
| | CCoeControl::Components() |
| | CCoeControl::Components()const |
| | CCoeControl::ConstructFromResourceL(TResourceReader &) |
| | CCoeControl::ControlContext()const |
| | CCoeControl::ControlEnv()const |
| | CCoeControl::CopyControlContextFrom(const CCoeControl *) |
| | CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &) |
| | CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode) |
| | CCoeControl::CreateWindowL() |
| | CCoeControl::CreateWindowL(RWindowGroup *) |
| | CCoeControl::CreateWindowL(RWindowTreeNode &) |
| | CCoeControl::CreateWindowL(const CCoeControl *) |
| | CCoeControl::CustomGc()const |
| | CCoeControl::DeactivateGc()const |
| | CCoeControl::DrawBackground(const TRect &)const |
| | CCoeControl::DrawDeferred()const |
| | CCoeControl::DrawForeground(const TRect &)const |
| | CCoeControl::DrawNow()const |
| | CCoeControl::DrawNow(const TRect &)const |
| | CCoeControl::DrawableWindow()const |
| | CCoeControl::EnableDragEvents() |
| | CCoeControl::EnableReportControlStateChange(TBool) |
| | CCoeControl::EnableWindowTransparency() |
| | CCoeControl::FindBackground()const |
| | CCoeControl::FindFontProvider()const |
| | CCoeControl::FocusChanged(TDrawNow) |
| | CCoeControl::GetColor(TInt,TRgb &)const |
| | CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const |
| | CCoeControl::GetGc()const |
| | CCoeControl::GetHelpContext(TCoeHelpContext &)const |
| | CCoeControl::GrabbingComponent()const |
| | CCoeControl::GrabbingComponent(TInt)const |
| | CCoeControl::HandleComponentControlsResourceChange(TInt) |
| | CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt) |
| | CCoeControl::HandlePointerBufferReadyL() |
| | CCoeControl::HandleRedrawEvent(const TRect &)const |
| | CCoeControl::HandleResourceChange(TInt) |
| | CCoeControl::HasBorder()const |
| | CCoeControl::HitTest()const |
| | CCoeControl::IgnoreEventsUntilNextPointerUp() |
| | CCoeControl::Index(const CCoeControl *)const |
| | CCoeControl::InitComponentArrayL() |
| | CCoeControl::InputCapabilities()const |
| | CCoeControl::IsActivated()const |
| | CCoeControl::IsBackedUp()const |
| | CCoeControl::IsBeingDestroyed()const |
| | CCoeControl::IsBlank()const |
| | CCoeControl::IsDimmed()const |
| | CCoeControl::IsFocused()const |
| | CCoeControl::IsNonFocusing()const |
| | CCoeControl::IsReadyToDraw()const |
| | CCoeControl::IsVisible()const |
| | CCoeControl::LayoutManager()const |
| | CCoeControl::MakeVisible(TBool) |
| | CCoeControl::MaximumWidth()const |
| | CCoeControl::MopSupplyObject(TTypeUid) |
| | CCoeControl::NotifyFontChange(const CCoeFontProvider *) |
| | CCoeControl::Observer()const |
| | CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode) |
| | CCoeControl::OverrideColorL(TInt,TRgb) |
| | CCoeControl::OwnsWindow()const |
| | CCoeControl::Parent() |
| | CCoeControl::Parent()const |
| | CCoeControl::Position()const |
| | CCoeControl::PositionChanged() |
| | CCoeControl::PositionRelativeToScreen()const |
| | CCoeControl::PrepareForFocusGainL() |
| | CCoeControl::PrepareForFocusLossL() |
| | CCoeControl::ProcessPointerBufferReadyL() |
| | CCoeControl::ProcessPointerEventL(const TPointerEvent &) |
| | CCoeControl::Rect()const |
| | CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const |
| | CCoeControl::RecursivelyMergedInputCapabilities()const |
| | CCoeControl::RefetchPixelMappingL() |
| | CCoeControl::RemoveFromParent() |
| | CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent) |
| | CCoeControl::RequestRelayout(const CCoeControl *) |
| | CCoeControl::ResetGc()const |
| | CCoeControl::ScreenFont(const TCoeFont &)const |
| | CCoeControl::SetAdjacent(TInt) |
| | CCoeControl::SetAllowStrayPointers() |
| | CCoeControl::SetBackground(const MCoeControlBackground *) |
| | CCoeControl::SetBlank() |
| | CCoeControl::SetCanDrawOutsideRect() |
| | CCoeControl::SetComponentsToInheritVisibility(TBool) |
| | CCoeControl::SetContainerWindowL(RBackedUpWindow &) |
| | CCoeControl::SetContainerWindowL(RWindow &) |
| | CCoeControl::SetControlContext(MCoeControlContext *) |
| | CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &) |
| | CCoeControl::SetCustomGc(CWindowGc *) |
| | CCoeControl::SetExtent(const TPoint &,const TSize &) |
| | CCoeControl::SetExtentToWholeScreen() |
| | CCoeControl::SetFocus(TBool,TDrawNow) |
| | CCoeControl::SetFocusing(TBool) |
| | CCoeControl::SetFontProviderL(const CCoeFontProvider &) |
| | CCoeControl::SetGc(CWindowGc *)const |
| | CCoeControl::SetGloballyCapturing(TBool) |
| | CCoeControl::SetHitTest(const MCoeControlHitTest *) |
| | CCoeControl::SetLayoutManagerL(MCoeLayoutManager *) |
| | CCoeControl::SetMaximumWidth(TInt) |
| | CCoeControl::SetMopParent(MObjectProvider *) |
| | CCoeControl::SetNeighbor(CCoeControl *) |
| | CCoeControl::SetNonFocusing() |
| | CCoeControl::SetObserver(MCoeControlObserver *) |
| | CCoeControl::SetParent(CCoeControl *) |
| | CCoeControl::SetPointerCapture(TBool) |
| | CCoeControl::SetPosition(const TPoint &) |
| | CCoeControl::SetRect(const TRect &) |
| | CCoeControl::SetSize(const TSize &) |
| | CCoeControl::SetSizeWithoutNotification(const TSize &) |
| | CCoeControl::SetTextBaselineSpacing(TInt) |
| | CCoeControl::SetUniqueHandle(TInt) |
| | CCoeControl::SetZoomFactorL(TInt,TZoomType) |
| | CCoeControl::Size()const |
| | CCoeControl::SystemGc()const |
| | CCoeControl::TextBaselineOffset(const TSize &)const |
| | CCoeControl::TextDrawer(TInt)const |
| | CCoeControl::UniqueHandle()const |
| | CCoeControl::Window()const |
| | CCoeControl::WriteInternalStateL(RWriteStream &)const |
| | CCoeControl::WriteInternalStateNowL(RWriteStream &)const |
| | CCoeControl::ZoomWithType()const |
| | CCoeControl::operator=(const CCoeControl &) |
| | CCoeControl::~CCoeControl() |
Detailed Description
EIKON CBA button class definition.
Member Attribute Documentation
iDoImage
|
TBool
| iDoImage | [protected] |
iLongLabelText
|
TPtrC
| iLongLabelText | [protected] |
iMask
Original mask for softkey image.
iPressedDown
|
TBool
| iPressedDown | [protected] |
iSfeMask
Feedback effects transparency mask for softkey image.
iShortLabelText
|
TPtrC
| iShortLabelText | [protected] |
iUseTextBitmap
|
TBool
| iUseTextBitmap | [protected] |
ETrue if should use text bitmap mode.
Constructor & Destructor Documentation
Member Function Documentation
AddCommandL ( const TDesC & )
| void | AddCommandL | ( | const TDesC & | aText | ) | |
Updates the label text with the given label.
| Parameter | Description | | aText | The new label text. |
ConstructEmptyButtonL ( )
| void | ConstructEmptyButtonL | ( | ) | |
Constructs empty button with id EAknSoftkeyEmpty
ConstructFromResourceL ( TResourceReader &, TGulAlignmentValue )
Constructs the control from a resource file.
| Parameter | Description | | aReader | The resource reader. |
| anAlignment | Alignment for label. |
ConstructL ( TGulAlignmentValue )
Constructs a new CBA button instance.
| Parameter | Description | | aAlignment | Alignment for label. |
DrawToContext ( CBitmapContext &, CBitmapContext &, const TPoint & )
Draws the button text and mask to give graphics contexts. Background is not drawn.
FullLabelText ( )
|
TPtrC
| FullLabelText | ( | ) | [inline] |
Returns the textual value of the button
HandlePointerEventL ( const TPointerEvent & )
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
| Parameter | Description | | aPointerEvent | The pointer event. |
IndexFromCommandId ( TInt )
|
TInt
| IndexFromCommandId | ( | TInt | aCommandId | ) | [protected] |
Returns the button's index by command id.
| Parameter | Description | | aCommandId | The button's command id. |
Returns: The button's index.
IsEmptyText ( )
Checks if text is empty in this button.
IsImageOn ( )
|
TBool
| IsImageOn | ( | ) | const [inline] |
Returns whether the button has image set.
Returns: ETrue if the button has image set, EFalse otherwise.
MinimumSize ( )
|
TSize
| MinimumSize | ( | ) | [virtual] |
From CCoeControl. Sets the control's minimum required size.
Returns: The minimum size required by the control.
PopCommand ( )
Pops a command from the button stack.
Returns: The button's command id. KErrNotFound if the button stack is empty.
PressedDown ( )
Returns: Boolean value for CEikCbaButtons state. ETrue if button is pressed down. Otherwise returns EFalse.
PushCommandL ( TInt, const TDesC & )
| void | PushCommandL | ( | TInt | aCommandId, |
| | const TDesC & | aText |
| | ) | |
Pushes a command into button stack.
| Parameter | Description | | aCommandId | The command to be pushed. |
| aText | Text for the button. |
RemoveCommand ( TInt )
| void | RemoveCommand | ( | TInt | aCommandId | ) | |
Removes a command from the button stack.
| Parameter | Description | | aCommandId | The command to be removed. |
RemovePreviousCommand ( )
| void | RemovePreviousCommand | ( | ) | |
Removes the previous command from the button stack.
ReplaceImageByLabel ( )
| void | ReplaceImageByLabel | ( | ) | |
Replaces the buttons image with label.
SetContainerWindowL ( const CCoeControl & )
| void | SetContainerWindowL | ( | const CCoeControl & | aContainer | ) | [virtual] |
From CCoeControl. Sets the control's containing window by copying it from aContainer.
| Parameter | Description | | aContainer | The compound control that is the container for this control. |
SetDimmed ( TBool )
| void | SetDimmed | ( | TBool | aDimmed | ) | [virtual] |
| Parameter | Description | | aDimmed | ETrue to dim the control, EFalse to set the control as not dimmed. |
SetImage ( CEikImage & )
| Parameter | Description | | aImage | The image to be set. |
SetLabelFont ( const CFont * )
| void | SetLabelFont | ( | const CFont * | aLabelFont | ) | |
| Parameter | Description | | aLabelFont | The font to be used. |
SetPressedDown ( const TBool )
| void | SetPressedDown | ( | const TBool | aPressedDown | ) | |
Changes the state of CEikCbaButton. Button's state is stored in a member variable.
| Parameter | Description | | aPressedDown | The state that button has. ETrue if button's state is pressed down. EFalse for normal, not pressed state. |
SetTextBitmapMode ( TBool )
| void | SetTextBitmapMode | ( | TBool | aEnableBitmap | ) | |
Enables bitmap mode and hides the label. The text is drawn by CEikCba in bitmap mode.
SwitchToShortTextL ( TBool )
| void | SwitchToShortTextL | ( | TBool | aShortText | ) | |
Switches the button's text to short or long depending on the parameter given.
| Parameter | Description | | aShortText | ETrue for short text, EFalse for the long text. |
TruncateLabelText ( )
Truncates the label. This is done by CEikLabel.
UpdateLabelText ( TPtrC )
| void | UpdateLabelText | ( | TPtrC | aLabelText | ) | [protected] |
Updates the label text with the given label.