// SPDX-License-Identifier: GPL-2.0-or-later /** @file * @brief Find dialog */ /* Authors: * Bryce W. Harrington * * Copyright (C) 2004, 2005 Authors * * Released under GNU GPL v2+, read the file 'COPYING' for more information. */ #ifndef INKSCAPE_UI_DIALOG_FIND_H #define INKSCAPE_UI_DIALOG_FIND_H #include #include #include #include #include #include #include "ui/dialog/dialog-base.h" #include "ui/widget/entry.h" #include "ui/widget/frame.h" class SPItem; class SPObject; namespace Inkscape { class Selection; namespace UI { namespace Dialog { /** * The Find class defines the Find and replace dialog. * * The Find and replace dialog allows you to search within the * current document for specific text or properties of items. * Matches items are highlighted and can be replaced as well. * Scope can be limited to the entire document, current layer or selected items. * Other options allow searching on specific object types and properties. */ class Find : public DialogBase { public: Find(); ~Find() override {}; void desktopReplaced() override; void selectionChanged(Selection *selection) override; /** * Helper function which returns a new instance of the dialog. * getInstance is needed by the dialog manager (Inkscape::UI::Dialog::DialogManager). */ static Find &getInstance() { return *new Find(); } protected: /** * Callbacks for pressing the dialog buttons. */ void onFind(); void onReplace(); void onExpander(); void onAction(); void onToggleAlltypes(); void onToggleCheck(); void onSearchinText(); void onSearchinProperty(); /** * Toggle all the properties checkboxes */ void searchinToggle(bool on); /** * Returns true if the SPItem 'item' has the same id * * @param item the SPItem to check * @param id the value to compare with * @param exact do an exact match * @param casematch match the text case exactly * @param replace replace the value if found * */ bool item_id_match (SPItem *item, const gchar *id, bool exact, bool casematch, bool replace=false); /** * Returns true if the SPItem 'item' has the same text content * * @param item the SPItem to check * @param name the value to compare with * @param exact do an exact match * @param casematch match the text case exactly * @param replace replace the value if found * * */ bool item_text_match (SPItem *item, const gchar *text, bool exact, bool casematch, bool replace=false); /** * Returns true if the SPItem 'item' has the same text in the style attribute * * @param item the SPItem to check * @param name the value to compare with * @param exact do an exact match * @param casematch match the text case exactly * @param replace replace the value if found * */ bool item_style_match (SPItem *item, const gchar *text, bool exact, bool casematch, bool replace=false); /** * Returns true if the SPItem 'item' has a or <desc> child that * matches * * @param item the SPItem to check * @param name the value to compare with * @param exact do an exact match * @param casematch match the text case exactly * @param replace replace the value if found * */ bool item_desc_match (SPItem *item, const gchar *text, bool exact, bool casematch, bool replace=false); bool item_title_match (SPItem *item, const gchar *text, bool exact, bool casematch, bool replace=false); /** * Returns true if found the SPItem 'item' has the same attribute name * * @param item the SPItem to check * @param name the value to compare with * @param exact do an exact match * @param casematch match the text case exactly * @param replace replace the value if found * */ bool item_attr_match (SPItem *item, const gchar *name, bool exact, bool casematch, bool replace=false); /** * Returns true if the SPItem 'item' has the same attribute value * * @param item the SPItem to check * @param name the value to compare with * @param exact do an exact match * @param casematch match the text case exactly * @param replace replace the value if found * */ bool item_attrvalue_match (SPItem *item, const gchar *name, bool exact, bool casematch, bool replace=false); /** * Returns true if the SPItem 'item' has the same font values * * @param item the SPItem to check * @param name the value to compare with * @param exact do an exact match * @param casematch match the text case exactly * @param replace replace the value if found * */ bool item_font_match (SPItem *item, const gchar *name, bool exact, bool casematch, bool replace=false); /** * Function to filter a list of items based on the item type by calling each item_XXX_match function */ std::vector<SPItem*> filter_fields (std::vector<SPItem*> &l, bool exact, bool casematch); bool item_type_match (SPItem *item); std::vector<SPItem*> filter_types (std::vector<SPItem*> &l); std::vector<SPItem*> & filter_list (std::vector<SPItem*> &l, bool exact, bool casematch); /** * Find a string within a string and returns true if found with options for exact and casematching */ bool find_strcmp(const gchar *str, const gchar *find, bool exact, bool casematch); /** * Find a string within a string and return the position with options for exact, casematching and search start location */ gsize find_strcmp_pos(const gchar *str, const gchar *find, bool exact, bool casematch, gsize start=0); /** * Replace a string with another string with options for exact and casematching and replace once/all */ Glib::ustring find_replace(const gchar *str, const gchar *find, const gchar *replace, bool exact, bool casematch, bool replaceall); /** * recursive function to return a list of all the items in the SPObject tree * */ std::vector<SPItem*> & all_items (SPObject *r, std::vector<SPItem*> &l, bool hidden, bool locked); /** * to return a list of all the selected items * */ std::vector<SPItem*> & all_selection_items (Inkscape::Selection *s, std::vector<SPItem*> &l, SPObject *ancestor, bool hidden, bool locked); /** * Shrink the dialog size when the expander widget is closed * Currently not working, no known way to do this */ void squeeze_window(); private: Find(Find const &d) = delete; Find& operator=(Find const &d) = delete; /* * Find and replace combo box widgets */ UI::Widget::Entry entry_find; UI::Widget::Entry entry_replace; /** * Scope and search in widgets */ Gtk::RadioButton check_scope_all; Gtk::RadioButton check_scope_layer; Gtk::RadioButton check_scope_selection; Gtk::RadioButton check_searchin_text; Gtk::RadioButton check_searchin_property; Gtk::Box hbox_searchin; Gtk::Box vbox_scope; Gtk::Box vbox_searchin; UI::Widget::Frame frame_searchin; UI::Widget::Frame frame_scope; /** * General option widgets */ Gtk::CheckButton check_case_sensitive; Gtk::CheckButton check_exact_match; Gtk::CheckButton check_include_hidden; Gtk::CheckButton check_include_locked; Gtk::Box vbox_options1; Gtk::Box vbox_options2; Gtk::Box hbox_options; Gtk::Box vbox_expander; Gtk::Expander expander_options; UI::Widget::Frame frame_options; /** * Property type widgets */ Gtk::CheckButton check_ids; Gtk::CheckButton check_attributename; Gtk::CheckButton check_attributevalue; Gtk::CheckButton check_style; Gtk::CheckButton check_font; Gtk::CheckButton check_desc; Gtk::CheckButton check_title; Gtk::Box hbox_properties; Gtk::Box vbox_properties1; Gtk::Box vbox_properties2; UI::Widget::Frame frame_properties; /** * A vector of all the properties widgets for easy processing */ std::vector<Gtk::CheckButton *> checkProperties; /** * Object type widgets */ Gtk::CheckButton check_alltypes; Gtk::CheckButton check_rects; Gtk::CheckButton check_ellipses; Gtk::CheckButton check_stars; Gtk::CheckButton check_spirals; Gtk::CheckButton check_paths; Gtk::CheckButton check_texts; Gtk::CheckButton check_groups; Gtk::CheckButton check_clones; Gtk::CheckButton check_images; Gtk::CheckButton check_offsets; Gtk::Box vbox_types1; Gtk::Box vbox_types2; Gtk::Box hbox_types; UI::Widget::Frame frame_types; Glib::RefPtr<Gtk::SizeGroup> _left_size_group; Glib::RefPtr<Gtk::SizeGroup> _right_size_group; /** * A vector of all the check option widgets for easy processing */ std::vector<Gtk::CheckButton *> checkTypes; //Gtk::Box hbox_text; /** * Action Buttons and status */ Gtk::Label status; Gtk::Button button_find; Gtk::Button button_replace; Gtk::ButtonBox box_buttons; Gtk::Box hboxbutton_row; /** * Finding or replacing */ bool _action_replace; bool blocked; sigc::connection selectChangedConn; }; } // namespace Dialog } // namespace UI } // namespace Inkscape #endif // INKSCAPE_UI_DIALOG_FIND_H /* Local Variables: mode:c++ c-file-style:"stroustrup" c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +)) indent-tabs-mode:nil fill-column:99 End: */ // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :