suzanne.soy/SearchBar
1
0
Fork 0
Code Issues 20 Pull Requests 2 Actions Packages Projects Releases Wiki Activity
f48fb1af35
SearchBar/README.md
luz paz f48fb1af35 Update README.md in preparation for inclusiong in Addon Manager 
Several tweaks:  
* Converted to full markdown syntax
* Added several sections
* Hid manual install section (to not clutter Addon Manager viewport
* tweaks
2022-03-01 12:26:30 -05:00

2.4 KiB
Raw Blame History

FreeCAD SearchBar

This FreeCAD mod adds a search bar for tools, document objects and preferences.

⚠️ Several issues related to the C++ memory management interacting badly with Python's have caused lots of segfaults during development. ⚠️

⚠️️ Most of these should now be solved, but save your work often and proceed with caution while testing this extension. ⚠️

Extensibility

It can be extended by other mods, by adding a new result provider.

Usage

The search bar appears next to the What's this? tool drawing in FreeCAD's default File toolbar.

Screenshot of the search bar, with results in its drop-down menu and extra info about the result in a separate pane

Installation

Automatic Install

Install SearchBar addon via the FreeCAD Addon Manager from the Tools ➡️ Addon Manager dropdown menu.

Manual Install

Expand for instructions on manual installation of SearchBar

Clone the GIT repository or extract the .zip downloaded from GitHub to the following location:

  • Linux: ~/.FreeCAD/Mod/SearchBar
  • macOS: /Users/user_name/Library/Preferences/FreeCAD/Mod/SearchBar
  • Windows: C:\Users\user_name\AppData\Roaming\FreeCAD\Mod\SearchBar

Uninstallation

  • Remove the folder which was cloned during installation:
    • Linux: ~/.FreeCAD/Mod/SearchBar
    • macOS: /Users/user_name/Library/Preferences/FreeCAD/Mod/SearchBar
    • Windows: C:\Users\user_name\AppData\Roaming\FreeCAD\Mod\SearchBar
  • Optional: Remove the cache (~30MB) \~/.FreeCAD/Cache_SearchBarMod or equivalent on other platforms

Development

  • InitGui.py adds an instance of SearchBoxLight to the GUI.
  • SearchBoxLight is a hollowed-out implementation of a search box, it loads everything lazily.

Feedback

To report bugs or feature enhancements, please open a ticket in the issue queue. Best place to discuss feedback or issues in on the dedicated FreeCAD forum discussion for SearchBar.

License License: CC0 v1.0.

See LICENSE. This repository is in the public domain.