landmarksui/uicontrols/inc/MLmkEditorUiBuilder.h
branchRCL_3
changeset 17 1fc85118c3ae
parent 16 8173571d354e
child 18 870918037e16
equal deleted inserted replaced
16:8173571d354e 17:1fc85118c3ae
     1 /*
       
     2 * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:    LandmarksUi Content File -    Landmark editor field abstract callback class.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 #ifndef __MLMKEDITORUIBUILDER_H__
       
    25 #define __MLMKEDITORUIBUILDER_H__
       
    26 
       
    27 //  INCLUDES
       
    28 #include <e32def.h>
       
    29 
       
    30 // FORWARD DECLARATIONS
       
    31 class CCoeControl;
       
    32 class CEikCaptionedControl;
       
    33 class CPosLandmarkDatabase;
       
    34 
       
    35 // CLASS DECLARATION
       
    36 
       
    37 /**
       
    38 * Landmark editor field abstract class.
       
    39 */
       
    40 class MLmkEditorUiBuilder
       
    41     {
       
    42     public:  // destructor
       
    43         /**
       
    44         * Destructor.
       
    45         */
       
    46         virtual ~MLmkEditorUiBuilder(){}
       
    47 
       
    48     public:  // Interface
       
    49 		/**
       
    50 		* Creates a User interface control for a line.
       
    51 		* @param aCaption	The caption descriptor to the control.
       
    52 		* @param aControlId	The created controls ID.
       
    53 		* @param aControlType	The created controls type.
       
    54 		*/
       
    55         virtual CCoeControl* CreateLineL(const TDesC& aCaption,
       
    56                 TInt aControlId, TInt aControlType) = 0;
       
    57 
       
    58         /**
       
    59         * Returns the control line corresponding to aControlId.
       
    60         * @param aControlId
       
    61         * @return CEikCaptionedControl pointer
       
    62         */
       
    63         virtual CEikCaptionedControl* LineControl(TInt aControlId) const = 0;
       
    64 
       
    65         /**
       
    66         * Removed the aControlId control from the UI.
       
    67         * @param aControlId
       
    68         */
       
    69         virtual void DeleteControl(TInt aControlId) = 0;
       
    70 
       
    71 		/**
       
    72 		* Try to change the focus to aControlId.
       
    73 		* @param aControlId
       
    74 		*/
       
    75 		virtual void TryChangeFocusL(TInt aControlId) = 0;
       
    76 
       
    77 		/**
       
    78 		* Change the line controls caption aText in the UI.
       
    79         * @param aControlId
       
    80         * @param aText
       
    81 		*/
       
    82 		virtual void SetCurrentLineCaptionL( TInt aControlId,
       
    83                                              const TDesC& aText) = 0;
       
    84 
       
    85 		/**
       
    86 		* Return the control object corresponding to aControlId.
       
    87         * @param aControlId
       
    88 		* @return NULL if the control does not exist.
       
    89 		*/
       
    90 		virtual CCoeControl* Control(TInt aControlId) const = 0;
       
    91 
       
    92 		/**
       
    93 		* Sets the field editable state.
       
    94 		* @param aState ETrue to set editable, EFalse otherwise
       
    95 		*/
       
    96 		virtual void SetEditableL(TBool aState) = 0;
       
    97 
       
    98         /**
       
    99         * Return landmark's database
       
   100         * @return landmark's database
       
   101         */
       
   102         virtual CPosLandmarkDatabase& Database() = 0;
       
   103         /**
       
   104         * Return editor's edit state
       
   105         */
       
   106         virtual TInt EditMode() = 0;
       
   107     };
       
   108 
       
   109 #endif // __MLMKEDITORUIBUILDER_H__
       
   110 
       
   111 // End of File