ufinder.hpp

/* ==================================================== ======== ======= *
*
*  ufinder.hpp
*  Ubit Project
*  Author: Eric Lecolinet
*  Part of the Ubit Toolkit: A Brick Construction Game Model for Creating GUIs
*  (C) 1999-2006 Eric Lecolinet / ENST Paris / http://www.enst.fr/~elc/ubit
*
* ***********************************************************************
* COPYRIGHT NOTICE :
* THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY AND WITHOUT EVEN THE
* IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
* YOU CAN REDISTRIBUTE IT AND/OR MODIFY IT UNDER THE TERMS OF THE GNU
* GENERAL PUBLIC LICENSE AS PUBLISHED BY THE FREE SOFTWARE FOUNDATION;
* EITHER VERSION 2 OF THE LICENSE, OR (AT YOUR OPTION) ANY LATER VERSION.
* SEE FILES 'COPYRIGHT' AND 'COPYING' FOR MORE DETAILS.
* ***********************************************************************
* ==================================================== [-c-Elc] ======= *
* ==================================================== ======== ======= */

#ifndef _ufinder_hpp_
#define _ufinder_hpp_
//pragma ident  "@(#)ufinder.hpp        ubit:05.05.00"
#include <ubit/ubox.hpp>
#include <ubit/umenu.hpp>
#include <ubit/udoc.hpp>
#include <ubit/uicon.hpp>
namespace ubit {

 class UFinderDir;
 class UFinderHost;
 class UFinderFullwin;
 class UFinderControls;
 class UFinderCom;

/* ==================================================== ===== ======= */
struct UFinderListener {
  virtual ~UFinderListener() {}
  virtual void fileRequest(const UStr& pathname) {}
  virtual void docLoaded(const UStr& pathname, UDoc*) {}
  virtual void docShown(const UStr& pathname, UDoc*) {}
  virtual void dirLoaded(const UStr& pathname) {}
  virtual void dirShown(const UStr& pathname) {}
};

/* ==================================================== ===== ======= */
class UFinder : public UBox {
public:
  UBIT_ELEMENT_CLASS(UFinder, UBox)

  struct Options : UGroup {
    friend class UFinder;
    Options();
    UWidth        clone_frame_width;
    UHeight       clone_frame_height;
    UBackground   default_background;
    UColor        default_color;
    UWidth        controls_width;
    UHeight       controls_folder_height;
    bool          show_icon_images;
  };

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  UFinder(const UStr& pathname = ".");
  virtual ~UFinder();
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  virtual void open(const UStr& pathname);

  virtual void openParent();
  virtual void openEntry();  
  virtual void nextEntry();
  virtual void previousEntry();

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  virtual bool browseHosts();
  virtual UFinderHost* addHost(const UStr& hostname, int pos = -1);
  virtual UFinderHost* addHostCB(const UStr* hostname, int pos = -1);
  virtual void removeHost(UFinderHost*);
  virtual void addHosts(const std::vector<UStr*>& hostnames);
  virtual void addHosts(const char* hostnames[]);

  virtual void createClone(const UStr& hostname);

  // virtual void compactEvents(bool = true);
  // compact events to avoid delays.

  virtual void setTracking(bool);
  virtual void setTracking(bool doc, bool icons);

  virtual UFinderListener* getListener();
  virtual void setListener(UFinderListener*);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  Options& getOptions() {return opts;}
  
  UDocbox*     getCurrentBox();
  UIconbox*    getIconbox()   {return selected_iconbox;}
  UIcon*       getSelectedIcon();

  UDocbox*     getDocbox()    {return &docpane;}
  UDoc*        getDoc()       {return &document;}

  UBox*        getGlass()  {return &docglass;}

  virtual void zoom(float zoom = 1.);
  virtual void zoomIn();
  virtual void zoomOut();
  virtual void setZoomQuantum(float);
    
  UCtlmenu& getContextMenu() {return *ctlmenu;}
  
  virtual void openContextMenuIn(UBox&);
  virtual UCtlmenu& createContextMenu();

  void showDocGlass(bool state);

  void showSideBar(bool state);

  void showAlert(const UStr& msg);
  void hideAlert();
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
protected:

  // documents.
  void openFBox(UFilebox&);
  void openMsg(UMessageEvent&);
  virtual void openImpl(const UStr& path, int path_mode, int path_type);
  virtual int openFile(const UStr& path, int path_type);
  virtual int openDir(const UStr& path, int path_type);
  virtual int openDir(UFinderDir*);
  virtual void showFile(const UStr& path, UDoc*);
  virtual void showDir(const UStr& path);
  virtual void showPreview(UIcon*);
  virtual void showPreviewRequest(UIcon*);
  virtual void showIconPreviews();  
  
  // dirs and icons.
  virtual void addToHistory(UFinderDir*);
  virtual void removeFromHistory(UFinderDir*);
  virtual UFinderDir* findDir(const UStr& path);
  virtual void showDirInfo(UFinderDir*);
  virtual void removeIconbox(UFinderDir*, bool upd);
  virtual void iconSelectCB(UIconbox*);
  virtual void iconActionCB(UIconbox*);
  virtual void elementAction(UEvent&, UDoc*);

  // hosts and clones.
  virtual void browseCB(UMessageEvent&);
  bool isBrowsing() const;
  virtual void createCloneRequest(UMessageEvent&);
  virtual UFrame* createCloneFrame(const UStr& title);
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

private:
  static UPix& doc_pix;
  enum {NoMode, DirMode, DocMode} mode;
  bool is_tracking, open_in_fullwin; //is_compactevents
  Options opts;
  UVbox main_panel;
  UDialog ask_dialog;
  UStr ask_dialog_msg;
  UFlagdef title_location;
  uptr<UDoc> document;
  uptr<UBox> docglass;
  uptr<UDocbox> docpane;
  uptr<UBox> iconbox_panel;
  UFinderListener* listener;
  uptr<UFinderControls> ctrls;
  uptr<UAlertbox> alertbox;
  uptr<UCtlmenu>  ctlmenu;
  UMService *local_ums, *remote_ums;
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // current selection
  uptr<UIconbox>  selected_iconbox;
  uptr<UFinderDir>last_direntry;
  UIcon* last_preview_request;
  UIcon* last_preview;
  UChildIter previews_current, previews_end;
  uptr<UTimer> preview_timer;

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // friends
  friend class UFinderDir;
  friend class UFinderHost;
  friend class UFinderFullwin;
  friend class UFinderControls;
  friend class UFinderCom;
};

}
#endif
/* ==================================================== [TheEnd] ======= */
/* ==================================================== [(c)Elc] ======= */

---