PCL
UIObject.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.1.16
6 // ----------------------------------------------------------------------------
7 // pcl/UIObject.h - Released 2019-09-29T12:27:26Z
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-2019 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 (http://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_UIObject_h
53 #define __PCL_UIObject_h
54 
56 
57 #include <pcl/Defs.h>
58 
59 #include <pcl/Relational.h>
60 #include <pcl/String.h>
61 
62 namespace pcl
63 {
64 
65 // ----------------------------------------------------------------------------
66 
94 class PCL_CLASS UIObject
95 {
96 public:
97 
105  virtual ~UIObject() noexcept( false );
106 
113  bool IsNull() const
114  {
115  return handle == nullptr;
116  }
117 
124  static UIObject& Null();
125 
134  size_type RefCount() const;
135 
143  bool IsUnique() const
144  {
145  return RefCount() < 2;
146  }
147 
174  bool IsAlias() const
175  {
176  return alias;
177  }
178 
185  bool IsGarbage() const
186  {
187  return RefCount() < 1;
188  }
189 
198  bool IsSameObject( const UIObject& o ) const
199  {
200  return handle == o.handle;
201  }
202 
217  virtual void EnsureUnique();
218 
222  bool operator ==( const UIObject& o ) const
223  {
224  return IsSameObject( o );
225  }
226 
237  bool operator <( const UIObject& o ) const
238  {
239  return handle < o.handle;
240  }
241 
246  IsoString ObjectType() const;
247 
266  String ObjectId() const;
267 
276  void SetObjectId( const String& id );
277 
278 protected:
279 
280  void* handle = nullptr;
281  bool alias = false;
282 
289  UIObject() = default;
290 
299  UIObject( const UIObject& x );
300 
304  UIObject( UIObject&& x ) : handle( x.handle ), alias( x.alias )
305  {
306  x.handle = nullptr;
307  x.alias = false;
308  }
309 
313  UIObject& operator =( const UIObject& x )
314  {
315  Assign( x );
316  return *this;
317  }
318 
322  UIObject& operator =( UIObject&& x )
323  {
324  Transfer( x );
325  return *this;
326  }
327 
331  UIObject( void* );
332 
336  UIObject( const void* );
337 
341  UIObject( std::nullptr_t )
342  {
343  }
344 
348  void SetHandle( void* );
349 
353  void TransferHandle( void* );
354 
361  virtual void* CloneHandle() const
362  {
363  return nullptr;
364  }
365 
369  bool Assign( const UIObject& x )
370  {
371  if ( x.handle != handle )
372  {
373  SetHandle( x.handle );
374  return true;
375  }
376  return false;
377  }
378 
382  bool Transfer( UIObject& x )
383  {
384  if ( &x != this )
385  {
386  SetHandle( nullptr );
387  handle = x.handle;
388  alias = x.alias;
389  x.handle = nullptr;
390  x.alias = false;
391  return true;
392  }
393  return false;
394  }
395 
396  friend class UIObjectIndex;
397  friend class UIEventDispatcher;
398 };
399 
400 // ----------------------------------------------------------------------------
401 
402 } // pcl
403 
404 #endif // __PCL_UIObject_h
405 
406 // ----------------------------------------------------------------------------
407 // EOF pcl/UIObject.h - Released 2019-09-29T12:27:26Z
PCL root namespace.
Definition: AbstractImage.h:76
Root base class for all user interface objects.
Definition: UIObject.h:94
size_t size_type
Definition: Defs.h:543
bool IsSameObject(const UIObject &o) const
Definition: UIObject.h:198
Unicode (UTF-16) string.
Definition: String.h:7911
bool IsUnique() const
Definition: UIObject.h:143
bool IsNull() const
Definition: UIObject.h:113
bool operator<(const Array< T, A > &x1, const Array< T, A > &x2)
Definition: Array.h:2086
bool IsAlias() const
Definition: UIObject.h:174
bool IsGarbage() const
Definition: UIObject.h:185
bool operator==(const Array< T, A > &x1, const Array< T, A > &x2)
Definition: Array.h:2075
UIObject(UIObject &&x)
Definition: UIObject.h:304
Eight-bit string (ISO/IEC-8859-1 or UTF-8 string)
Definition: String.h:5387