scroller.h

Go to the documentation of this file.

// $Id: scroller.h 1282 2006-06-09 09:46:49Z alex $
/* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
================================XARAHEADERSTART===========================
 
               Xara LX, a vector drawing and manipulation program.
                    Copyright (C) 1993-2006 Xara Group Ltd.
       Copyright on certain contributions may be held in joint with their
              respective authors. See AUTHORS file for details.

LICENSE TO USE AND MODIFY SOFTWARE
----------------------------------

This file is part of Xara LX.

Xara LX is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 as published
by the Free Software Foundation.

Xara LX and its component source files are distributed in the hope
that it will be useful, but WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with Xara LX (see the file GPL in the root directory of the
distribution); if not, write to the Free Software Foundation, Inc., 51
Franklin St, Fifth Floor, Boston, MA  02110-1301 USA


ADDITIONAL RIGHTS
-----------------

Conditional upon your continuing compliance with the GNU General Public
License described above, Xara Group Ltd grants to you certain additional
rights. 

The additional rights are to use, modify, and distribute the software
together with the wxWidgets library, the wxXtra library, and the "CDraw"
library and any other such library that any version of Xara LX relased
by Xara Group Ltd requires in order to compile and execute, including
the static linking of that library to XaraLX. In the case of the
"CDraw" library, you may satisfy obligation under the GNU General Public
License to provide source code by providing a binary copy of the library
concerned and a copy of the license accompanying it.

Nothing in this section restricts any of the rights you have under
the GNU General Public License.


SCOPE OF LICENSE
----------------

This license applies to this program (XaraLX) and its constituent source
files only, and does not necessarily apply to other Xara products which may
in part share the same code base, and are subject to their own licensing
terms.

This license does not apply to files in the wxXtra directory, which
are built into a separate library, and are subject to the wxWindows
license contained within that directory in the file "WXXTRA-LICENSE".

This license does not apply to the binary libraries (if any) within
the "libs" directory, which are subject to a separate license contained
within that directory in the file "LIBS-LICENSE".


ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
----------------------------------------------

Subject to the terms of the GNU Public License (see above), you are
free to do whatever you like with your modifications. However, you may
(at your option) wish contribute them to Xara's source tree. You can
find details of how to do this at:
  http://www.xaraxtreme.org/developers/

Prior to contributing your modifications, you will need to complete our
contributor agreement. This can be found at:
  http://www.xaraxtreme.org/developers/contribute/

Please note that Xara will not accept modifications which modify any of
the text between the start and end of this header (marked
XARAHEADERSTART and XARAHEADEREND).


MARKS
-----

Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
designs are registered or unregistered trademarks, design-marks, and/or
service marks of Xara Group Ltd. All rights in these marks are reserved.


      Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
                        http://www.xara.com/

=================================XARAHEADEREND============================
 */
//
// This declares the CScroller, CHorzScroller &
// CVertScroller classes, which implement RISCOS
// style proportional scroll bars under Windows. It
// also declares the CScrollerCorner window, which
// is the "size box" gadget between two scroll bars.
//
/*
 *  */


#ifndef SCROLLER__INC
#define SCROLLER__INC

#include "camelot.h"
//#include "ccmaths.h" - in camtypes.h [AUTOMATICALLY REMOVED]


// This user-defined messsage indicates to the window owning the scroller
// that the scroll offset has changed.

#define WM_SCROLLEREVENT    (WM_USER + 0x110)

// CScrollerCorner window

/***************************************************************************************
>   class CScrollerCorner : public CWnd

    Author:     Justin_Flude (Xara Group Ltd) <camelotdev@xara.com>
    Created:    ages ago
    Purpose:    This OIL class is the little square in the bottom-right of a window
                featuring horizontal and vertical scroll bars.  It is currently
                completely useless (except visually, of course).
                
****************************************************************************************/

class CScrollerCorner : public wxWindow
{

// Construction

public:
    CScrollerCorner();
    virtual BOOL Create(LPCTSTR, LPCTSTR, DWORD style, const wxRect& rect,
                        wxWindow* pParent, UINT32 id);

private:
    wxBitmap SizeBitmap;


private:
    DECLARE_EVENT_TABLE()

public:
    void OnPaint(wxPaintEvent& event );
    void OnLButtonDown(wxMouseEvent &event );
    
    void OnSetCursor( wxSetCursorEvent& event );
};


class CWinScroller : public wxScrollBar
{
protected:
    static INT32 ScrollerSize   ;           // UIC 
/*
    XLONG MinVal;                       // "smallest" scroll value
    XLONG MaxVal;                       // "largest" scroll value
    XLONG Range;                        // the difference between the above
    XLONG Delta;                        // the sign of (MaxVal - MinVal)
    XLONG ThumbVal;                     // current scroll value
    
    XLONG Granularity;                  // smallest possible scroll delta
    XLONG LineSize;                     // current size of a "line"
    XLONG PageSize;                     // current size of a "page"
    
    BOOL Proportional;
    BOOL Enabled;
*/
    BOOL Horizontal;

public:
    CWinScroller(BOOL Horizontal);
    virtual ~CWinScroller();
    BOOL Create(wxWindow* pParent, UINT32 nID, const wxPoint& pos = wxDefaultPosition,
            const wxSize& size = wxDefaultSize);

public:
    virtual BOOL IsHorizontal() { return Horizontal; };
/*
    void GetScrollPos(XLONG* pxl) const;
    static INT32 GetScrollerSize() {return ScrollerSize;};
    void SetGranularity(const XLONG& unit);

    void SetScrollPos(const XLONG& n, BOOL redraw = TRUE);
    void SetScrollRange(const XLONG& lo, const XLONG& hi, BOOL redraw = TRUE);
    
    void SetLineSize(const XLONG& sz);
    void SetPageSize(const XLONG& sz);
    
    void LineUp();
    void LineDown();
    void PageUp();
    void PageDown();
    
    void ShowScroller(BOOL show = TRUE);
    static BOOL HasScrollerSizeChanged();   // UIC

    void SetProportional(BOOL bProp);
    virtual void CalcPosFromParentClient(LPRECT lpRect);
    void HandleScrollMessage(UINT32 nSBCode, UINT32 nPos);

private:
    void SnapToGrain(XLONG* pxl) const;
    void ClipThumbPos(const XLONG& n);
    void MoveThumb(BOOL redraw);
*/
};


#endif      // SCROLLER__INC

---