#include <mw/eikcapca.h>
class CEikCapCArray : public CArrayPtrFlat< CEikCaptionedControl > |
Public Member Functions | |
---|---|
CEikCapCArray(TInt) | |
~CEikCapCArray() | |
IMPORT_C void | AdjustAllIds(TInt) |
TBool | CalcItemIndexes(TInt &, TInt &, TInt &, TSize) |
void | CreateExtensionL() |
IMPORT_C void | DeleteLine(TInt) |
CEikCapCArrayExtension * | ExtensionOrNull() |
IMPORT_C TInt | FindLineIndex(const CCoeControl *) |
TInt | FocusableLine(TInt, TInt) |
IMPORT_C TInt | LineIndexFromId(TInt) |
TInt | LineIndexToYPosition(TInt, TInt) |
IMPORT_C TSize | MinimumSize() |
void | MoveLineToScreen(TInt, TInt, TBool) |
TRect | Rect() |
IMPORT_C void | ResetMinimumSizes() |
IMPORT_C void | SetDensePacking(TBool) |
IMPORT_C void | SetRect(const TRect &) |
void | SetRect(const TRect &, TInt, TInt, TInt) |
TInt | YPositionToLineIndex(TInt) |
IMPORT_C | CEikCapCArray | ( | TInt | aGranularity | ) |
Constructor
Creates CEikCapCArray with a granilarity.
Parameter | Description |
---|---|
aGranularity | how many items will be allocated each time allocation happens |
IMPORT_C void | AdjustAllIds | ( | TInt | aControlIdDelta | ) |
AdjustAllIds() modified iId fields of the captionedcontrols
Parameter | Description |
---|---|
aControlIdDelta | how much to increase or decrease control id's |
IMPORT_C void | DeleteLine | ( | TInt | aIndex | ) |
DeleteLine() removes line from captionedcontrolarray
Elements from CaptionedControlArray can be removed by calling DeleteLine method.
Parameter | Description |
---|---|
aIndex | index of the line to be removed |
IMPORT_C TInt | FindLineIndex | ( | const CCoeControl * | aControl | ) | const |
FindLineIndex() finds line index based on control
Every captionedcontrol has iControl CCoeControl which implements the control for the DLG_LINE. FindLineIndex goes through all captionedcontrols and finds the one which has aControl as it's control.
Parameter | Description |
---|---|
aControl | control to be found |
LineIndexFromId() provides line index in array based on id number
Every captionedcontrol has iId and based on the id, LineIndexFromId goes through the captionedcontrolarray and finds the captionedcontrol's position in the array based on the id provided
Parameter | Description |
---|---|
aControlId | captionedcontrol's iId. |
IMPORT_C TSize | MinimumSize | ( | ) |
MinimumSize() returns minimum size for the array
MinimumSize calculates minimum possible size for the captioned control array.
Calculate the size of all the component controls stacked vertically. For Avkon Forms the controls overlap by 2 pixels (hard coded)
Returns: size in pixels
TRect | Rect | ( | ) | const |
Position all of the component controls in a vertical pile. For Avkon Forms the controls overlap by two pixels. (hard coded)
IMPORT_C void | ResetMinimumSizes | ( | ) |
ResetMinimumSizes() clears size information
ResetMinimumSizes goes through all captionedcontrols and resets the minimum size information of the captionedcontrols
IMPORT_C void | SetDensePacking | ( | TBool | aDensePacking | ) |
SetDensePacking() sets dense packing flag
Parameter | Description |
---|---|
aDensePacking | whether dense packing flag is on |
IMPORT_C void | SetRect | ( | const TRect & | aRect | ) |
SetRect() sets the rectangle of the captionedcontrolarray
SetRect layouts the captionedcontrolarray. Captioned control rectangles are calculated based on provided rectangle and sizes of the captioned controls.
Parameter | Description |
---|---|
aRect | Rectangle for the whole array |
Places the dialog items according to the current visible window position. When hiding items, uses SetExtent() instead of just SetPosition() in order to call SizeChanged() of the moved item. For example, this is needed for the editor to change its cursor accordingly.
Parameter value equal to -1 means that the parameter is not defined and will be calculated automatically. Normally, either the top number or the bottom one is only defined. If aTop is defined, the items will be placed from top downwards, leaving aTop items above the window. If aBottom is defined, the items will be placed from bottom upwards, leaving aBottom items below the window.
This function panics, if neither aTop nor aBottom are defined.
The function first checks if the provided aTop and aBottom are consistent with the item sizes and the given window rectangle. If they are not, they will be corrected. Usually, aTop and aBottom come out of sync with the item sizes after the dynamic layout change.
Parameter | Description |
---|---|
aRect | Rectangle of the form window |
aTop | Number of items above the window |
aMiddle | Number of items inside the window |
aBottom | Number of items below the window |