function varargout = plotedit(varargin)

%PLOTEDIT  Tools for editing and annotating plots

%   PLOTEDIT ON   starts plot edit mode for the current figure.

%   PLOTEDIT OFF  ends plot edit mode for the current figure.

%   PLOTEDIT  with no arguments toggles the plot edit mode for

%      the current figure.

%

%   PLOTEDIT(FIG)  toggles the plot edit mode for figure FIG.

%   PLOTEDIT(FIG,'STATE')  specifies the PLOTEDIT STATE for

%      the figure FIG.

%   PLOTEDIT('STATE')  specifies the PLOTEDIT STATE for

%      the current figure.

%

%      STATE can be one of the strings:

%          ON - starts plot edit mode

%          OFF - ends plot edit mode

%          SHOWTOOLSMENU - displays the Tools menu (the default)

%          HIDETOOLSMENU - removes the Tools menu from the menubar

%

%   When PLOTEDIT is ON, use the Tools menu to add and

%   modify objects, or select the annotation toolbar buttons

%   to add annotations such as text, line and arrows.

%   Click and drag objects to move or resize them.

%

%   To edit object properties, right click or double click on

%   the object.

%

%   Shift-click to select multiple objects.

%

%   See also PROPEDIT.

%   Internal interfaces for toolbox-plotedit compatibility

%

%   plotedit(FIG,'hidetoolsmenu')

%      makes the standard figure 'Tools' menu Visible off

%   plotedit(FIG,'showtoolsmenu')

%      makes the standard figure 'Tools' menu Visible on

%   h = plotedit(FIG,'gettoolbuttons')

%      returns a list plot editing and annotation buttons in

%      the toolbar.  Used by UISUSPEND and UIRESTORE.

%   h = plotedit(FIG,'locktoolbarvisibility')

%      freezes the current state of the toolbar.

%   plotedit(FIG,'setsystemeditmenus')

%      restores the system Edit menu.

%   plotedit(FIG,'setploteditmenus')

%      restores the plotedit Edit menu.

%   plotedit(FIG,'plotedittoolbar',action)

%      applies the action to the plot edit toolbar.

%

%   these are used by UISUSPEND/UIRESTORE

%   a = plotedit(FIG,'getenabletools')

%      returns the enable state of the plot editing tools

%   plotedit(FIG,'setenabletools','off')

%      disables the plot editing tools under Tools menu

%      and disables the Tools menu callback which updates

%      the status of the tools menu, and disables the plot

%      editing tools in the Toolbar

%   plotedit(FIG,'setenabletools','on')

%      enables the Tools menu and the items underneath it

%      and enables the plot editing buttons in the Toolbar

%

%   To hide the figure toolbar, set the figure 'ToolBar'

%   property (hidden) to 'none'.

%      fig.ToolBar = 'none';

%

%   plotedit({'subfcn',...}) fevals the subfunction and passes

%   it the rest of the inputs.

%

%   plotedit(FIG,'on','pointer',POINTER) if the current pointer is a watch

%   sets the pointer to return to when exiting plotedit mode to

%   POINTER. If not specified use the default pointer.

%   Copyright 1984-2017 The MathWorks, Inc.

pointer = []; 

