sources/Google.Solutions.Mvvm/Binding/Commands/DelegatingContextCommandBase.cs

//
// Copyright 2023 Google LLC
//
// 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
// 
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
//

using Google.Solutions.Common.Util;
using System.Drawing;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace Google.Solutions.Mvvm.Binding.Commands
{ 
    /// <summary>
    /// Command that delegates to another command. Deriving classes
    /// can add behavior by overriding one or more methods.
    /// </summary>
    public abstract class DelegatingContextCommandBase<TContext> 
        : CommandBase, IContextCommand<TContext>
    {
        protected IContextCommand<TContext> Target { get; }

        public DelegatingContextCommandBase(IContextCommand<TContext> target)
        {
            this.Target = target.ExpectNotNull(nameof(target));
        }

        public virtual Image Image => this.Target.Image;

        public virtual Keys ShortcutKeys => this.Target.ShortcutKeys;

        public virtual bool IsDefault => this.Target.IsDefault;

        public virtual CommandState QueryState(TContext context)
        {
            return this.Target.QueryState(context);
        }

        public virtual Task ExecuteAsync(TContext context)
        {
            return this.Target.ExecuteAsync(context);
        }
    }
}