CascadeDirBrowser.h

Go to the documentation of this file.

//
// CascadeDirBrowser.h - interface of class CascadeDirBrowser
//
// Copyright (c) 2003, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_UTIL_CASCADEDIRBROWSER_H
#define _ROKU_INCLUDE_CASCADE_UTIL_CASCADEDIRBROWSER_H

#include <cascade/app/CascadeWindow.h>
#include <cascade/widgets/CascadeButtonWidget.h>
#include <cascade/util/CascadeFSObject.h>
#include <cascade/util/CascadeDirectory.h>

class CascadeDirBrowser : public CascadeWindow
{
public:
    typedef enum CallbackReason
    {
        eOK,
        eCancel
    };

    typedef enum SelectableObjectType
    {
        eFiles,
        eDirectories,
        eBoth
    };

public:
    CascadeDirBrowser();
    
    virtual ~CascadeDirBrowser();

    typedef void (BrowseDirectoryCallback)( const CascadeString & inPath,
                                            CallbackReason inReason,
                                            void * pClientData );

    virtual bool BrowseDirectory( const CascadeString & inTitle,
                                  const CascadeString & inPath,
                                  const CascadeString & inRoot,
                                  const CascadeString & inName,
                                  CascadeFSObject::Selector *inDirSelector,
                                  CascadeFSObject::Selector *inFileSelector,
                                  SelectableObjectType inType,
                                  BrowseDirectoryCallback *inCallback,
                                  void *inClientData );

    // Overrides of CascadeWindow functions
    virtual void OnPaint(CascadeBitmap &bitmap);
    virtual void OnMaterialize();
    virtual void OnVanish();
    virtual bool OnKeyDown(u32 nKey);
    virtual void OnSetFocus();
    virtual bool OnNavKey(u32 nKey, CascadeWindow *&pProposedNewFocusWnd);
    virtual bool WillAcceptFocus() { return true; }

protected:
    void    Back();
    void    Top();
    
    
    // Special button class to allow navigation through list of
    // un-selectable items.
    class BrowserButton : public CascadeButtonWidget
    {
    public:
        BrowserButton() 
        { 
            mUnselectableFocusBitmap = NULL; 
            mUnselectableUnfocusedBitmap = NULL;
            mbSelectable = true;
        }
        void SetUnselectableFocusBitmap( CascadeBitmap *inBitmap )
            { mUnselectableFocusBitmap = inBitmap; }
        void SetUnselectableUnfocusedBitmap( CascadeBitmap *inBitmap )
            { mUnselectableUnfocusedBitmap = inBitmap; }
        void SetSelectable( bool inSelectable )
            { mbSelectable = inSelectable; }
        bool IsSelectable( void ) { return mbSelectable; }
    protected:
        virtual void OnPaint(CascadeBitmap &bitmap);
        virtual bool OnKeyDown( u32 nKey );
        CascadeBitmap *mUnselectableFocusBitmap;
        CascadeBitmap *mUnselectableUnfocusedBitmap;
        bool mbSelectable;
    };

    // Setup & utility
    bool    Setup( void );
    void    SetupButton( CascadeButtonWidget &button,
                         CascadeBitmap &normalBitmap,
                         CascadeBitmap &highlightBitmap,
                         CascadeBitmap &disabledBitmap,
                         CascadeRect &rect,
                         const char *text );
    void    SetupDirButton( BrowserButton & button,
                            CascadeBitmap &normalBitmap,
                            CascadeBitmap &highlightBitmap );
    void    SetupContents( void );
    void    ScrollUp();
    void    ScrollDown();
    void    PaintContents( CascadeBitmap &inBitmap, CascadeRect &inRect );
    bool    SetDirectory( const CascadeString & inPath );
    static void    ButtonCallback( const CascadeButtonWidget * pButton, 
                                   const CascadeButtonWidget::State & newState, 
                                   void * pClientData );
    static void    DirButtonCallback(
        const CascadeButtonWidget * pButton, 
        const CascadeButtonWidget::State & newState, 
        void * pClientData );
    void    ClearContents();

    // Notification
    BrowseDirectoryCallback *mCallbackFunction;
    void *mCallbackClientData;
    CallbackReason mReason;

    // Dialog title
    CascadeString   mTitle;

    // File scanning
    CascadeFSObject::Selector *mFileSelector;
    CascadeFSObject::Selector *mDirSelector;
    SelectableObjectType mType;

    // Directory and its contents
    CascadeDirectory mRootDirectory;
    CascadeDirectory mCurDirectory;
    CascadeString mCurSelection;
    CascadeString mName;
    CascadeTemplateArray<CascadeFSObject *> *mContents;
    u32 mFileCount;
    u32 mDirCount;
    bool mFileSelected;

    // List management
    u32 mFirstVisibleIdx;
    u32 mVisibleButtonCount;

    // Graphics
    CascadeFont mPathFont;
    CascadeFont mContentsHeadingFont;
    CascadeFont mContentsFont;
    CascadeFont mListFont;
    CascadeBitmap mBackground;
    CascadeBitmap mButtonNormal;
    CascadeBitmap mButtonHighlight;
    CascadeBitmap mButtonDisabled;
    CascadeBitmap mTopButtonNormal;
    CascadeBitmap mTopButtonHighlight;
    CascadeBitmap mBackButtonNormal;
    CascadeBitmap mBackButtonHighlight;
    CascadeBitmap mDirectoryButtonNorm;
    CascadeBitmap mDirectoryButtonHi;
    CascadeBitmap mFileButtonUnselectNorm;
    CascadeBitmap mFileButtonUnselectHi;
    CascadeBitmap mScrollUpArrow;
    CascadeBitmap mScrollDownArrow;
    CascadeButtonWidget mTopButton;
    CascadeButtonWidget mBackButton;
    CascadeButtonWidget mSelectButton;
    CascadeButtonWidget mCancelButton;
    BrowserButton **mDirButtons;
    bool mbSetup;

    // Focus tracking
    CascadeButtonWidget *mFocusLeftButton;
    CascadeButtonWidget *mFocusRightButton;
    CascadeButtonWidget *mFocusButton;

private:
    // HACK HACK HACK
    void PWContents( void );
    CascadeBitmap mPWBitmap;
};

#endif //_ROKU_INCLUDE_CASCADE_UTIL_CASCADEDIRBROWSER_H

// CHANGE HISTORY
// ==============
// 07/29/2003   mjkobb  Created CascadeDirBrowser
// 08/11/2003   mjkobb  Updated functionality to allow file selection
// 09/12/2003   mjkobb  Add disabled button bitmap & OnKeyDown override
// 10/09/2003   mjkobb  Added mbSetup bool so we can re-use a browser

---