File: csbdrlay.h

package info (click to toggle)
crystalspace 0.94-20020412-3
  • links: PTS
  • area: main
  • in suites: woody
  • size: 62,276 kB
  • ctags: 52,843
  • sloc: cpp: 274,783; ansic: 6,608; perl: 6,276; objc: 3,952; asm: 2,942; python: 2,354; php: 542; pascal: 530; sh: 430; makefile: 370; awk: 193
file content (172 lines) | stat: -rw-r--r-- 5,022 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/*
    Copyright (C) Aleksandras Gluchovas
    CS port by Norman Krmer <norman@users.sourceforge.net>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __BORDERLAYOUT_G__
#define __BORDERLAYOUT_G__

#include "cslayout.h"

/**
 * Displays upto 5 components. They are located in the north, south,
 * west, east and center of the canvas.
 *
 * Sample:
 * <p>
 * <code>
 * csWindow *wnd = new csWindow (theApp, "BorderLayout",
 *                               CSWS_DEFAULTVALUE & ~CSWS_MENUBAR);
 * wnd->SetSize (400, 300);
 * wnd->Center ();
 * wnd->Select ();
 *
 * csBorderLayout *border = new csFlowLayout (wnd);
 * wnd->SendCommand (cscmdWindowSetClient, (void*)border);
 *
 * csBorderConstraint *blc[5] = {csBorderLayout::CENTER,
 *				 csBorderLayout::EAST,
 *				 csBorderLayout::NORTH,
 *				 csBorderLayout::WEST,
 *				 csBorderLayout::SOUTH};
 * for (int k=0; k<5; k++)
 * {
 *   border->c = *blc[k];
 *   csButton *b= new csButton (border, 7000+k);
 *   b->SetPos ((9+k)*10, 20);
 *   b->SetSuggestedSize (0, 0);
 *   char text[20];
 *   sprintf (text, "Test %d", k);
 *   b->SetText (text);
 * }
 * </code>
 * </p>
 */

/**
 * This subclass of csLayoutConstraint additionally stores the location
 * of the attached control.
 */

class csBorderConstraint : public csLayoutConstraint
{
 public:
  int mAlign;
 public:
  /**
   * use the following values for aligning
   * 0 ... center
   * 1 ... left
   * 2 ... top
   * 3 ... bottom
   * 4 ... right
   */
  csBorderConstraint (int align): mAlign( align ) {}
  /// copy constructor
  csBorderConstraint (const csBorderConstraint &c) :
    csLayoutConstraint (c.comp)
    { mAlign = c.mAlign; }
  virtual csLayoutConstraint *Clone ();
};

class csBorderLayout : public csLayout2
{
 public:
  csBorderLayout (csComponent *pParent);
  /**
   * Make sure there is at least a horizontal gap of hgap pixels
   * and a vertical gap of vgap pixels.
   */
  csBorderLayout (csComponent *pParent, int hgap, int vgap);

  ~csBorderLayout();

  /**
   * A components is added to a layout by creating it and passing
   * the layout component as its parent component.
   * If you insist of doing some voodoo you should use AddLayoutComponent
   * to add it to the layout.
   * <pre>
   * IN:  the component to add
   * OUT: the constraint that is used to layout the component
   *      (a copy of variable c  see above)
   * </pre>
   */
  virtual csLayoutConstraint *AddLayoutComponent (csComponent* comp);
  /// remove a component from the layout
  virtual void RemoveLayoutComponent (csComponent* comp);

  virtual void SuggestSize (int &w, int &h);

  /// recalc positions and sizes of components
  virtual void LayoutContainer ();

  virtual void MaximumLayoutSize (int &w, int &h);
  virtual float GetLayoutAlignmentX ();
  virtual float GetLayoutAlignmentY ();

 public:

  csBorderConstraint c;

  /// for your convenience here are prebuild constraints
  CS_DECLARE_STATIC_CLASSVAR (CENTER, GetCenter, csBorderConstraint)
  CS_DECLARE_STATIC_CLASSVAR (EAST, GetEast, csBorderConstraint)
  CS_DECLARE_STATIC_CLASSVAR (NORTH, GetNorth, csBorderConstraint)
  CS_DECLARE_STATIC_CLASSVAR (SOUTH, GetSouth, csBorderConstraint)
  CS_DECLARE_STATIC_CLASSVAR (WEST, GetWest, csBorderConstraint)
  CS_DECLARE_STATIC_CLASSVAR (AFTER_LAST_LINE, GetAfterLastLine, csBorderConstraint)
  CS_DECLARE_STATIC_CLASSVAR (AFTER_LINE_ENDS, GetAfterLineEnds, csBorderConstraint)
  CS_DECLARE_STATIC_CLASSVAR (BEFORE_FIRST_LINE, GetBeforeFirstLine, csBorderConstraint)
  CS_DECLARE_STATIC_CLASSVAR (BEFORE_LINE_BEGINS, GetBeforeLineBegins, csBorderConstraint)

 protected:

  enum ALIGNMENT_ENUM_INTERNAL
  {
    _CENTER = 0,
    _EAST   = 1,
    _NORTH  = 2,
    _SOUTH  = 3,
    _WEST   = 4,

    // for Western, top-to-bottom, left-to-right orientations

    _AFTER_LAST_LINE    = _SOUTH,
    _AFTER_LINE_ENDS    = _EAST,
    _BEFORE_FIRST_LINE  = _NORTH,
    _BEFORE_LINE_BEGINS = _WEST
  };

 protected:
  void DistributeSizes( int& left, int& center,
			int& right, int totalWidth, int gap,
			bool hasLeft, bool hasCenter, bool hasRight );

  int GetWidthSum( int left, int center, int right, int gap,
		   bool hasLeft, bool hasCenter, bool hasRight );

  int Hgap (csComponent* pComp);
  int Vgap (csComponent* pComp);

 protected:
  int mHgap;
  int mVgap;

};

#endif // __BORDERLAYOUT_G__