switch nargin 

    case 0 

        % plotedit

        if nargout > 0

            error(message('MATLAB:graph2d:plotedit:InvalidInputForOutArg'))

        end

        fig = gcf;

        action = 'toggle';

    case 1 

        if iscell(varargin{1}) 

            % switchyard to subfunctions or private functions

            args = varargin{1}; 

            if nargout > 0 

                [varargout{1:nargout}] = feval(args{:}); 

            else

                feval(args{:});

            end 

            return; 

        elseif ischar(varargin{1}) || isstring(varargin{1})

            if nargout > 0

                error(message('MATLAB:graph2d:plotedit:InvalidInputForOutArg'))

            end

            % plotedit [on | off ]

            fig = gcf;

            action = varargin{1};

            matlab.ui.internal.prepareFigureFor(fig, mfilename('fullpath'));

        else

            if nargout > 0

                error(message('MATLAB:graph2d:plotedit:InvalidInputForOutArg'))

            end

            % plotedit(fig)

            if any(ishghandle(varargin{1}, 'figure'))

                matlab.ui.internal.prepareFigureFor(varargin{1}, mfilename('fullpath'));

                matlab.ui.internal.UnsupportedInUifigure(varargin{1});  %throw error for a uifigure

                fig = varargin{1};

            else

                fig = gcf;

                matlab.ui.internal.prepareFigureFor(fig, mfilename('fullpath'));

            end

            action = 'toggle';

        end

    case 2

        if nargout > 0 && ~isValidActionForOutput(varargin{2})

            error(message('MATLAB:graph2d:plotedit:InvalidInputForOutArg'))

        end

        % we can accept multiple figures, but only scalar uipanels or

        % uitabs since there could be multiple parented to the same figure

        if any(ishghandle(varargin{1}, 'figure'))

            matlab.ui.internal.prepareFigureFor(varargin{1}, mfilename('fullpath'));

            fig = varargin{1};

            if ~matlab.uitools.internal.uimode.isLiveEditorFigure(fig)

                matlab.ui.internal.UnsupportedInUifigure(fig);  %throw error for a uifigure

            end

        elseif strcmp(varargin{2},'getmode') && ...

                (~isempty(varargin{1}) && ...

                (ishghandle(varargin{1}, 'uipanel') || ...

                ishghandle(varargin{1},'uitab')))

            fig = varargin{1};

        else

            fig = gcf;

        end

        matlab.ui.internal.prepareFigureFor(fig, mfilename('fullpath'));

        action = varargin{2};

    case {3 4}

        if nargout > 0

            error(message('MATLAB:graph2d:plotedit:InvalidInputForOutArg'))

        end

        if any(ishghandle(varargin{1}, 'figure'))

            matlab.ui.internal.prepareFigureFor(varargin{1}, mfilename('fullpath'));

            matlab.ui.internal.UnsupportedInUifigure(varargin{1});  %throw error for a uifigure

            fig = varargin{1};

        else

            fig = gcf;

            matlab.ui.internal.prepareFigureFor(fig, mfilename('fullpath'));

        end

        action = varargin{2};

        parameter = varargin{3}; % silent: don't switch button

        switch parameter

            case 'pointer'

                pointer = varargin{4};

        end

end

