/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_FPICKER_SOURCE_WIN32_FILEPICKER_CONTROLCOMMAND_HXX
#define INCLUDED_FPICKER_SOURCE_WIN32_FILEPICKER_CONTROLCOMMAND_HXX

#include <sal/types.h>
#include <com/sun/star/uno/Any.hxx>
#include <rtl/ustring.hxx>


class CFilePickerState;
class CControlCommandRequest;
class CControlCommandResult;

class CControlCommand
{
public:
    explicit CControlCommand( sal_Int16 aControlId );
    virtual ~CControlCommand( );

    virtual void SAL_CALL exec( CFilePickerState* aFilePickerState ) = 0;

    // the client inherits the ownership of the returned
    // CControlCommandResult and has to delete it or he may
    // use the unique_ptr template for automatic deletion
    virtual CControlCommandResult* SAL_CALL handleRequest( CControlCommandRequest* aRequest );

    // clients of this method should use the returned
    // pointer only temporary because it's not ref-counted
    // and the ownerhsip belongs to this instance
    CControlCommand* SAL_CALL getNextCommand( ) const;

    // transfers the ownership to this class
    void SAL_CALL setNextCommand( CControlCommand* nextCommand );

protected:
    sal_Int16 SAL_CALL getControlId( ) const;

private:
    CControlCommand* m_NextCommand;
    sal_Int16        m_aControlId;
};


class CValueControlCommand : public CControlCommand
{
public:
    CValueControlCommand(
        sal_Int16 aControlId,
        sal_Int16 aControlAction,
        const css::uno::Any& aValue );

    virtual void SAL_CALL exec( CFilePickerState* aFilePickerState ) override;

    virtual CControlCommandResult* SAL_CALL handleRequest( CControlCommandRequest* aRequest ) override;

    sal_Int16 SAL_CALL getControlAction( ) const;

    css::uno::Any SAL_CALL getValue( ) const;

private:
    sal_Int16     m_aControlAction;
    css::uno::Any m_aValue;
};


class CLabelControlCommand : public CControlCommand
{
public:
    CLabelControlCommand(
        sal_Int16 aControlId,
        const OUString& aLabel );

    virtual void SAL_CALL exec( CFilePickerState* aFilePickerState ) override;

    virtual CControlCommandResult* SAL_CALL handleRequest( CControlCommandRequest* aRequest ) override;

    OUString SAL_CALL getLabel( ) const;

private:
    OUString m_aLabel;
};


class CEnableControlCommand : public CControlCommand
{
public:
    CEnableControlCommand(
        sal_Int16 controlId,
        bool bEnable );

    virtual void SAL_CALL exec( CFilePickerState* aFilePickerState ) override;

private:
    bool m_bEnable;
};

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */