GUIDialog_ChooserAbstract.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2026 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Class for the window that allows to choose a street, junction or vehicle
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <vector>
#include <set>
#include <utils/foxtools/fxheader.h>
#include <utils/gui/globjects/GUIGlObject.h>
#include <utils/gui/div/GUIPersistentWindowPos.h>
#include "GUIAppEnum.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class GUIGlChildWindow;
class GUIGlObjectStorage;
class GUIGlObject;
 
 
// ===========================================================================
// class definition
// ===========================================================================
class GUIDialog_ChooserAbstract : public FXMainWindow, public GUIPersistentWindowPos {
    // FOX-declarations
    FXDECLARE(GUIDialog_ChooserAbstract)
 
public:
    GUIDialog_ChooserAbstract(GUIGlChildWindow* windowsParent, int messageId,
                              FXIcon* icon, const FXString& title, const std::vector<GUIGlID>& ids,
                              GUIGlObjectStorage& glStorage);
 
    virtual ~GUIDialog_ChooserAbstract();
 
    GUIGlObject* getObject() const;
 
 
 
    long onKeyPress(FXObject* o, FXSelector sel, void* data);
 
    long onCmdCenter(FXObject*, FXSelector, void*);
 
    long onCmdTrack(FXObject*, FXSelector, void*);
 
    long onCmdClose(FXObject*, FXSelector, void*);
 
    long onChgText(FXObject*, FXSelector, void*);
 
    long onCmdText(FXObject*, FXSelector, void*);
 
    long onChgList(FXObject*, FXSelector, void*);
 
    long onChgListSel(FXObject*, FXSelector, void*);
 
    long onCmdFilter(FXObject*, FXSelector, void*);
 
    long onCmdFilterSubstr(FXObject*, FXSelector, void*);
 
    long onCmdToggleSelection(FXObject*, FXSelector, void*);
    long onCmdAddListSelection(FXObject*, FXSelector, void*);
    long onCmdClearListSelection(FXObject*, FXSelector, void*);
 
    long onUpdAddListSelection(FXObject*, FXSelector, void*);
 
    long onUpdClearListSelection(FXObject*, FXSelector, void*);
 
    long onCmdLocateByName(FXObject*, FXSelector, void*);
 
    long onCmdUpdate(FXObject*, FXSelector, void*);
 
    long onCmdCaseSensitive(FXObject*, FXSelector, void*);
 
    long onCmdAutoCenter(FXObject*, FXSelector, void*);
 
    void show();
    using FXMainWindow::show; // to silence the warning C4266 about a hidden function
 
    int getMessageId() const {
        return myMessageId;
    }
 
protected:
    FOX_CONSTRUCTOR(GUIDialog_ChooserAbstract)
 
    
    virtual void toggleSelection(int listIndex);
 
    virtual void select(int listIndex);
 
    virtual void deselect(int listIndex);
 
    virtual void filterACs(const std::vector<GUIGlID>& GLIDs);
 
    void refreshList(const std::vector<GUIGlID>& ids);
 
    void applyFilters();
 
    void updateSelectionButtons();
 
    bool locateByName() const;
 
    virtual std::string getObjectName(GUIGlObject* o) const;
 
private:
    GUIGlChildWindow* myWindowsParent;
 
    int myMessageId;
 
    FXList* myList;
 
    FXButton* myCenterButton;
 
    FXButton* myTrackButton;
 
    FXButton* mySelectAllButton;
 
    FXButton* myDeselectAllButton;
 
    GUIGlObject* mySelected;
 
    FXTextField* myTextEntry;
 
    std::set<GUIGlID> myIDs;
 
    std::vector<GUIGlID> myAllIDs;
 
    int myNumSelectedItems;
 
    FXCheckButton* myHideUnselected;
 
    FXCheckButton* myLocateByName;
 
    FXCheckButton* myFilterSubstring;
 
    FXLabel* myCountLabel;
 
    FXCheckButton* myCaseSensitive;
 
    FXCheckButton* myInstantCenter;
 
};