% For legacy reasons, exit early if the action is "promoteoverlay" (this is

% R13-era code.

if strcmpi(action,'promoteoverlay')

    return;

end

% If the mode has never been constructed and the action is "off",

% short-circuit:

if strcmpi(action,'off') && ~hasuimode(fig,'Standard.EditPlot')

    return;

end

% If the mode has never been constructed and the action is "isactive",

% return false and short-circuit:

if strcmpi(action,'isactive') && ~hasuimode(fig,'Standard.EditPlot')

    varargout{1} = 0;

    return;

end

persistent firstTimeStart;

oldptr = [];

oldPointerShapeCData = [];

switch lower(action)

    case {'on','toggle'}

        % If we start for the first time, change the pointer to watch,

        % beacuse it can take some time for the mode to get initialized

        if isempty(firstTimeStart)

            oldptr = fig.Pointer;

            oldPointerShapeCData =  fig.PointerShapeCData;

            %   At first time creation temporarily set the wait cursor

            fig.UIModeEnabled = 'on';

            fig.Pointer = 'watch';

            drawnow expose;

            firstTimeStart = 0;

        end

        hMode = localGetMode(fig);

        if strcmpi(hMode.Enable,'off')

            % Activate the mode

            activateuimode(fig,'Standard.EditPlot');

            % If the pointer is sent as an additional input argument,

            % augment the mode to take care of this behind the scenes

            if ~isempty(pointer)

                hMode.FigureState.Pointer = pointer;

            end

        elseif strcmpi(action,'toggle')

            activateuimode(fig,'');

        end

        % If this is a cold start, (firsttime) was initialized above, then

        % reset the cached plot edit mode cursor information to its initial

        % value so the cursor does not revert to the temporary wait state when

        % the user exits the mode.

        if ~isempty(oldptr)

            % If the mode was turned on the call activateuimode(fig,'Standard.EditPlot');

            % will have set the FigureState.Pointer to 'watch'. Restore the

            % oldptr setting

            setFigureState(hMode, 'Pointer', oldptr)

            oldptr =[]; %#ok<NASGU>

        end

        if ~isempty(oldPointerShapeCData)

            setFigureState(hMode, 'PointerShapeCData', oldPointerShapeCData)

            oldPointerShapeCData = []; %#ok<NASGU>

        end

    case 'off'

        hMode = localGetMode(fig);

        if strcmpi(hMode.Enable,'off') % already off

            return;

        end

        activateuimode(fig,'');

    case 'cut'

        hMode = localGetMode(fig);

        if hMode.ModeStateData.PlotSelectMode.ModeStateData.CutCopyPossible

            scribeccp(fig, 'cut');

        end

    case 'copy'

        hMode = localGetMode(fig);

        if hMode.ModeStateData.PlotSelectMode.ModeStateData.CutCopyPossible

            scribeccp(fig, 'copy');

        end

    case 'paste'

        hMode = localGetMode(fig);

        % If a paste is not possible, assume we are pasting into the

        % figure. This is for ^C^V shortcuts to execute properly.

        if ~hMode.ModeStateData.PlotSelectMode.ModeStateData.PastePossible

            selectobject(fig,'replace');

        end

        if hMode.ModeStateData.PlotSelectMode.ModeStateData.PastePossible

            scribeccp(fig, 'paste');

        end

    case 'clear'

        scribeccp(fig, 'clear');

    case 'delete'

        hMode = localGetMode(fig);

        if hMode.ModeStateData.PlotSelectMode.ModeStateData.DeletePossible

            scribeccp(fig, 'delete');

        end

    case 'selectall'

        hMode = localGetMode(fig);

        localSelectAll(hMode);

    case 'hidetoolsmenu'

        set(findobj(allchild(fig),'flat','Type','uimenu','Tag','figMenuTools'),...

            'visible','off');

    case 'showtoolsmenu'

        set(findobj(allchild(fig),'flat','Type','uimenu','Tag','figMenuTools'),...

            'visible','on');

    case 'plotedittoolbar'

        if nargin < 3

            parameter = 'toggle';

        end

        plotedittoolbar(fig,parameter);

    case 'setenabletools'

        if nargin==3

            setappdata(fig,'ScribePloteditEnable',parameter);

            % disable toolbar

            toolButtons = plotedit(fig,'gettoolbuttons');

            set(toolButtons,'Enable',parameter);

            % disable Tools menu

            % happens within the Tools menu callback, by polling the

            % ScribePloteditEnable state

        end

    case 'showinspector'

        % Shows the property inspector

        matlab.graphics.internal.propertyinspector.propertyinspector('show');

    case 'hideinspector'

        % Hides the inspector window

        matlab.graphics.internal.propertyinspector.propertyinspector('hide');

    case 'openandrestoreinspector'

        % Opens the property inspector and restores auto behavior

        matlab.graphics.internal.propertyinspector.propertyinspector('openandrestoreinspector');

    case 'getenabletools'

        ploteditEnable = getappdata(fig,'ScribePloteditEnable');

        if isempty(ploteditEnable)

            varargout{1} = 'on';    % default

        else

            varargout{1} = ploteditEnable;

        end

    case 'setsystemeditmenus'

        localModifyFigMenus(fig,'off');

    case 'setploteditmenus'

        localModifyFigMenus(fig,'on');

    case 'gettoolbuttons'

        % Call subfunctions that return the toolbar buttons and insert/plottools

        % menu items.

        h = getScribeToolbarButtons(fig);

        hmenuitems = [getScribeMenuItems(fig);getPlotToolsMenuItems(fig)];

        if nargout>0

            varargout{1} = [h;hmenuitems];

        end

    case 'locktoolbarvisibility'

        toolbarShowing = ~isempty(findall(fig,'Tag','FigureToolBar'));

        % Only set the Toolbar state if it changes to prevent affecting the

        % ToolBarMode property. The ToolBarMode is used by the Live Editor

        % when restoring figures to determine of the ToolBar should be

        % restored.

        if toolbarShowing && ~strcmp(get(fig,'Toolbar'),'figure')

            set(fig,'Toolbar','figure');

        elseif ~toolbarShowing && ~strcmp(get(fig,'Toolbar'),'none')

            set(fig,'Toolbar','none');

        end

    case 'isactive'

        hMode = localGetMode(fig);

        switch hMode.Enable

            case 'on'

                varargout{1} = 1;

            case 'off'

                varargout{1} = 0;

        end

    case 'getmode'

        hMode = localGetMode(fig);

        varargout{1} = hMode;

    otherwise

        error(message('MATLAB:graph2d:plotedit:InvalidPlotEditState'))

end