1 /*

     2 * Copyright (c) 2004 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 the License "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:  File-name related utility methods.

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef FILENAMEUTIL_H

    21 #define FILENAMEUTIL_H

    22 

    23 

    24 //  INCLUDES

    25 #include <e32std.h>

    26 

    27 

    28 // CLASS DECLARATION

    29 

    30 /**

    31 * A static class which provides file-name related utility methods.

    32 *

    33 * @lib BrowserEngine

    34 * @since 2.6

    35 */

    36 class FileNameUtils

    37     {

    38     public:  // Constructors and destructor

    39         // None.

    40 

    41     public:  // New functions

    42 

    43         /**

    44         * Gets the localized file name, in full, which includes the path but

    45         * not the drive. This is intended for use as a displayable path and

    46         * as such the drive is not included since drive letters are never shown

    47         * to the user.

    48         *

    49         * @since 2.6

    50         * @param aFullFileName Ptr to file name that is to be localized.

    51         * @param aLocalizedFullFileName Ptr into which the localized file name

    52         *   is returned, which is a pointer to a newly allocated heap buffer.

    53         *   The caller is responsible for deallocating the buffer when it is no

    54         *   longer needed.

    55         * @return KBrsrSuccess, KBrsrOutOfMemory or KBrsrFailure.

    56         */

    57         static TBrowserStatusCode GetLocalizedFullFileName( TPtrC& aFullFileName,

    58             HBufC** aLocalizedFullFileName );

    59 

    60     };

    61 

    62 #endif      // FILENAMEUTIL_H

    63 

    64 // End of File