CEikBorderedControl Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Default C++ Constructor.

Constructs a new bordered control that has no border.

Constructor that creates a new bordered control with a specified border.

Parameters:

aBorder

The border of the control.

Gets the control's border.

Returns:

The border of the control.

Draws the border around the control.

This function also clears the central area if the IsBlank() method returns ETrue.

From CCoeControl

Parameters:

aRect

Not used.

See also:

CCoeControl::IsBlank()

Border()

Reimplemented in CAknDialog, CAknGMSStyleGrid, CAknSetStyleListBox, CAknPopupField, CAknSelectionListDialog, CAknSlider, CEikCba, CEikCommandButtonBase, CEikEdwin, CEikFileNameLabel, CEikListBox, CEikMenuBar, CEikMenuPaneTitle, CEikMenuPane, AknListBoxLinesTemplate< CEikSettingsListBox >, AknListBoxLinesTemplate< CAknColumnListBox >, and AknListBoxLinesTemplate< CEikFormattedCellListBox >.

Not used in S60.

From CCoeControl.

Parameters:

aColorUseList

Not used.

Reimplemented in CEikButtonBase, CEikCba, CEikColumnListBox, CEikCommandButtonBase, CEikControlGroup, CEikDialog, CEikEdwin, CEikFileNameLabel, CEikFormattedCellListBox, CEikListBox, CEikSnakingListBox, CEikMenuBar, CEikMenuPaneTitle, CEikMenuPane, CEikMfne, CEikProgressInfo, CEikSecretEditor, CEikToolBar, CEikTextListBox, and CEikSnakingTextListBox.

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.

Parameters:

aPointerEvent

The pointer event.

Reimplemented in CAknDialog, CAknForm, CAknGMSStyleGrid, CAknGMSPopupGrid, CAknGrid, CAknIpFieldEditor, CAknListQueryDialog, CAknColumnListBox, CAknSingleStyleListBox, CAknSingleGraphicStyleListBox, CAknSingleGraphicHeadingStyleListBox, CAknSingleLargeStyleListBox, CAknDoubleNumberStyleListBox, CAknDoubleTimeStyleListBox, CAknDouble2GraphicStyleListBox, CAknDouble2LargeStyleListBox, CAknSettingStyleListBox, CAknSinglePopupMenuStyleListBox, CAknSingleGraphicPopupMenuStyleListBox, CAknSingleGraphicBtPopupMenuStyleListBox, CAknSingleHeadingPopupMenuStyleListBox, CAknSingleGraphicHeadingPopupMenuStyleListBox, CAknDoublePopupMenuStyleListBox, CAknSinglePopupSubmenuStyleListBox, CAknDoubleLargeGraphicPopupMenuStyleListBox, CAknDouble2PopupMenuStyleListBox, CAknSingle2GraphicPopupMenuStyleListBox, CAknDoubleGraphicPopupMenuStyleListBox, CAknSetStyleListBox, CAknFormGraphicStyleListBox, CAknFormGraphicWideStyleListBox, CAknPinbStyleGrid, CAknQdialStyleGrid, CAknCaleMonthStyleGrid, CAknMessageQueryDialog, CAknNoteDialog, CAknNoteWrapper, CAknResourceNoteDialog, CAknConfirmationNote, CAknInformationNote, CAknErrorNote, CAknWarningNote, CAknNumericEdwin, CAknIntegerEdwin, CAknNumericSecretEditor, CAknPopupList, CAknPopupField, CAknPopupFieldList, CAknPopupFieldText, CAknPopupSettingList, CAknProgressDialog, CAknQueryDialog, CAknTextQueryDialog, CAknNumberQueryDialog, CAknTimeQueryDialog, CAknDurationQueryDialog, CAknFloatingPointQueryDialog, CAknMultiLineDataQueryDialog, CAknSelectionListDialog, CAknMarkableListDialog, CAknSlider, CAknStaticNoteDialog, CAknWaitDialog, CEikAlert, CEikButtonBase, CEikCba, CEikColumnListBox, CEikCommandButtonBase, CEikCommandButton, CEikTwoPictureCommandButton, CEikInverterCommandButton, CEikTextButton, CEikBitmapButton, CEikControlGroup, CEikDialog, CEikEdwin, CEikFileNameLabel, CEikFloatingPointEditor, CEikFixedPointEditor, CEikFormattedCellListBox, CEikGlobalTextEditor, CEikInfoDialog, CEikListBox, CEikSnakingListBox, CEikMenuBar, CEikMenuPaneTitle, CEikMenuPane, CEikMfne, CEikNumberEditor, CEikRangeEditor, CEikTimeEditor, CEikDateEditor, CEikTimeAndDateEditor, CEikDurationEditor, CEikTimeOffsetEditor, CEikMenuButton, CEikProgressInfo, CEikRichTextEditor, CEikScrollButton, CEikScrollBar, CEikArrowHeadScrollBar, CAknDoubleSpanScrollBar, CEikSecretEditor, CEikSettingsListBox, CEikToolBar, CEikTextListBox, and CEikSnakingTextListBox.

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.

Parameters:

aType

The type of resource that has changed.

Reimplemented in CAknForm, CAknGrid, CAknInputFrame, CAknListQueryDialog, CAknNoteDialog, CAknIntegerEdwin, CAknPopupList, CAknPopupField, CAknPopupSettingList, CAknMultiLineDataQueryDialog, CAknMultiLineIpQueryDialog, CAknSlider, CEikButtonBase, CEikCba, CEikColumnListBox, CEikCommandButtonBase, CEikControlGroup, CEikDialog, CEikEdwin, CEikFileNameLabel, CEikFloatingPointEditor, CEikFixedPointEditor, CEikFormattedCellListBox, CEikListBox, CEikSnakingListBox, CEikMenuBar, CEikMenuPaneTitle, CEikMenuPane, CEikMfne, CEikProgressInfo, CEikSecretEditor, CEikToolBar, CEikTextListBox, and CEikSnakingTextListBox.

Checks whether the control has a border.

From CCoeControl.

Returns:

ETrue if the control has a border, EFalse otherwise.

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.

Parameters:

aAdjacent

A value from TGulAdjacent declaring which edge of this control is shared.

See also:

CCoeControl::SetAdjacent()

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.

Parameters:

aBorderType

The border type to be set.

Sets the border type of the control to a type defined in TGulBorder::TBorderType.

Parameters:

aBorderType

The border type to be set.

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

Parameters:

[in,out]

aWriteStream

A connected write stream.

Reimplemented in CEikButtonBase, CEikCommandButtonBase, CEikTwoPictureCommandButton, CEikInverterCommandButton, CEikControlGroup, CEikDialog, CEikEdwin, CEikGlobalTextEditor, CEikMfne, CEikMenuButton, CEikProgressInfo, CEikRichTextEditor, CEikToolBar, and CEikTextListBox.

The control's border.