PCL
BitmapBox.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/BitmapBox.h - Released 2024-06-18T15:48:54Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_BitmapBox_h
53 #define __PCL_BitmapBox_h
54 
56 
57 #ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
58 
59 #include <pcl/Defs.h>
60 
61 #include <pcl/Bitmap.h>
62 #include <pcl/Frame.h>
63 
64 namespace pcl
65 {
66 
67 // ----------------------------------------------------------------------------
68 
75 class PCL_CLASS BitmapBox : public Frame
76 {
77 public:
78 
83  BitmapBox( const Bitmap& bmp = Bitmap::Null(), Control& parent = Control::Null() );
84 
88  ~BitmapBox() override
89  {
90  }
91 
96 
100  void SetBitmap( const Bitmap& bmp );
101 
107  void Clear()
108  {
109  SetBitmap( Bitmap::Null() );
110  }
111 
116  int Margin() const;
117 
121  void SetMargin( int m );
122 
126  void ClearMargin()
127  {
128  SetMargin( 0 );
129  }
130 
133  bool IsAutoFitEnabled() const;
134 
137  void EnableAutoFit( bool = true );
138 
141  void DisableAutoFit( bool disable = true )
142  {
143  EnableAutoFit( !disable );
144  }
145 };
146 
147 // ----------------------------------------------------------------------------
148 
149 } // pcl
150 
151 #endif // __PCL_BUILDING_PIXINSIGHT_APPLICATION
152 
153 #endif // __PCL_BitmapBox_h
154 
155 // ----------------------------------------------------------------------------
156 // EOF pcl/BitmapBox.h - Released 2024-06-18T15:48:54Z
Client-side interface to a PixInsight BitmapBox control.
Definition: BitmapBox.h:76
int Margin() const
void ClearMargin()
Definition: BitmapBox.h:126
void DisableAutoFit(bool disable=true)
Definition: BitmapBox.h:141
BitmapBox(const Bitmap &bmp=Bitmap::Null(), Control &parent=Control::Null())
void SetMargin(int m)
void Clear()
Definition: BitmapBox.h:107
void EnableAutoFit(bool=true)
bool IsAutoFitEnabled() const
void SetBitmap(const Bitmap &bmp)
~BitmapBox() override
Definition: BitmapBox.h:88
Bitmap CurrentBitmap() const
Client-side interface to a PixInsight Bitmap object.
Definition: Bitmap.h:204
static Bitmap & Null()
Client-side interface to a PixInsight Control object.
Definition: Control.h:126
static Control & Null()
Client-side interface to a PixInsight Frame control.
Definition: Frame.h:107
PCL root namespace.
Definition: AbstractImage.h:77