CEikCommandButton Class Reference
Link against: eikcoctl.dll
| class CEikCommandButton : public CEikCommandButtonBase |
| 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::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::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::GetColor(TInt,TRgb &)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::HitTest()const |
| | CCoeControl::IgnoreEventsUntilNextPointerUp() |
| | CCoeControl::Index(const CCoeControl *)const |
| | CCoeControl::InitComponentArrayL() |
| | 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::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::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::WriteInternalStateNowL(RWriteStream &)const |
| | CCoeControl::ZoomWithType()const |
| | CCoeControl::operator=(const CCoeControl &) |
| | CCoeControl::~CCoeControl() |
| | CEikBorderedControl::Border()const |
| | CEikBorderedControl::CEikBorderedControl() |
| | CEikBorderedControl::CEikBorderedControl(const TGulBorder &) |
| | CEikBorderedControl::HasBorder()const |
| | CEikBorderedControl::SetAdjacent(TInt) |
| | CEikBorderedControl::SetBorder(TGulBorder::TBorderType) |
| | CEikBorderedControl::SetBorder(TInt) |
| | CEikButtonBase::Animate() |
| | CEikButtonBase::CEikButtonBase() |
| | CEikButtonBase::CopyDrawStateTo(CEikButtonBase *)const |
| | CEikButtonBase::DrawState()const |
| | CEikButtonBase::InputCapabilities()const |
| | CEikButtonBase::IsPressed()const |
| | CEikButtonBase::SetAllowTristate() |
| | CEikButtonBase::SetBehavior(TButtonBehavior) |
| | CEikButtonBase::SetCoordinator(TEikButtonCoordinator *) |
| | CEikButtonBase::SetIgnoreNextPointerUp() |
| | CEikButtonBase::SetReportOnPointerDown() |
| | CEikButtonBase::SetState(TState) |
| | CEikButtonBase::State()const |
| | CEikButtonBase::~CEikButtonBase() |
| | CEikCommandButtonBase::ActivateL() |
| | CEikCommandButtonBase::Behavior()const |
| | CEikCommandButtonBase::ButFlags()const |
| | CEikCommandButtonBase::CEikCommandButtonBase() |
| | CEikCommandButtonBase::CheckCreateCommandStackL() |
| | CEikCommandButtonBase::CommandStack()const |
| | CEikCommandButtonBase::ComponentControl(TInt)const |
| | CEikCommandButtonBase::ConstructImageFromResourceL(TResourceReader &,TWhichComponent) |
| | CEikCommandButtonBase::ConstructLabelFromResourceL(TResourceReader &,TWhichComponent) |
| | CEikCommandButtonBase::CountComponentControls()const |
| | CEikCommandButtonBase::Draw(const TRect &)const |
| | CEikCommandButtonBase::FocusChanged(TDrawNow) |
| | CEikCommandButtonBase::GetColorUseListL(CArrayFix< TCoeColorUse > &)const |
| | CEikCommandButtonBase::HandleResourceChange(TInt) |
| | CEikCommandButtonBase::IsDefault()const |
| | CEikCommandButtonBase::LayoutComponents() |
| | CEikCommandButtonBase::MinimumSize() |
| | CEikCommandButtonBase::OfferKeyEventL(const TKeyEvent &,TEventCode) |
| | CEikCommandButtonBase::SetContainerWindowL(const CCoeControl &) |
| | CEikCommandButtonBase::SetDefault(TBool) |
| | CEikCommandButtonBase::SetDimmed(TBool) |
| | CEikCommandButtonBase::SetImageAttributes(CEikImage *) |
| | CEikCommandButtonBase::SetPictureFromFileL(const TDesC &,TInt,TInt,CEikAlignedControl *&) |
| | CEikCommandButtonBase::SetPictureL(const CFbsBitmap *,const CFbsBitmap *,CEikAlignedControl *&) |
| | CEikCommandButtonBase::SetTextL(const TDesC &,CEikAlignedControl *&) |
| | CEikCommandButtonBase::StartConstructFromResourceL(TResourceReader &) |
| | CEikCommandButtonBase::StateChanged() |
| | CEikCommandButtonBase::WriteInternalStateL(RWriteStream &)const |
| | CEikCommandButtonBase::~CEikCommandButtonBase() |
Detailed Description
Command button with a text and/or an image
This class in S60 does not function without derivation This class does NOT implement S60 look-and-feel and is not skinned.
Member Enumeration Documentation
Enum TDisplayContent
Content to diplay for this button
| Enumerator | Value | Description |
|---|
| ETextOnly | 0x0100 | |
| EPictureOnly | 0x0200 | |
| ETextAndPicture | 0x0300 | |
Enum TExcess
Where to put excess space in the layout
| Enumerator | Value | Description |
|---|
| EShare | 0x0000 | |
| EToText | 0x0010 | |
| EToPicture | 0x0020 | |
Enum TLayout
Layout options for a command button
| Enumerator | Value | Description |
|---|
| ETextRightPictureLeft | 0x000 | |
| ETextBottomPictureTop | 0x001 | |
| ETextTopPictureBottom | 0x002 | |
| ETextLeftPictureRight | 0x003 | |
Constructor & Destructor Documentation
CEikCommandButton ( )
| IMPORT_C | CEikCommandButton | ( | ) | |
~CEikCommandButton ( )
| IMPORT_C | ~CEikCommandButton | ( | ) | |
Member Function Documentation
AddCommandToStackL ( TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap * )
Push a command ID + text + image binding onto the command stack.
| Parameter | Description | | aCommandId | Command ID to be generated by pressing this button |
| aText | Text to display on the button |
| aBitmap | Bitmap to display on the button |
| aMask | Mask to use. May be Null |
ConstructFromResourceL ( TResourceReader & )
| Parameter | Description | | aReader | Fully constructed resource reader |
HandlePointerEventL ( const TPointerEvent & )
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
From CCoeControl
Handle a pointer event coming from the CONE framework
| Parameter | Description | | aPointerEvent | Event to handle |
Label ( )
Access the label control that implements the text label of the button. Ownership is not transferred.
Returns: A pointer to the CEikLabel control used to implement the text display
Picture ( )
Access the CEikImage that implements the picture component of the button. Ownership is not transferred.
Returns: A pointer to the CEikImage used to implement the image display.
PopCommandFromStack ( )
| IMPORT_C TInt | PopCommandFromStack | ( | ) | |
Remove the top (most recently added) command binding from the command stack
Returns: the number of commands left on the stack.
RemoveCommandFromStack ( TInt )
| IMPORT_C TBool | RemoveCommandFromStack | ( | TInt | aCommandId | ) | |
Find the stacked command with a given command ID and remove it from the stack
| Parameter | Description | | aCommandId | ID of the command to be removed |
Returns: EFalse iff the comand is not found
SetButtonLayout ( TLayout )
| IMPORT_C void | SetButtonLayout | ( | TLayout | aLayout | ) | |
Set the layout of the button
| Parameter | Description | | aLayout | Layout to be used |
SetCommandL ( TInt, const TDesC *, const CFbsBitmap *, const CFbsBitmap * )
Sets the command button's text, bitmap and bitmap mask.
| Parameter | Description | | aCommandId | Command ID to be generated by pressing this button |
| aText | Text to display on the button |
| aBitmap | Bitmap to display on the button |
| aMask | Mask to use. May be Null |
SetDisplayContent ( TDisplayContent )
Set what content is to be displayed in the button
| Parameter | Description | | aContent | Enum value saying what content to display |
SetExcessSpace ( TExcess )
| IMPORT_C void | SetExcessSpace | ( | TExcess | aExcess | ) | |
Sets where the excess space in the layout is to be distributed
| Parameter | Description | | aExcess | Enum value to say where the excess space is to go |
SetPictureFromFileL ( const TDesC &, TInt, TInt )
| IMPORT_C void | SetPictureFromFileL | ( | const TDesC & | aFilename, |
| | TInt | aMain, |
| | TInt | aMask = -1 |
| | ) | |
Set bitmap and mask from file.
SetPictureL ( const CFbsBitmap *, const CFbsBitmap * )
Sets the bitmap and optional mask for the button
| Parameter | Description | | aMain | The bitmap to use |
| aMask | The mask. If null, then no mask will be used |
SetTextL ( const TDesC & )
| IMPORT_C void | SetTextL | ( | const TDesC & | aText | ) | |
Sets the label text for the button.
| Parameter | Description | | aText | The text to set |
UpdateComponentAlignment ( )
| IMPORT_C void | UpdateComponentAlignment | ( | ) | [virtual] |