| class CEikBorderedControl : public CAknControl |
A control which is drawn surrounded by a rectangular border.
The screen appearance of derived classes can be changed by overriding the protected method Draw(). By default, this draws a border of the appropriate type around the control.
| Public Member Functions | |
|---|---|
| CEikBorderedControl() | |
| CEikBorderedControl(const TGulBorder &) | |
| IMPORT_C TGulBorder | Border() |
| IMPORT_C void | GetColorUseListL(CArrayFix< TCoeColorUse > &) |
| IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
| IMPORT_C void | HandleResourceChange(TInt) |
| IMPORT_C TBool | HasBorder() |
| IMPORT_C void | SetAdjacent(TInt) |
| IMPORT_C void | SetBorder(TGulBorder::TBorderType) |
| IMPORT_C void | SetBorder(TInt) |
| Protected Member Functions | |
|---|---|
| IMPORT_C void | Draw(const TRect &) |
| IMPORT_C void | WriteInternalStateL(RWriteStream &) |
| Private Member Functions | |
|---|---|
| IMPORT_C void * | ExtensionInterface(TUid) |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
| Protected Attributes | |
|---|---|
| TGulBorder | iBorder |
| Private Attributes | |
|---|---|
| TInt | iSpare |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| IMPORT_C | CEikBorderedControl | ( | ) |
Default C++ Constructor. Constructs a new bordered control that has no border.
| IMPORT_C | CEikBorderedControl | ( | const TGulBorder & | aBorder | ) |
Constructor that creates a new bordered control with a specified border.
| const TGulBorder & aBorder | The border of the control. |
| IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [protected, virtual] |
From CCoeControl. Draws the border around the control. This function also clears the central area if the IsBlank() method returns ETrue.
From CCoeControl
| const TRect & aRect | Not used. |
| IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl.
| TUid aInterface |
| IMPORT_C void | GetColorUseListL | ( | CArrayFix< TCoeColorUse > & | aColorUseList | ) | const [virtual] |
Not used in S60.
From CCoeControl.
Gets the list of logical colors employed in the drawing of the control, paired with an explanation of how they are used. Appends the list to aColorUseList.
| CArrayFix< TCoeColorUse > & aColorUseList | Not used. |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Handles pointer events.
This function gets called whenever a pointer event occurs in the control, i.e. when the pointer is within the control's extent, or when the control has grabbed the pointer.
If overriding this method, the implementation must include a base call to this method.
From CCoeControl.
| const TPointerEvent & aPointerEvent | The pointer event. |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
Handles a change to the control's resources.
The types of resources handled are those which are shared across the environment, e.g. colours or fonts. For colour scheme changes, DrawDeferred() is called in order to redraw the control.
If overriding this method, the implementation must include a base call to this method.
From CCoeControl.
Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.
| TInt aType | The type of resource that has changed. |
| IMPORT_C TBool | HasBorder | ( | ) | const [virtual] |
From CCoeControl. Checks whether the control has a border.
From CCoeControl.
| IMPORT_C void | SetAdjacent | ( | TInt | aAdjacent | ) | [virtual] |
Sets the control's adjacency.
Declares that a control abuts another control along one edge, and does not need to be drawn with a full border along that side. This is for use by layout engines or any user code which lays out controls next to one another.
Its intended use is to remove the double border that may occur if two controls, both with borders, are adjacent within a container control.
From CCoeControl.
| TInt aAdjacent | A value from TGulAdjacent declaring which edge of this control is shared. |
| IMPORT_C void | SetBorder | ( | TGulBorder::TBorderType | aBorderType | ) |
Sets the border type of the control to a type defined in TGulBorder::TBorderType.
Overloaded method which sets the border type to aBorderType for a value from the enum TGulBorder::TBorderType.
| TGulBorder::TBorderType aBorderType | The border type to be set. |
| IMPORT_C void | SetBorder | ( | TInt | aBorderType | ) |
Sets the border type. Any one of the values from the enums TGulBorder::TBorderType or TGulBorder::TLogicalType specifies a valid border type.
Custom border types can be created by selecting one value from enum TGulBorder::T3DStyle, one value from enum TGulBorder::TConstructionStyle, at most one value from enum TGulBorder::TOutlineStyle, at most one value from enum TGulBorder::TInlineStyle, at least one value from enum TGulBorder::TThickness and at least one value from enum TGulBorder::TRounding and performing an OR operation to these.
one value from each of the enums TGulBorder::T3DStyle and TGulBorder::TConstructionStyle,
at most one value from the enums TGulBorder::TOutlineStyle and TGulBorder::TInlineStyle,
at least one value from the enums TGulBorder::TThickness and TGulBorder::TRounding
| TInt aBorderType | The border type to be set. |
| IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [protected, virtual] |
Writes the internal state of the control and its components to aWriteStream. Does nothing in release mode.
Designed to be overridden and base called from subclasses.
From CCoeControl
Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.
| RWriteStream & aWriteStream | A connected write stream. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.