Cursor.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/Cursor.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_Cursor_h
#define __PCL_Cursor_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Point.h>
#include <pcl/UIObject.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace StdCursor
{
   enum value_type
   {
      NoCursor,               // no cursor is shown
      Arrow,                  // standard arrow cursor (pointing left)
      InvArrow,               // inverted arrow cursor (pointing right)
      UpArrow,                // upwards arrow
      DownArrow,              // downwards arrow
      LeftArrow,              // leftwards arrow
      RightArrow,             // rightwards arrow
      Checkmark,              // checkmark (ok) cursor
      Crossmark,              // crossmark (cancel) cursor
      Accept,                 // arrow + checkmark
      Reject,                 // arrow + crossmark
      Add,                    // arrow + plus sign
      Copy,                   // arrow + square
      Cross,                  // crosshair
      Hourglass,              // hourglass (native Windows wait cursor)
      Watch,                  // watch (native Macintosh wait cursor)
      Wait           = Watch, // wait cursor: we like the watch! :)
      ArrowWait,              // arrow + hourglass/watch
      ArrowQuestion,          // arrow + question mark
      IBeam,                  // I-beam cursor (text edition)
      VerticalSize,           // vertical resize
      HorizontalSize,         // horizontal resize
      ForwardDiagonalSize,    // forward diagonal resize (/)
      BackwardDiagonalSize,   // backward diagonal resize (\‍)
      SizeAll,                // resize in all directions
      VerticalSplit,          // split vertical
      HorizontalSplit,        // split horizontal
      Hand,                   // pointing hand cursor
      PointingHand   = Hand,  // pointing hand cursor (same as Hand)
      OpenHand,               // open hand cursor
      ClosedHand,             // closed hand cursor
      SquarePlus,             // plus sign into a square (used for zoom in)
      SquareMinus,            // minus sign into a square (used for zoom out)
      CirclePlus,             // plus sign into a circle (used for zoom in)
      CircleMinus,            // minus sign into a circle (used for zoom out)
      Forbidden               // stop cursor
   };
}
 
// ----------------------------------------------------------------------------
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
class Bitmap;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Cursor : public UIObject
{
public:
 
   using std_cursor = StdCursor::value_type ;
 
   Cursor( std_cursor shape = StdCursor::Arrow );
 
   Cursor( const Bitmap& bmp, const pcl::Point& hotSpot );
 
   Cursor( const Bitmap& bmp, int hotSpotX = 0, int hotSpotY = 0 );
 
   Cursor( const Cursor& c )
      : UIObject( c )
   {
   }
 
   Cursor( Cursor&& x )
      : UIObject( std::move( x ) )
   {
   }
 
   ~Cursor() override
   {
   }
 
   Cursor& operator =( const Cursor& c )
   {
      SetHandle( c.handle );
      return *this;
   }
 
   Cursor& operator =( Cursor&& x )
   {
      Transfer( x );
      return *this;
   }
 
   static Cursor& Null();
 
   pcl::Point HotSpot() const;
 
   static pcl::Point Position();
 
   static void SetPosition( int x, int y );
 
   static void SetPosition( const pcl::Point& pos )
   {
      SetPosition( pos.x, pos.y );
   }
 
private:
 
   Cursor( void* h ) : UIObject( h )
   {
   }
 
   void* CloneHandle() const override;
 
   friend class Control;
};
 
// ----------------------------------------------------------------------------
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
} // pcl
 
#endif   // __PCL_Cursor_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Cursor.h - Released 2024-06-18T15:48:54Z