class CCL::SearchComponent
Overview
#include <searchcomponent.h> class SearchComponent: public CCL::Component, public CCL::CommandDispatcher, private CCL::Threading::UserThread, private CCL::IEditControlHost, private CCL::IParamPreviewHandler, private CCL::IdleClient { public: // enums enum State; // classes class ProgressDelegate; // fields typingTimeOutAgain; TypingTimeOutAgain numImmediateResults; CLASS_INTERFACE3 (ITimerTask, IEditControlHost, IParamPreviewHandler, Component) private ISearchResultViewer* resultViewer; ISearchProvider* searchProvider; SearchResult* currentSearch; UnknownList pendingResultItems; String pendingSearchTerms; int64 scheduledStart; int currentPaginationOffset; int numResults; int state; // methods DECLARE_CLASS (SearchComponent, Component); ISearchResultViewer* getResultViewer (); void setResultViewer (ISearchResultViewer* resultViewer); void setSearchProvider (ISearchProvider* searchProvider); void reset (); void clearSearchTerms (); void startSearch (StringRef searchTerms); String getSearchTerms () const; void cancelSearch (); bool areSearchTermsFocused () const; bool isShowingResult () const; bool isVisible () const; void setVisible (bool state); PROPERTY_VARIABLE (int, typingTimeOutInitial, TypingTimeOutInitial); TypingTimeOutAgain PROPERTY_VARIABLE (int, resultFrequency, ResultFrequency); TypingTimeOutAgain NumImmediateResults PROPERTY_VARIABLE ( int, searchOptions, SearchOptions ); virtual TypingTimeOutAgain NumImmediateResults SearchDelimiters bool load (const Storage& storage); virtual bool save (const Storage& storage) const; virtual IView*CCL_API createView ( StringID name, VariantRef data, const Rect& bounds ); virtual tbool CCL_API paramChanged (IParameter* param); virtual void CCL_API notify (ISubject* subject, MessageRef msg); virtual CCL::tbool CCL_API getProperty (CCL::Variant& var, MemberID propertyId) const; virtual tresult CCL_API terminate (); DECLARE_COMMANDS (SearchComponent); SuperClass bool onFocusSearchField (CmdArgs args); void scheduleSearch (int delay); void onSearchDone (bool canceled); void clearResult (); void flushPendingResults (); void focusSearchField (); virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg); virtual int threadEntry (); virtual void onIdleTimer (); virtual tbool CCL_API onEditNavigation (const KeyEvent& event, IView* control); virtual void CCL_API onEditControlLostFocus (IView* control); virtual void CCL_API paramPreview (IParameter* param, ParamPreviewEvent& e); };
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); bool dispatchCommand (const CommandMsg& msg); bool dispatchCommand ( const CommandMsg& msg, CommandDispatchEntry <T> dispatchTable [] ); bool dispatchCommandWithAliases (const CommandMsg& msg); bool isThreadStarted () const; bool isThreadAlive () const; void startThread (ThreadPriority priority, int cpuAffinity = -1); bool stopThread (unsigned int milliseconds); void requestTerminate (); virtual tbool CCL_API onEditNavigation (const KeyEvent& event, IView* control) = 0; virtual void CCL_API onEditControlLostFocus (IView* control) = 0; virtual void CCL_API paramPreview (IParameter* param, ParamPreviewEvent& e) = 0; virtual void CCL_API onTimer (ITimer* timer) = 0; void startTimer (int64 delay = 0, bool periodic = true); void stopTimer (); bool isTimerEnabled () const; bool enableTimer (bool state); virtual void CCL_API onTimer (ITimer*);
Detailed Documentation
Fields
String pendingSearchTerms
next search to be started after thread is done
int64 scheduledStart
time when search should be started
Methods
TypingTimeOutAgain PROPERTY_VARIABLE (int, resultFrequency, ResultFrequency)
< ms after typing search terms, before another search starts (result already shown)
TypingTimeOutAgain NumImmediateResults PROPERTY_VARIABLE ( int, searchOptions, SearchOptions )
< number of results fed immediately
virtual TypingTimeOutAgain NumImmediateResults SearchDelimiters bool load (const Storage& storage)
< Delimiter character(s) used when searching
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.
virtual CCL::tbool CCL_API getProperty (CCL::Variant& var, MemberID propertyId) const
Get property value by name.
virtual tresult CCL_API terminate ()
Terminate plug-in component.
virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg)
Call method.
virtual int threadEntry ()
implement to do the thread work
virtual void onIdleTimer ()
override to perform the periodic action
virtual tbool CCL_API onEditNavigation (const KeyEvent& event, IView* control)
Edit control delegates key event for navigation.
virtual void CCL_API onEditControlLostFocus (IView* control)
Edit control has lost focus.
virtual void CCL_API paramPreview (IParameter* param, ParamPreviewEvent& e)
The given parameter invoked a preview event.