connectionutilities/ConnectionDialogs/cconndlg/inc/ConnDlgPlugin.h
changeset 20 9c97ad6591ae
parent 0 5a93021fdf25
child 41 bbb64eb3bdee
equal deleted inserted replaced
18:fcbbe021d614 20:9c97ad6591ae
    13 *
    13 *
    14 * Description:  Declaration of Generic Connection Dialog Plugins
    14 * Description:  Declaration of Generic Connection Dialog Plugins
    15 *
    15 *
    16 */
    16 */
    17 
    17 
       
    18 
       
    19 // NOTE that the functionality this header contains is DEPRECATED
       
    20 // None on the methods have UI functionality, the plugins complete the requests
       
    21 // immediately when they are started
    18 
    22 
    19 
    23 
    20 #ifndef __CONNDLGPLUGIN_H__
    24 #ifndef __CONNDLGPLUGIN_H__
    21 #define __CONNDLGPLUGIN_H__
    25 #define __CONNDLGPLUGIN_H__
    22 
    26 
    85 
    89 
    86 
    90 
    87 // FORWARD DECLARATION
    91 // FORWARD DECLARATION
    88 class CAknMultiLineDataQueryDialog;
    92 class CAknMultiLineDataQueryDialog;
    89 class CAknQueryDialog;
    93 class CAknQueryDialog;
    90 class CActiveCConnDlgIapPlugin;
       
    91 class CActiveSelectConnectionPlugin;
       
    92 
    94 
    93 // CLASS DECLARATION
    95 // CLASS DECLARATION
    94 
    96 
    95 class TAuthenticationPairBuff
    97 class TAuthenticationPairBuff
    96     {
    98     {
   109     /**
   111     /**
   110     * NewL function
   112     * NewL function
   111     * @param  -
   113     * @param  -
   112     * return CConnDlgIapPlugin*
   114     * return CConnDlgIapPlugin*
   113     */
   115     */
   114     static CConnDlgIapPlugin* NewL( const TBool aResourceFileResponsible );
   116     static CConnDlgIapPlugin* NewL( const TBool /*aResourceFileResponsible*/ );
   115 
   117 
   116     /**
   118     /**
   117     * RegisterL register the client notifier function
   119     * RegisterL register the client notifier function
   118     * @param  -
   120     * @param  -
   119     * return TNotifierInfo
   121     * return TNotifierInfo
   145     /**
   147     /**
   146     * CompleteL the notifier is complete
   148     * CompleteL the notifier is complete
   147     * @param  aStatus status
   149     * @param  aStatus status
   148     * return  -
   150     * return  -
   149     */
   151     */
   150     void CompleteL( TInt aStatus );
   152     void CompleteL( TInt aStatus );   
   151     
       
   152     /**
       
   153     * Sets the preferred iap into db.
       
   154     * calls iActivePlugin    
       
   155     * @param aIAPId id of the preferred iap
       
   156     */
       
   157     void SetPreferredIapIdL( TUint32 aIAPId );
       
   158     
       
   159 private:
       
   160 
       
   161     /**
       
   162     * Gets user connection info.    
       
   163     * @param aIapId id of the iap
       
   164     */ 
       
   165     TInt GetUserConnection( TInt& aIapId );
       
   166     
       
   167     /**
       
   168     * Gets active connection info.    
       
   169     * @param aIapId id of the iap
       
   170     * @param aBearer bearer type
       
   171     */
       
   172     TInt GetActiveConnection( TInt& aIapId, TInt& aBearer );    
       
   173     
   153     
   174 private:
   154 private:
   175     TUint32 iIAP;                       // Internet Access Point
   155     TUint32 iIAP;                       // Internet Access Point
   176     TPckgBuf<TConnectionPrefs> iPrefs;  // Selected preferences
       
   177     CActiveCConnDlgIapPlugin* iActivePlugin;    // pointer to active object
       
   178     };
   156     };
   179 
   157 
   180 
   158 
   181 /**
   159 /**
   182  * Authentication Plugin class
   160  * Authentication Plugin class
   191     * NewL function
   169     * NewL function
   192     * @param  -
   170     * @param  -
   193     * return CConnDlgAuthenticationPlugin*
   171     * return CConnDlgAuthenticationPlugin*
   194     */
   172     */
   195     static CConnDlgAuthenticationPlugin* NewL( 
   173     static CConnDlgAuthenticationPlugin* NewL( 
   196                                         const TBool aResourceFileResponsible );
   174                                         const TBool /*aResourceFileResponsible*/ );
   197 
   175 
   198     /**
   176     /**
   199     * RegisterL register the client notifier function
   177     * RegisterL register the client notifier function
   200     * @param  -
   178     * @param  -
   201     * return TNotifierInfo
   179     * return TNotifierInfo
   223     void Cancel();
   201     void Cancel();
   224 
   202 
   225 public:
   203 public:
   226 
   204 
   227     /**
   205     /**
   228     * GetAuthenticationL() show the Authenticate  dialog
       
   229     * @param  -
       
   230     * return -
       
   231     */
       
   232     void GetAuthenticationL();
       
   233 
       
   234     /**
       
   235     * CompleteL the notifier is complete
   206     * CompleteL the notifier is complete
   236     * @param  aStatus status
   207     * @param  aStatus status
   237     * return  -
   208     * return  -
   238     */
   209     */
   239     void CompleteL( TInt aStatus );
   210     void CompleteL( TInt aStatus );
   240 
       
   241 private:
       
   242     TPckgBuf<TAuthenticationPair> iAuthPair;    // Authentication pair 
       
   243                                                 // (username and password)
       
   244     TPckgBuf<TAuthenticationPairBuff> iAuthPairBuff;    // Authentication pair 
       
   245                                                 // (username and password)
       
   246     CAknMultiLineDataQueryDialog *iDialog;      // Pointer to the dialog
       
   247     };
   211     };
   248 
   212 
   249 
   213 
   250 /**
   214 /**
   251  * Reconnect Plugin class
   215  * Reconnect Plugin class
   259     * NewL function
   223     * NewL function
   260     * @param  -
   224     * @param  -
   261     * return CConnDlgReconnectPlugin*
   225     * return CConnDlgReconnectPlugin*
   262     */
   226     */
   263     static CConnDlgReconnectPlugin* NewL( 
   227     static CConnDlgReconnectPlugin* NewL( 
   264                                         const TBool aResourceFileResponsible );
   228                                         const TBool /*aResourceFileResponsible*/ );
   265 
   229 
   266     /**
   230     /**
   267     * RegisterL register the client notifier function
   231     * RegisterL register the client notifier function
   268     * @param  -
   232     * @param  -
   269     * return TNotifierInfo
   233     * return TNotifierInfo
   291     void Cancel();
   255     void Cancel();
   292 
   256 
   293 public:
   257 public:
   294 
   258 
   295     /**
   259     /**
   296     * GetReconnectL() call the reconnect dialog
       
   297     * @param  -
       
   298     * return -
       
   299     */
       
   300     void GetReconnectL();
       
   301 
       
   302     /**
       
   303     * CompleteL the notifier is complete
   260     * CompleteL the notifier is complete
   304     * @param  aStatus status
   261     * @param  aStatus status
   305     * return  -
   262     * return  -
   306     */
   263     */
   307     void CompleteL(TInt aStatus);
   264     void CompleteL(TInt aStatus);
   308 
       
   309 private:
       
   310     CAknQueryDialog* iDialog;   // Pointer to the dialog
       
   311     TBool iBool;                // Tells if it has to connect to the IAP
       
   312     };
   265     };
   313 
   266 
   314 
   267 
   315 /**
   268 /**
   316  * Quality of service Plugin class
   269  * Quality of service Plugin class
   322     /**
   275     /**
   323     * NewL function
   276     * NewL function
   324     * @param  -
   277     * @param  -
   325     * return CConnDlgReconnectPlugin*
   278     * return CConnDlgReconnectPlugin*
   326     */
   279     */
   327     static CConnDlgQosPlugin* NewL( const TBool aResourceFileResponsible );
   280     static CConnDlgQosPlugin* NewL( const TBool /*aResourceFileResponsible*/ );
   328 
   281 
   329     /**
   282     /**
   330     * RegisterL register the client notifier function
   283     * RegisterL register the client notifier function
   331     * @param  -
   284     * @param  -
   332     * return TNotifierInfo
   285     * return TNotifierInfo
   354     void Cancel();
   307     void Cancel();
   355 
   308 
   356 public:
   309 public:
   357 
   310 
   358     /**
   311     /**
   359     * GetReconnectL() call the reconnect dialog
       
   360     * @param  -
       
   361     * return -
       
   362     */
       
   363     void GetReconnectL();
       
   364 
       
   365     /**
       
   366     * CompleteL the notifier is complete
   312     * CompleteL the notifier is complete
   367     * @param  aStatus status
   313     * @param  aStatus status
   368     * return  -
   314     * return  -
   369     */
   315     */
   370     void CompleteL( TInt aStatus );
   316     void CompleteL( TInt aStatus );
   371 
       
   372 private:
       
   373     CAknQueryDialog* iDialog;   // Pointer to the dialog
       
   374     TBool iBool;                // Tells if it has to connect to the IAP
       
   375     };
   317     };
   376 
   318 
   377 
   319 
   378 /**
   320 /**
   379  * New IAP Plugin class
   321  * New IAP Plugin class
   385     /**
   327     /**
   386     * NewL function
   328     * NewL function
   387     * @param  -
   329     * @param  -
   388     * return CConnDlgNewIapPlugin*
   330     * return CConnDlgNewIapPlugin*
   389     */
   331     */
   390     static CConnDlgNewIapPlugin* NewL( const TBool aResourceFileResponsible );
   332     static CConnDlgNewIapPlugin* NewL( const TBool /*aResourceFileResponsible*/ );
   391 
   333 
   392     /**
   334     /**
   393     * RegisterL register the client notifier function
   335     * RegisterL register the client notifier function
   394     * @param  -
   336     * @param  -
   395     * return TNotifierInfo
   337     * return TNotifierInfo
   417     void Cancel();
   359     void Cancel();
   418 
   360 
   419 public:
   361 public:
   420 
   362 
   421     /**
   363     /**
   422     * GetNewIapL show NewIap dialog
       
   423     * @param  -
       
   424     * return  -
       
   425     */
       
   426     void GetNewIapL();
       
   427 
       
   428     /**
       
   429     * CompleteL the notifier is complete
   364     * CompleteL the notifier is complete
   430     * @param  aStatus status
   365     * @param  aStatus status
   431     * return  -
   366     * return  -
   432     */
   367     */
   433     void CompleteL( TInt aStatus );
   368     void CompleteL( TInt aStatus );
   434 
       
   435 private:
       
   436     CAknQueryDialog* iDialog;                   // Pointer to the dialog
       
   437     TBool iConnect;                             // Tells if it has to connect 
       
   438                                                 // to the IAP
       
   439     TPckgBuf<TNewIapConnectionPrefs> iPrefs;    // Selected preferences
       
   440     };
   369     };
   441 
   370 
   442 
   371 
   443 
   372 
   444 /**
   373 /**
   452     * NewL function
   381     * NewL function
   453     * @param  -
   382     * @param  -
   454     * return CConnDlgSelectConnectionPlugin*
   383     * return CConnDlgSelectConnectionPlugin*
   455     */
   384     */
   456     static CConnDlgSelectConnectionPlugin* NewL( 
   385     static CConnDlgSelectConnectionPlugin* NewL( 
   457                                         const TBool aResourceFileResponsible );
   386                                         const TBool /*aResourceFileResponsible*/ );
   458 
   387 
   459     /**
   388     /**
   460     * RegisterL register the client notifier function
   389     * RegisterL register the client notifier function
   461     * @param  -
   390     * @param  -
   462     * return TNotifierInfo
   391     * return TNotifierInfo
   463     */
   392     */
   464     TNotifierInfo RegisterL();
   393     TNotifierInfo RegisterL();
   465 
   394 
   466     /**
   395     /**
   467     * Start the Notifier
   396     * Start the Notifier
   468     * @param  aBuffer    Buffer
   397     * @param  aBuffer    Buffer
   469     * @param  aReplySlot Identifies which message argument to use for the 
   398     * @param  aReplySlot Identifies which message argument to use for the 
   470     *                    reply. This message argument will refer to a 
   399     *                    reply. This message argument will refer to a 
   471     *                    modifiable descriptor, a TDes8 type, into which data
   400     *                    modifiable descriptor, a TDes8 type, into which data
   472     *                    can be returned. 
   401     *                    can be returned. 
   473     * @param  aMessage   Message
   402     * @param  aMessage   Message
   474     * return -
   403     * return -
   475     */
   404     */
   476     void StartL( const TDesC8& aBuffer, TInt aReplySlot, 
   405     void StartL( const TDesC8& /*aBuffer*/, TInt aReplySlot, 
   477                  const RMessagePtr2& aMessage );
   406                  const RMessagePtr2& aMessage );
   478 
   407 
   479     /**
   408     /**
   480     * Cancel() the notifier
   409     * Cancel() the notifier
   481     * @param  -
   410     * @param  -
   489     * CompleteL the notifier is complete
   418     * CompleteL the notifier is complete
   490     * @param  aStatus status
   419     * @param  aStatus status
   491     * return  -
   420     * return  -
   492     */
   421     */
   493     void CompleteL( TInt aStatus );
   422     void CompleteL( TInt aStatus );
   494     
       
   495     /**
       
   496     * Sets the preferred iap into db.
       
   497     * calls iActivePlugin    
       
   498     * @param aIAPId id of the preferred iap
       
   499     * @param aDestinationId id of the preferred Destination
       
   500     */
       
   501     void SetElementIDL( TUint32 aIAPId, TUint32 aDestinationId );
       
   502     
       
   503 private:
       
   504 
       
   505     /**
       
   506     * Gets user connection info.    
       
   507     * @param aIapId id of the iap
       
   508     * @param aSnapId id of the destination
       
   509     */
       
   510     TInt GetUserConnection( TInt& aIapId, TInt& aSnapId );
       
   511     
       
   512     /**
       
   513     * Gets active connection info.    
       
   514     * @param aIapId id of the iap
       
   515     * @param aSnapId id of the destination
       
   516     * @param aBearer bearer type
       
   517     */    
       
   518     TInt GetActiveConnection( TInt& aIapId, TInt& aSnapId, TInt& aBearer );
       
   519 
   423 
   520 private:
   424 private:
   521     TUint32 iElementID;
   425     TUint32 iElementID;
   522     TPckgBuf<TConnectionPrefs> iPrefs;  // Selected preferences
       
   523     CActiveSelectConnectionPlugin* iActivePlugin;   // pointer to active object
       
   524     };
   426     };
   525 
   427 
   526 #endif
   428 #endif
   527 
   429 
   528 // End of File
   430 // End of File