#include <mw/eikbctrl.h>
| class CEikBorderedControl : public CAknControl |
| Protected Attributes | |
|---|---|
| TGulBorder | iBorder |
| Public Member Functions | |
|---|---|
| CEikBorderedControl() | |
| CEikBorderedControl(const TGulBorder &) | |
| IMPORT_C TGulBorder | Border() |
| virtual IMPORT_C void | GetColorUseListL(CArrayFix< TCoeColorUse > &) |
| virtual IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
| virtual IMPORT_C void | HandleResourceChange(TInt) |
| virtual IMPORT_C TBool | HasBorder() |
| virtual IMPORT_C void | SetAdjacent(TInt) |
| IMPORT_C void | SetBorder(TGulBorder::TBorderType) |
| IMPORT_C void | SetBorder(TInt) |
| Protected Member Functions | |
|---|---|
| virtual IMPORT_C void | Draw(const TRect &) |
| virtual IMPORT_C void | WriteInternalStateL(RWriteStream &) |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
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.
| 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.
| Parameter | Description |
|---|---|
| aBorder | The border of the control. |
| IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [protected, virtual] |
Reimplemented from CCoeControl::Draw(const TRect &)const
From CCoeControl. Draws the border around the control. This function also clears the central area if the IsBlank() method returns ETrue.
From CCoeControl
See also: CCoeControl::IsBlank() Border()
| Parameter | Description |
|---|---|
| aRect | Not used. |
| IMPORT_C void | GetColorUseListL | ( | CArrayFix< TCoeColorUse > & | aColorUseList | ) | const [virtual] |
Reimplemented from CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
Not used in S60.
From CCoeControl.
| Parameter | Description |
|---|---|
| aColorUseList | Not used. |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Reimplemented from CCoeControl::HandlePointerEventL(const TPointerEvent &)
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.
| Parameter | Description |
|---|---|
| aPointerEvent | The pointer event. |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
Reimplemented from CCoeControl::HandleResourceChange(TInt)
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.
| Parameter | Description |
|---|---|
| aType | The type of resource that has changed. |
| IMPORT_C TBool | HasBorder | ( | ) | const [virtual] |
Reimplemented from CCoeControl::HasBorder()const
From CCoeControl. Checks whether the control has a border.
From CCoeControl.
Returns: ETrue if the control has a border, EFalse otherwise.
| IMPORT_C void | SetAdjacent | ( | TInt | aAdjacent | ) | [virtual] |
Reimplemented from CCoeControl::SetAdjacent(TInt)
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.
See also: CCoeControl::SetAdjacent()
| Parameter | Description |
|---|---|
| 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.
| Parameter | Description |
|---|---|
| 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.
| Parameter | Description |
|---|---|
| aBorderType | The border type to be set. |
| IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [protected, virtual] |
Reimplemented from CCoeControl::WriteInternalStateL(RWriteStream &)const
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
| Parameter | Description |
|---|---|
| aWriteStream | A connected write stream. |