phoneapp/phoneuiview2/inc/phoneuiqtviewif.h
branchRCL_3
changeset 61 41a7f70b3818
equal deleted inserted replaced
58:40a3f856b14d 61:41a7f70b3818
       
     1 /*!
       
     2 * Copyright (c) 2009 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:  Phone UI Qt view's interface.
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef PHONEUIQTVIEWIF_H
       
    19 #define PHONEUIQTVIEWIF_H
       
    20 
       
    21 #include <bubblemanagerif.h>
       
    22 
       
    23 class QKeyEvent;
       
    24 class QString;
       
    25 class HbIcon;
       
    26 class HbAction;
       
    27 class HbMenu;
       
    28 class PhoneAction;
       
    29 
       
    30 class PhoneUIQtViewIF
       
    31 {
       
    32 
       
    33 public:
       
    34         
       
    35     /*!
       
    36         \fn void PhoneUIQtViewIF::bubbleManager ()
       
    37         
       
    38         Returns reference to BubbleManager's interface.
       
    39     */
       
    40     virtual BubbleManagerIF& bubbleManager () = 0;
       
    41     
       
    42     /*!
       
    43         \fn void PhoneUIQtViewIF::addBubbleCommand ()
       
    44         
       
    45         Adds new command to bubble. Command id will be emitted as
       
    46         a parameter from view's command(int) signal.
       
    47     */
       
    48     virtual void addBubbleCommand ( 
       
    49         int bubbleId,
       
    50         const PhoneAction& action ) = 0;
       
    51     
       
    52     /*!
       
    53         \fn void PhoneUIQtViewIF::clearBubbleCommands ()
       
    54         
       
    55         Clears commands from bubble.
       
    56     */
       
    57     virtual void clearBubbleCommands (int bubbleId) = 0;
       
    58 
       
    59     /*!
       
    60         \fn void PhoneUIQtView::addParticipantListAction ()
       
    61         
       
    62         Adds new patricipant list command to conference bubble. 
       
    63     */
       
    64     virtual void addParticipantListAction(
       
    65             int commandId,  
       
    66             const QString &text, 
       
    67             const HbIcon &icon) = 0;
       
    68 
       
    69     /*!
       
    70         \fn void PhoneUIQtView::clearBubbleCommands ()
       
    71         
       
    72         Clears participant list commands from conference bubble.
       
    73     */
       
    74     virtual void clearParticipantListActions() = 0;
       
    75     
       
    76     /*!
       
    77         \fn void PhoneUIQtViewIF::setToolbarActions()
       
    78         
       
    79         Sets toolbar actions.
       
    80     */
       
    81     virtual void setToolbarActions(const QList<PhoneAction*>& actions) = 0;    
       
    82     
       
    83     /*!
       
    84         \fn void PhoneUIQtViewIF::hideToolbar ()
       
    85         
       
    86         Hides toolbar.
       
    87     */
       
    88     virtual void hideToolbar () = 0;
       
    89     
       
    90     /*!
       
    91         \fn void PhoneUIQtViewIF::showToolbar ()
       
    92         
       
    93         Shows toolbar.
       
    94     */
       
    95     virtual void showToolbar () = 0;
       
    96     
       
    97     /*!
       
    98         \fn int PhoneUIQtViewIF::volumeSliderValue ()
       
    99         
       
   100         Returns HbVolumeSliderPopup's volume value.
       
   101         If this volume slider isn't active -1 is returned.
       
   102     */
       
   103     virtual int volumeSliderValue () = 0;
       
   104     
       
   105     /*!
       
   106         \fn void PhoneUIQtViewIF::removeVolumeSlider ()
       
   107         
       
   108         Removes HbVolumeSliderPopup.
       
   109     */
       
   110     virtual void removeVolumeSlider () = 0;
       
   111 
       
   112     /*!
       
   113         \fn void PhoneUIQtViewIF::setVolumeSliderValue (int value)
       
   114         
       
   115         Sets slider value to HbVolumeSliderPopup.
       
   116     */
       
   117     virtual void setVolumeSliderValue (
       
   118             int value, 
       
   119             int commandId, 
       
   120             int maxVolumeValue, 
       
   121             int minVolumeValue) = 0;
       
   122 
       
   123     /*!
       
   124         \fn void PhoneUIQtViewIF::setExpandAction ()
       
   125         
       
   126         Sets expand action.
       
   127     */
       
   128     virtual void setExpandAction(int bubbleId, int commandId) = 0;
       
   129     
       
   130     /*!
       
   131         \fn void PhoneUIQtViewIF::removeExpandAction ()
       
   132         
       
   133         Removes expand action.
       
   134     */      
       
   135     virtual void removeExpandAction(int bubbleId) = 0;
       
   136 
       
   137     /*!
       
   138         \fn void PhoneUIQtView::showDialpad()
       
   139         
       
   140         Shows dialpad widget.
       
   141     */    
       
   142     virtual void showDialpad() = 0;
       
   143     
       
   144     /*!
       
   145         \fn void PhoneUIQtView::hideDialpad()
       
   146         
       
   147         Hides dialpad widget.
       
   148     */    
       
   149     virtual void hideDialpad() = 0;
       
   150     
       
   151     /*!
       
   152         \fn void PhoneUIQtView::isDialpadVisible()
       
   153         
       
   154         Check is dialpad visible.
       
   155     */    
       
   156     virtual bool isDialpadVisible() = 0;
       
   157 
       
   158     /*!
       
   159         \fn void PhoneUIQtView::dialpadString()
       
   160         
       
   161         Returns content of the dialpad.
       
   162     */  
       
   163     virtual QString dialpadText() = 0;
       
   164     
       
   165     /*!
       
   166         \fn void PhoneUIQtView::dialpadString()
       
   167         
       
   168         Clears and hides dialpad.
       
   169     */
       
   170     virtual void clearAndHideDialpad() = 0;
       
   171     
       
   172     /*!
       
   173         \fn void PhoneUIQtView::clearDialpad()
       
   174         
       
   175         Clears text from dialpad.
       
   176     */
       
   177     virtual void clearDialpad() = 0;
       
   178     
       
   179     /*!
       
   180         \fn void PhoneUIQtView::bringToForeground()
       
   181         
       
   182         Brings to foreground.
       
   183     */
       
   184     virtual void bringToForeground() = 0;
       
   185     
       
   186     /*!
       
   187         \fn void PhoneUIQtViewIF::setToolbarActions()
       
   188         
       
   189        Sets menu actions.
       
   190     */
       
   191     virtual void setMenuActions(const QList<PhoneAction*>& actions) = 0;
       
   192       
       
   193     /*!
       
   194         \fn void PhoneUIQtView::shutdownPhoneApp()
       
   195         
       
   196         Shutdown phone application.
       
   197     */
       
   198     virtual void shutdownPhoneApp() = 0;
       
   199     
       
   200     /*
       
   201        \fn void PhoneUIQtView::setBackButtonVisible()
       
   202        
       
   203        Set the Back command visibility in TitleBar
       
   204     */
       
   205     virtual void setBackButtonVisible(bool visible) = 0;
       
   206 	    
       
   207     /*!
       
   208         \fn void PhoneUIQtViewIF::setToolbarActions()
       
   209         
       
   210        Returns HbMenu reference.
       
   211     */
       
   212     virtual HbMenu &menuReference() = 0;
       
   213     
       
   214     /*!
       
   215         \fn void PhoneUIQtViewIF::captureKey()
       
   216         
       
   217         Captures key.
       
   218     */
       
   219     virtual void captureKey(Qt::Key key, bool capture) = 0;
       
   220     
       
   221     /*
       
   222         \fn void setRestrictedMode()
       
   223         
       
   224         Sets Ui to restricted mode. Decides which keyevent are allowed.
       
   225      */
       
   226     virtual void setRestrictedMode(bool restrictedMode) = 0;
       
   227 };
       
   228 
       
   229 #endif // PHONEUIQTVIEWIF_H