class CCL::Browser
Overview
#include <browser.h> class Browser: public CCL::Component, public CCL::INavigationServer, public CCL::CommandDispatcher { public: // enums enum BrowserStyles; // classes class ExpandState; class SearchResultList; class SettingsSaver; // fields StringRef title = nullptr); kShowListView; showListView kCanSetRoot; showListView canSetRoot kCanRefresh; showListView canSetRoot canRefresh kHasListMode; showListView canSetRoot canRefresh hasListMode scrollStyle; showListView canSetRoot canRefresh hasListMode ScrollStyle listStyle; SuperClass; INavigationServer; // methods DECLARE_CLASS (Browser, Component); PROPERTY_FLAG (browserStyle, kDisplayTreeLeafs, displayTreeLeafs); showListView PROPERTY_FLAG (browserStyle, kPersistentStates, persistentStates); showListView canSetRoot PROPERTY_FLAG (browserStyle, kCanAddTabs, canAddTabs); showListView canSetRoot canRefresh PROPERTY_FLAG ( browserStyle, kHideColumnHeaders, hideColumnHeaders ); showListView canSetRoot canRefresh hasListMode PROPERTY_FLAG ( browserStyle, kResultListHideCategories, resultListHideCategories ); showListView canSetRoot canRefresh hasListMode ScrollStyle PROPERTY_OBJECT ( StyleFlags, treeStyle, TreeStyle ); showListView canSetRoot canRefresh hasListMode ScrollStyle ListStyle PROPERTY_MUTABLE_CSTRING ( formName, FormName ); PROPERTY_BOOL (trackingEnabled, TrackingEnabled); void setTopMostNode (BrowserNode* node); BrowserNode* getTopMostNode (); BrowserNode* getTreeRoot (); bool setTreeRoot ( BrowserNode* node, bool preserveExpandState, bool updateStateName ); void addSearch (); void addBreadcrumbs (); virtual void addBrowserNode (BrowserNode* node); void clearNodes (); void addBrowserState (BrowserNode& node); void setDefaultColumns (IColumnHeaderList* columns); void updateColumns (); void setNodeFilter (IObjectFilter* filter); void setSearchProvider (ISearchProvider* provider); ISearchProvider* getSearchProvider () const; void setSearchIcon (IImage* icon); BrowserNode* getFocusNode (bool includeSearchResults = false) const; bool setFocusNode (BrowserNode* node, bool selectExclusive = true); bool setTreeFocusNode (BrowserNode* node, bool selectExclusive = true); bool setListFocusNode (BrowserNode* node, bool selectExclusive = true); BrowserNode* getListParentNode () const; void selectAll (bool state); void selectNode (BrowserNode* node, bool state = true); bool isAnyNodeSelected () const; virtual void onNodeRemoved (BrowserNode* node); void getEditNodes (Container& editNodes, BrowserNode* focusNode); void expandAll (bool state = true, bool deferred = false); void expandNode (BrowserNode* node, bool state = true); bool isNodeExpanded (BrowserNode& node) const; bool wasExpanded (BrowserNode* node) const; bool isNodeVisible (BrowserNode& node) const; virtual bool openNode (BrowserNode* node); bool insertNode (BrowserNode* parent, BrowserNode* node, int index = -1); bool removeNode (BrowserNode* node); void redrawNode (BrowserNode* node); void refreshNode (BrowserNode* node, bool keepExpandState = false); void refreshAll (bool deferred); void updateThumbnail (BrowserNode* node); void setActivityIndicatorState (bool state); Object* createSnapshot () const; bool restoreSnapshot (Object* snapshot); bool isRestoringState () const; bool& getRestoringState (); void resetScrollState (); void trackInteraction () const; IUnknown* findNode ( const IRecognizer* recognizer, const BrowserNode* startNode = nullptr ) const; template <class T> T* findNode ( const IRecognizer* recognizer, const BrowserNode* startNode = nullptr ) const; BrowserNode* findNode (StringID path, bool create, bool acceptAncestor = false); BrowserNode* findNodeWithBreadcrumbsPath (StringID path); BrowserNode* findNodeInSearchResults (UrlRef path) const; bool makePath ( MutableCString& path, BrowserNode* node, BrowserNode* startNode = nullptr ) const; MutableCString makePath (BrowserNode* node, BrowserNode* startNode = nullptr) const; bool makeDisplayPath ( String& displayPath, BrowserNode* node, BrowserNode* startNode = nullptr ) const; virtual BrowserNode* findNodeWithUrl (UrlRef url); BrowserNode* findNode (IView* view, const Point& where); void createChildNodes (BrowserNode& node); IUnknownIterator* iterateChildNodes (BrowserNode& node) const; BrowserNode* navigate ( BrowserNode& startNode, int increment, IObjectFilter* filter = nullptr ); BrowserNode* resolveNode (IItemView& itemView, ItemIndexRef index) const; IItemView* getTreeView () const; IItemView* getListView () const; IWindow* getWindow (); bool isVisible () const; bool isListMode () const; void setDefaultListMode (bool state = true); Styles::ListViewType getListViewType () const; void setListViewType (Styles::ListViewType viewType); bool isDragSource (IDragSession& session); DECLARE_STRINGID_MEMBER (kNodeFocused); void addExtension (IBrowserExtension* extension); void addExtensionPlugIns (StringRef category); virtual tresult CCL_API navigateTo (NavigateArgs& args); virtual tresult CCL_API initialize (IUnknown* context); virtual tresult CCL_API terminate (); virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const; virtual IUnknown*CCL_API getObject (StringID name, UIDRef classID); virtual IView*CCL_API createView ( StringID name, VariantRef data, const Rect& bounds ); virtual tresult CCL_API appendContextMenu (IContextMenu& contextMenu); virtual tbool CCL_API paramChanged (IParameter* param); virtual void CCL_API notify (ISubject* subject, MessageRef msg); virtual bool load (const Storage& storage); virtual bool save (const Storage& storage) const; bool onAscendRoot (CmdArgs args); bool onResetRoot (CmdArgs args); bool onNewTab (CmdArgs args); bool onNewRootTab (CmdArgs args); bool onCloseTab (CmdArgs args); bool onRenameTab (CmdArgs args); bool onRefresh (CmdArgs args); bool onInsertSelectedItem (CmdArgs args); bool onNavigationNext (CmdArgs args); bool onNavigationEnter (CmdArgs args); bool onNavigationBack (CmdArgs args); DECLARE_COMMANDS (Browser); template <class NodeClass, class Lambda> static void visitEditNodes ( BrowserNode* focusNode, const Container* nodes, const Lambda& visit ); };
Inherited Members
public: // typedefs typedef CStringRef MemberID; // enums enum Flags; // structs struct ObjectEntry; // fields IObjectNode; StringRef title = nullptr); kMutable; UIDRef classID override; CLASS_INTERFACES (ObjectNode) protected String title; ParamContainer paramList; SignalSlotList signalSlots; LinkedList <ObjectEntry> objects; // methods virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0; virtual unsigned int CCL_API retain () = 0; virtual unsigned int CCL_API release () = 0; Unknown& operator = (const Unknown&); unsigned int getRetainCount () const; virtual Object*CCL_API revealObject (const void* moduleAddress) = 0; virtual void CCL_API addObserver (IObserver* observer) = 0; virtual void CCL_API removeObserver (IObserver* observer) = 0; virtual void CCL_API signal (MessageRef msg) = 0; virtual void CCL_API deferSignal (IMessage* msg) = 0; static ISubject void addObserver (IUnknown* unknown, IObserver* observer); static void removeObserver (IUnknown* unknown, IObserver* observer); virtual void CCL_API notify (ISubject* subject, MessageRef msg) = 0; static IObserver void notify ( IUnknown* unknown, ISubject* subject, MessageRef msg ); virtual const ITypeInfo&CCL_API getTypeInfo () const = 0; virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const = 0; virtual tbool CCL_API setProperty (MemberID propertyId, const Variant& var) = 0; virtual tbool CCL_API getPropertyNames (IPropertyCollector& collector) const = 0; virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg) = 0; DECLARE_BASE_CLASS (Object); virtual void CCL_API removeObserver (IObserver* observer); virtual void CCL_API signal (MessageRef msg); virtual void CCL_API deferSignal (IMessage* msg); virtual void deferChanged (); virtual void CCL_API notify (ISubject* subject, MessageRef msg); virtual bool equals (const Object& obj) const; virtual int compare (const Object& obj) const; virtual bool load (const Storage& storage); virtual bool save (const Storage& storage) const; virtual bool save (const OutputStorage& storage) const; virtual bool toString (String& string, int flags = 0) const; virtual int getHashCode (int size) const; IUnknown* asUnknown (); static void addGarbageCollected (Object* obj, bool globalScope = true); static void deferDestruction (Object* obj); static const void* getModuleAddress (); virtual StringRef CCL_API getObjectID () const = 0; virtual UIDRef CCL_API getObjectUID () const = 0; virtual UIDRef CCL_API getClassUID () const = 0; virtual IObjectNode*CCL_API getParent () const = 0; virtual IObjectNode*CCL_API getRoot () const = 0; virtual int CCL_API countChildren () const = 0; virtual IObjectNode*CCL_API getChild (int index) const = 0; virtual IObjectNode*CCL_API findChild (StringRef id) const = 0; virtual tbool CCL_API getChildDelegates (IMutableArray& delegates) const = 0; virtual tbool CCL_API getChildPath (String& path) const = 0; virtual IObjectNode*CCL_API lookupChild (StringRef path) const = 0; virtual StringRef CCL_API getObjectID () const; virtual UIDRef CCL_API getObjectUID () const; virtual UIDRef CCL_API getClassUID () const; virtual IObjectNode*CCL_API getParent () const; virtual IObjectNode*CCL_API getRoot () const; virtual int CCL_API countChildren () const; virtual IObjectNode*CCL_API getChild (int index) const; virtual IObjectNode*CCL_API findChild (StringRef id) const; virtual tbool CCL_API getChildDelegates (IMutableArray& delegates) const; virtual tbool CCL_API getChildPath (String& path) const; virtual IObjectNode*CCL_API lookupChild (StringRef path) const; DECLARE_CLASS (ObjectNode, Object); void setName (StringRef name); bool setUniqueName (StringRef name); StringRef getName () const; virtual Iterator* newIterator () const; virtual bool addChild (ObjectNode* child); virtual bool insertChild (int index, ObjectNode* child); virtual bool addChildSorted (ObjectNode* child); virtual bool removeChild (ObjectNode* child); virtual void removeAll (); virtual ObjectNode* findChildNode (StringRef id) const; virtual ObjectNode* findChildNode (MetaClassRef typeID) const; template <class T> T* findChildNode (StringRef id) const; template <class T> T* findChildNode () const; template <class T> T* getChildNode (int index) const; template <class I> I* findChildByInterface (bool deep = false) const; ObjectNode* getChildNode (int index) const; int getChildIndex (const ObjectNode* child) const; virtual StringRef getChildID (const ObjectNode* child) const; ObjectNode* getParentNode () const; template <class T> T* getParentNode () const; bool getRelativePath (String& path, ObjectNode* subNode) const; void signalDeep (MessageRef msg, bool recursive = false); virtual void notifyChildren ( ISubject* subject, MessageRef msg, bool recursive = false ); tresult queryChildInterface (UIDRef iid, void** ptr, bool recursive = false); template <class Lambda> bool visitChildren ( const Lambda& visitLambda, bool recursive ) const; void dump (int level = 0); virtual StringRef CCL_API getObjectID () const; virtual UIDRef CCL_API getObjectUID () const; virtual UIDRef CCL_API getClassUID () const; virtual IObjectNode*CCL_API getParent () const; virtual IObjectNode*CCL_API getRoot () const; virtual int CCL_API countChildren () const; virtual IObjectNode*CCL_API getChild (int index) const; virtual IObjectNode*CCL_API findChild (StringRef id) const; virtual tresult CCL_API initialize (IUnknown* context = nullptr) = 0; virtual tresult CCL_API terminate () = 0; virtual tbool CCL_API canTerminate () const = 0; virtual IUnknown*CCL_API getExtension (StringID id) = 0; template <typename IFace> IFace* getExtensionI (); template <typename IFace> static IFace* getExtensionI (IUnknown* unk); virtual int CCL_API countParameters () const = 0; virtual IParameter*CCL_API getParameterAt (int index) const = 0; virtual IParameter*CCL_API findParameter (StringID name) const = 0; virtual IParameter*CCL_API getParameterByTag (int tag) const = 0; virtual IUnknown*CCL_API getObject (StringID name, UIDRef classID) = 0; virtual tbool CCL_API paramChanged (IParameter* param) = 0; virtual void CCL_API paramEdit (IParameter* param, tbool begin) = 0; virtual IView*CCL_API createView ( StringID name, VariantRef data, const Rect& bounds ) = 0; virtual tbool CCL_API checkCommandCategory (CStringRef category) const = 0; virtual tbool CCL_API interpretCommand (const CommandMsg& msg) = 0; virtual tresult CCL_API appendContextMenu (IContextMenu& contextMenu) = 0; DECLARE_CLASS (Component, ObjectNode); PROPERTY_FLAG (flags, kStorable, isStorable); isMutable StringRef getTitle () const; void setTitle (StringRef title); bool hasTitle () const; IUnknown* getContext () const; Component* getComponent (StringRef name) const; template <class C> C* getComponent (StringRef name) const; bool addComponent (Component* c); bool addIComponent (IComponent* c); void signalHasChild (Component* c); Component* lookupComponent (StringRef path) const; template <class C> C* lookupComponent (StringRef path) const; virtual tresult CCL_API initialize (IUnknown* context = nullptr); virtual tresult CCL_API terminate (); virtual tbool CCL_API canTerminate () const; virtual IUnknown*CCL_API getExtension (StringID id); DECLARE_PARAMETER_LOOKUP (paramList); virtual tbool CCL_API paramChanged (IParameter* param); virtual void CCL_API paramEdit (IParameter* param, tbool begin); virtual IView*CCL_API createView ( StringID name, VariantRef data, const Rect& bounds ); virtual tbool CCL_API checkCommandCategory (CStringRef category) const; virtual tbool CCL_API interpretCommand (const CommandMsg& msg); virtual tresult CCL_API appendContextMenu (IContextMenu& contextMenu); virtual ITheme* getTheme () const; virtual bool load (const Storage& storage); virtual bool save (const Storage& storage) const; virtual bool toString (String& string, int flags) const; void addObject (StringID name, IUnknown* object); void addObject (StringID name, Object* object); bool loadIdentity (const Storage& storage); bool saveIdentity (const Storage& storage) const; bool loadChild (const Storage& storage, Component& child); bool saveChild (const Storage& storage, const Component& child) const; bool loadChildren ( const Storage& storage, bool loadEmpty = false, bool onlyStorable = false ); bool saveChildren (const Storage& storage, bool onlyStorable = false) const; void signalHasChild (StringRef name); void signalPropertyChanged (StringID propertyID, bool deferred = false); void propertyChanged (StringID propertyID); IUnknown* resolveToOriginalContext (IUnknown* context); virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const; virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg); virtual tresult CCL_API navigateTo (NavigateArgs& args) = 0; bool dispatchCommand (const CommandMsg& msg); bool dispatchCommand ( const CommandMsg& msg, CommandDispatchEntry <T> dispatchTable [] ); bool dispatchCommandWithAliases (const CommandMsg& msg);
Detailed Documentation
Methods
PROPERTY_BOOL (trackingEnabled, TrackingEnabled)
the root of the whole node hierarchy
void setTopMostNode (BrowserNode* node)
the topmost node that can become tree root; must be a child of root, must not be removed!
BrowserNode* getTreeRoot ()
the current root in the tree
void setSearchProvider (ISearchProvider* provider)
takes ownership
void getEditNodes (Container& editNodes, BrowserNode* focusNode)
adds all selected nodes if focusNode is selected, otherwise only focusNode
virtual bool openNode (BrowserNode* node)
user has double-clicked or pressed [Return]
bool insertNode (BrowserNode* parent, BrowserNode* node, int index = -1)
browser owns the node
bool removeNode (BrowserNode* node)
node gets released
void setActivityIndicatorState (bool state)
can be used by nodes to indicate background activity
BrowserNode* findNode (StringID path, bool create, bool acceptAncestor = false)
find a node by it’s path; acceptAncestor: return deepest ancestor if node not found
virtual BrowserNode* findNodeWithUrl (UrlRef url)
find a node with given url
BrowserNode* findNode (IView* view, const Point& where)
find a node on screen
void createChildNodes (BrowserNode& node)
ensure that child nodes have been created
IUnknownIterator* iterateChildNodes (BrowserNode& node) const
iterate existing child nodes of given node
BrowserNode* navigate ( BrowserNode& startNode, int increment, IObjectFilter* filter = nullptr )
navigate to a previous / next node
void setListViewType (Styles::ListViewType viewType)
default: icons
bool isDragSource (IDragSession& session)
check if browser started the drag operation
DECLARE_STRINGID_MEMBER (kNodeFocused)
Messages.
< context id, when context menu called for tree root node < context id, when children are hidden and child operations are suppressed
virtual tresult CCL_API navigateTo (NavigateArgs& args)
Navigate to new location.
virtual tresult CCL_API initialize (IUnknown* context)
Initialize plug-in component within specified context.
virtual tresult CCL_API terminate ()
Terminate plug-in component.
virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const
Get property value by name.
virtual IUnknown*CCL_API getObject (StringID name, UIDRef classID)
Get object by name and class id.
virtual tbool CCL_API paramChanged (IParameter* param)
The given parameter changed its value, usually caused by user interaction.
virtual void CCL_API notify (ISubject* subject, MessageRef msg)
Receive notification from subject.